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/MCWin64EH.h"
23 #include "llvm/Support/DataTypes.h"
39 class formatted_raw_ostream;
41 typedef std::pair<const MCSection *, const MCExpr *> MCSectionSubPair;
43 /// Target specific streamer interface. This is used so that targets can
44 /// implement support for target specific assembly directives.
46 /// If target foo wants to use this, it should implement 3 classes:
47 /// * FooTargetStreamer : public MCTargetStreamer
48 /// * FooTargetAsmSreamer : public FooTargetStreamer
49 /// * FooTargetELFStreamer : public FooTargetStreamer
51 /// FooTargetStreamer should have a pure virtual method for each directive. For
52 /// example, for a ".bar symbol_name" directive, it should have
53 /// virtual emitBar(const MCSymbol &Symbol) = 0;
55 /// The FooTargetAsmSreamer and FooTargetELFStreamer classes implement the
56 /// method. The assembly streamer just prints ".bar symbol_name". The object
57 /// streamer does whatever is needed to implement .bar in the object file.
59 /// In the assembly printer and parser the target streamer can be used by
60 /// calling getTargetStreamer and casting it to FooTargetStreamer:
62 /// MCTargetStreamer &TS = OutStreamer.getTargetStreamer();
63 /// FooTargetStreamer &ATS = static_cast<FooTargetStreamer &>(TS);
65 /// The base classes FooTargetAsmSreamer and FooTargetELFStreamer should *never*
66 /// be treated differently. Callers should always talk to a FooTargetStreamer.
67 class MCTargetStreamer {
72 virtual ~MCTargetStreamer();
73 void setStreamer(MCStreamer *S) { Streamer = S; }
75 // Allow a target to add behavior to the EmitLabel of MCStreamer.
76 virtual void emitLabel(MCSymbol *Symbol);
79 // FIXME: declared here because it is used from
80 // lib/CodeGen/AsmPrinter/ARMException.cpp.
81 class ARMTargetStreamer : public MCTargetStreamer {
82 virtual void anchor();
84 virtual void emitFnStart() = 0;
85 virtual void emitFnEnd() = 0;
86 virtual void emitCantUnwind() = 0;
87 virtual void emitPersonality(const MCSymbol *Personality) = 0;
88 virtual void emitHandlerData() = 0;
89 virtual void emitSetFP(unsigned FpReg, unsigned SpReg,
90 int64_t Offset = 0) = 0;
91 virtual void emitPad(int64_t Offset) = 0;
92 virtual void emitRegSave(const SmallVectorImpl<unsigned> &RegList,
95 virtual void switchVendor(StringRef Vendor) = 0;
96 virtual void emitAttribute(unsigned Attribute, unsigned Value) = 0;
97 virtual void emitTextAttribute(unsigned Attribute, StringRef String) = 0;
98 virtual void emitIntTextAttribute(unsigned Attribute, unsigned IntValue,
99 StringRef StringValue = "") = 0;
100 virtual void emitFPU(unsigned FPU) = 0;
101 virtual void emitArch(unsigned Arch) = 0;
102 virtual void finishAttributeSection() = 0;
103 virtual void emitInst(uint32_t Inst, char Suffix = '\0') = 0;
106 /// MCStreamer - Streaming machine code generation interface. This interface
107 /// is intended to provide a programatic interface that is very similar to the
108 /// level that an assembler .s file provides. It has callbacks to emit bytes,
109 /// handle directives, etc. The implementation of this interface retains
110 /// state to know what the current section is etc.
112 /// There are multiple implementations of this interface: one for writing out
113 /// a .s file, and implementations that write out .o files of various formats.
117 OwningPtr<MCTargetStreamer> TargetStreamer;
119 MCStreamer(const MCStreamer &) LLVM_DELETED_FUNCTION;
120 MCStreamer &operator=(const MCStreamer &) LLVM_DELETED_FUNCTION;
125 std::vector<MCDwarfFrameInfo> FrameInfos;
126 MCDwarfFrameInfo *getCurrentFrameInfo();
127 MCSymbol *EmitCFICommon();
128 void EnsureValidFrame();
130 std::vector<MCWin64EHUnwindInfo *> W64UnwindInfos;
131 MCWin64EHUnwindInfo *CurrentW64UnwindInfo;
132 void setCurrentW64UnwindInfo(MCWin64EHUnwindInfo *Frame);
133 void EnsureValidW64UnwindInfo();
135 MCSymbol *LastSymbol;
137 // SymbolOrdering - Tracks an index to represent the order
138 // a symbol was emitted in. Zero means we did not emit that symbol.
139 DenseMap<const MCSymbol *, unsigned> SymbolOrdering;
141 /// SectionStack - This is stack of current and previous section
142 /// values saved by PushSection.
143 SmallVector<std::pair<MCSectionSubPair, MCSectionSubPair>, 4> SectionStack;
145 bool AutoInitSections;
148 MCStreamer(MCContext &Ctx, MCTargetStreamer *TargetStreamer);
150 const MCExpr *BuildSymbolDiff(MCContext &Context, const MCSymbol *A,
153 const MCExpr *ForceExpAbs(const MCExpr *Expr);
155 void RecordProcStart(MCDwarfFrameInfo &Frame);
156 virtual void EmitCFIStartProcImpl(MCDwarfFrameInfo &Frame);
157 void RecordProcEnd(MCDwarfFrameInfo &Frame);
158 virtual void EmitCFIEndProcImpl(MCDwarfFrameInfo &CurFrame);
159 void EmitFrames(MCAsmBackend *MAB, bool usingCFI);
161 MCWin64EHUnwindInfo *getCurrentW64UnwindInfo() {
162 return CurrentW64UnwindInfo;
164 void EmitW64Tables();
166 virtual void EmitRawTextImpl(StringRef String);
169 virtual ~MCStreamer();
173 virtual void reset();
175 MCContext &getContext() const { return Context; }
177 MCTargetStreamer *getTargetStreamer() {
178 return TargetStreamer.get();
181 unsigned getNumFrameInfos() { return FrameInfos.size(); }
183 const MCDwarfFrameInfo &getFrameInfo(unsigned i) { return FrameInfos[i]; }
185 ArrayRef<MCDwarfFrameInfo> getFrameInfos() const { return FrameInfos; }
187 unsigned getNumW64UnwindInfos() { return W64UnwindInfos.size(); }
189 MCWin64EHUnwindInfo &getW64UnwindInfo(unsigned i) {
190 return *W64UnwindInfos[i];
193 void generateCompactUnwindEncodings(MCAsmBackend *MAB);
195 /// @name Assembly File Formatting.
198 /// isVerboseAsm - Return true if this streamer supports verbose assembly
199 /// and if it is enabled.
200 virtual bool isVerboseAsm() const { return false; }
202 /// hasRawTextSupport - Return true if this asm streamer supports emitting
203 /// unformatted text to the .s file with EmitRawText.
204 virtual bool hasRawTextSupport() const { return false; }
206 /// AddComment - Add a comment that can be emitted to the generated .s
207 /// file if applicable as a QoI issue to make the output of the compiler
208 /// more readable. This only affects the MCAsmStreamer, and only when
209 /// verbose assembly output is enabled.
211 /// If the comment includes embedded \n's, they will each get the comment
212 /// prefix as appropriate. The added comment should not end with a \n.
213 virtual void AddComment(const Twine &T) {}
215 /// GetCommentOS - Return a raw_ostream that comments can be written to.
216 /// Unlike AddComment, you are required to terminate comments with \n if you
218 virtual raw_ostream &GetCommentOS();
220 /// AddBlankLine - Emit a blank line to a .s file to pretty it up.
221 virtual void AddBlankLine() {}
225 /// @name Symbol & Section Management
228 /// getCurrentSection - Return the current section that the streamer is
229 /// emitting code to.
230 MCSectionSubPair getCurrentSection() const {
231 if (!SectionStack.empty())
232 return SectionStack.back().first;
233 return MCSectionSubPair();
236 /// getPreviousSection - Return the previous section that the streamer is
237 /// emitting code to.
238 MCSectionSubPair getPreviousSection() const {
239 if (!SectionStack.empty())
240 return SectionStack.back().second;
241 return MCSectionSubPair();
244 /// GetSymbolOrder - Returns an index to represent the order
245 /// a symbol was emitted in. (zero if we did not emit that symbol)
246 unsigned GetSymbolOrder(const MCSymbol *Sym) const {
247 return SymbolOrdering.lookup(Sym);
250 /// ChangeSection - Update streamer for a new active section.
252 /// This is called by PopSection and SwitchSection, if the current
254 virtual void ChangeSection(const MCSection *, const MCExpr *) = 0;
256 /// pushSection - Save the current and previous section on the
259 SectionStack.push_back(
260 std::make_pair(getCurrentSection(), getPreviousSection()));
263 /// popSection - Restore the current and previous section from
264 /// the section stack. Calls ChangeSection as needed.
266 /// Returns false if the stack was empty.
268 if (SectionStack.size() <= 1)
270 MCSectionSubPair oldSection = SectionStack.pop_back_val().first;
271 MCSectionSubPair curSection = SectionStack.back().first;
273 if (oldSection != curSection)
274 ChangeSection(curSection.first, curSection.second);
278 bool SubSection(const MCExpr *Subsection) {
279 if (SectionStack.empty())
282 SwitchSection(SectionStack.back().first.first, Subsection);
286 /// SwitchSection - Set the current section where code is being emitted to
287 /// @p Section. This is required to update CurSection.
289 /// This corresponds to assembler directives like .section, .text, etc.
290 void SwitchSection(const MCSection *Section, const MCExpr *Subsection = 0) {
291 assert(Section && "Cannot switch to a null section!");
292 MCSectionSubPair curSection = SectionStack.back().first;
293 SectionStack.back().second = curSection;
294 if (MCSectionSubPair(Section, Subsection) != curSection) {
295 SectionStack.back().first = MCSectionSubPair(Section, Subsection);
296 ChangeSection(Section, Subsection);
300 /// SwitchSectionNoChange - Set the current section where code is being
301 /// emitted to @p Section. This is required to update CurSection. This
302 /// version does not call ChangeSection.
303 void SwitchSectionNoChange(const MCSection *Section,
304 const MCExpr *Subsection = 0) {
305 assert(Section && "Cannot switch to a null section!");
306 MCSectionSubPair curSection = SectionStack.back().first;
307 SectionStack.back().second = curSection;
308 if (MCSectionSubPair(Section, Subsection) != curSection)
309 SectionStack.back().first = MCSectionSubPair(Section, Subsection);
312 /// Initialize the streamer.
313 void InitStreamer() {
314 if (AutoInitSections)
318 /// Tell this MCStreamer to call InitSections upon initialization.
319 void setAutoInitSections(bool AutoInitSections) {
320 this->AutoInitSections = AutoInitSections;
323 /// InitSections - Create the default sections and set the initial one.
324 virtual void InitSections() = 0;
326 /// InitToTextSection - Create a text section and switch the streamer to it.
327 virtual void InitToTextSection() = 0;
329 /// AssignSection - Sets the symbol's section.
331 /// Each emitted symbol will be tracked in the ordering table,
332 /// so we can sort on them later.
333 void AssignSection(MCSymbol *Symbol, const MCSection *Section);
335 /// EmitLabel - Emit a label for @p Symbol into the current section.
337 /// This corresponds to an assembler statement such as:
340 /// @param Symbol - The symbol to emit. A given symbol should only be
341 /// emitted as a label once, and symbols emitted as a label should never be
342 /// used in an assignment.
343 // FIXME: These emission are non-const because we mutate the symbol to
344 // add the section we're emitting it to later.
345 virtual void EmitLabel(MCSymbol *Symbol);
347 virtual void EmitDebugLabel(MCSymbol *Symbol);
349 virtual void EmitEHSymAttributes(const MCSymbol *Symbol, MCSymbol *EHSymbol);
351 /// EmitAssemblerFlag - Note in the output the specified @p Flag.
352 virtual void EmitAssemblerFlag(MCAssemblerFlag Flag) = 0;
354 /// EmitLinkerOptions - Emit the given list @p Options of strings as linker
355 /// options into the output.
356 virtual void EmitLinkerOptions(ArrayRef<std::string> Kind) {}
358 /// EmitDataRegion - Note in the output the specified region @p Kind.
359 virtual void EmitDataRegion(MCDataRegionType Kind) {}
361 /// EmitThumbFunc - Note in the output that the specified @p Func is
362 /// a Thumb mode function (ARM target only).
363 virtual void EmitThumbFunc(MCSymbol *Func) = 0;
365 /// getOrCreateSymbolData - Get symbol data for given symbol.
366 virtual MCSymbolData &getOrCreateSymbolData(MCSymbol *Symbol);
368 /// EmitAssignment - Emit an assignment of @p Value to @p Symbol.
370 /// This corresponds to an assembler statement such as:
373 /// The assignment generates no code, but has the side effect of binding the
374 /// value in the current context. For the assembly streamer, this prints the
375 /// binding into the .s file.
377 /// @param Symbol - The symbol being assigned to.
378 /// @param Value - The value for the symbol.
379 virtual void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) = 0;
381 /// EmitWeakReference - Emit an weak reference from @p Alias to @p Symbol.
383 /// This corresponds to an assembler statement such as:
384 /// .weakref alias, symbol
386 /// @param Alias - The alias that is being created.
387 /// @param Symbol - The symbol being aliased.
388 virtual void EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol) = 0;
390 /// EmitSymbolAttribute - Add the given @p Attribute to @p Symbol.
391 virtual bool EmitSymbolAttribute(MCSymbol *Symbol,
392 MCSymbolAttr Attribute) = 0;
394 /// EmitSymbolDesc - Set the @p DescValue for the @p Symbol.
396 /// @param Symbol - The symbol to have its n_desc field set.
397 /// @param DescValue - The value to set into the n_desc field.
398 virtual void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) = 0;
400 /// BeginCOFFSymbolDef - Start emitting COFF symbol definition
402 /// @param Symbol - The symbol to have its External & Type fields set.
403 virtual void BeginCOFFSymbolDef(const MCSymbol *Symbol) = 0;
405 /// EmitCOFFSymbolStorageClass - Emit the storage class of the symbol.
407 /// @param StorageClass - The storage class the symbol should have.
408 virtual void EmitCOFFSymbolStorageClass(int StorageClass) = 0;
410 /// EmitCOFFSymbolType - Emit the type of the symbol.
412 /// @param Type - A COFF type identifier (see COFF::SymbolType in X86COFF.h)
413 virtual void EmitCOFFSymbolType(int Type) = 0;
415 /// EndCOFFSymbolDef - Marks the end of the symbol definition.
416 virtual void EndCOFFSymbolDef() = 0;
418 /// EmitCOFFSectionIndex - Emits a COFF section index.
420 /// @param Symbol - Symbol the section number relocation should point to.
421 virtual void EmitCOFFSectionIndex(MCSymbol const *Symbol);
423 /// EmitCOFFSecRel32 - Emits a COFF section relative relocation.
425 /// @param Symbol - Symbol the section relative relocation should point to.
426 virtual void EmitCOFFSecRel32(MCSymbol const *Symbol);
428 /// EmitELFSize - Emit an ELF .size directive.
430 /// This corresponds to an assembler statement such as:
431 /// .size symbol, expression
433 virtual void EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) = 0;
435 /// EmitCommonSymbol - Emit a common symbol.
437 /// @param Symbol - The common symbol to emit.
438 /// @param Size - The size of the common symbol.
439 /// @param ByteAlignment - The alignment of the symbol if
440 /// non-zero. This must be a power of 2.
441 virtual void EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
442 unsigned ByteAlignment) = 0;
444 /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
446 /// @param Symbol - The common symbol to emit.
447 /// @param Size - The size of the common symbol.
448 /// @param ByteAlignment - The alignment of the common symbol in bytes.
449 virtual void EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size,
450 unsigned ByteAlignment) = 0;
452 /// EmitZerofill - Emit the zerofill section and an optional symbol.
454 /// @param Section - The zerofill section to create and or to put the symbol
455 /// @param Symbol - The zerofill symbol to emit, if non-NULL.
456 /// @param Size - The size of the zerofill symbol.
457 /// @param ByteAlignment - The alignment of the zerofill symbol if
458 /// non-zero. This must be a power of 2 on some targets.
459 virtual void EmitZerofill(const MCSection *Section, MCSymbol *Symbol = 0,
460 uint64_t Size = 0, unsigned ByteAlignment = 0) = 0;
462 /// EmitTBSSSymbol - Emit a thread local bss (.tbss) symbol.
464 /// @param Section - The thread local common section.
465 /// @param Symbol - The thread local common symbol to emit.
466 /// @param Size - The size of the symbol.
467 /// @param ByteAlignment - The alignment of the thread local common symbol
468 /// if non-zero. This must be a power of 2 on some targets.
469 virtual void EmitTBSSSymbol(const MCSection *Section, MCSymbol *Symbol,
470 uint64_t Size, unsigned ByteAlignment = 0) = 0;
473 /// @name Generating Data
476 /// EmitBytes - Emit the bytes in \p Data into the output.
478 /// This is used to implement assembler directives such as .byte, .ascii,
480 virtual void EmitBytes(StringRef Data) = 0;
482 /// EmitValue - Emit the expression @p Value into the output as a native
483 /// integer of the given @p Size bytes.
485 /// This is used to implement assembler directives such as .word, .quad,
488 /// @param Value - The value to emit.
489 /// @param Size - The size of the integer (in bytes) to emit. This must
490 /// match a native machine width.
491 virtual void EmitValueImpl(const MCExpr *Value, unsigned Size) = 0;
493 void EmitValue(const MCExpr *Value, unsigned Size);
495 /// EmitIntValue - Special case of EmitValue that avoids the client having
496 /// to pass in a MCExpr for constant integers.
497 virtual void EmitIntValue(uint64_t Value, unsigned Size);
499 /// EmitAbsValue - Emit the Value, but try to avoid relocations. On MachO
500 /// this is done by producing
503 void EmitAbsValue(const MCExpr *Value, unsigned Size);
505 virtual void EmitULEB128Value(const MCExpr *Value) = 0;
507 virtual void EmitSLEB128Value(const MCExpr *Value) = 0;
509 /// EmitULEB128Value - Special case of EmitULEB128Value that avoids the
510 /// client having to pass in a MCExpr for constant integers.
511 void EmitULEB128IntValue(uint64_t Value, unsigned Padding = 0);
513 /// EmitSLEB128Value - Special case of EmitSLEB128Value that avoids the
514 /// client having to pass in a MCExpr for constant integers.
515 void EmitSLEB128IntValue(int64_t Value);
517 /// EmitSymbolValue - Special case of EmitValue that avoids the client
518 /// having to pass in a MCExpr for MCSymbols.
519 void EmitSymbolValue(const MCSymbol *Sym, unsigned Size);
521 /// EmitGPRel64Value - Emit the expression @p Value into the output as a
522 /// gprel64 (64-bit GP relative) value.
524 /// This is used to implement assembler directives such as .gpdword on
525 /// targets that support them.
526 virtual void EmitGPRel64Value(const MCExpr *Value);
528 /// EmitGPRel32Value - Emit the expression @p Value into the output as a
529 /// gprel32 (32-bit GP relative) value.
531 /// This is used to implement assembler directives such as .gprel32 on
532 /// targets that support them.
533 virtual void EmitGPRel32Value(const MCExpr *Value);
535 /// EmitFill - Emit NumBytes bytes worth of the value specified by
536 /// FillValue. This implements directives such as '.space'.
537 virtual void EmitFill(uint64_t NumBytes, uint8_t FillValue);
539 /// \brief Emit NumBytes worth of zeros.
540 /// This function properly handles data in virtual sections.
541 virtual void EmitZeros(uint64_t NumBytes);
543 /// EmitValueToAlignment - Emit some number of copies of @p Value until
544 /// the byte alignment @p ByteAlignment is reached.
546 /// If the number of bytes need to emit for the alignment is not a multiple
547 /// of @p ValueSize, then the contents of the emitted fill bytes is
550 /// This used to implement the .align assembler directive.
552 /// @param ByteAlignment - The alignment to reach. This must be a power of
553 /// two on some targets.
554 /// @param Value - The value to use when filling bytes.
555 /// @param ValueSize - The size of the integer (in bytes) to emit for
556 /// @p Value. This must match a native machine width.
557 /// @param MaxBytesToEmit - The maximum numbers of bytes to emit, or 0. If
558 /// the alignment cannot be reached in this many bytes, no bytes are
560 virtual void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
561 unsigned ValueSize = 1,
562 unsigned MaxBytesToEmit = 0) = 0;
564 /// EmitCodeAlignment - Emit nops until the byte alignment @p ByteAlignment
567 /// This used to align code where the alignment bytes may be executed. This
568 /// can emit different bytes for different sizes to optimize execution.
570 /// @param ByteAlignment - The alignment to reach. This must be a power of
571 /// two on some targets.
572 /// @param MaxBytesToEmit - The maximum numbers of bytes to emit, or 0. If
573 /// the alignment cannot be reached in this many bytes, no bytes are
575 virtual void EmitCodeAlignment(unsigned ByteAlignment,
576 unsigned MaxBytesToEmit = 0) = 0;
578 /// EmitValueToOffset - Emit some number of copies of @p Value until the
579 /// byte offset @p Offset is reached.
581 /// This is used to implement assembler directives such as .org.
583 /// @param Offset - The offset to reach. This may be an expression, but the
584 /// expression must be associated with the current section.
585 /// @param Value - The value to use when filling bytes.
586 /// @return false on success, true if the offset was invalid.
587 virtual bool EmitValueToOffset(const MCExpr *Offset,
588 unsigned char Value = 0) = 0;
592 /// EmitFileDirective - Switch to a new logical file. This is used to
593 /// implement the '.file "foo.c"' assembler directive.
594 virtual void EmitFileDirective(StringRef Filename) = 0;
596 /// Emit the "identifiers" directive. This implements the
597 /// '.ident "version foo"' assembler directive.
598 virtual void EmitIdent(StringRef IdentString) {}
600 /// EmitDwarfFileDirective - Associate a filename with a specified logical
601 /// file number. This implements the DWARF2 '.file 4 "foo.c"' assembler
603 virtual bool EmitDwarfFileDirective(unsigned FileNo, StringRef Directory,
604 StringRef Filename, unsigned CUID = 0);
606 /// EmitDwarfLocDirective - This implements the DWARF2
607 // '.loc fileno lineno ...' assembler directive.
608 virtual void EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
609 unsigned Column, unsigned Flags,
610 unsigned Isa, unsigned Discriminator,
613 virtual void EmitDwarfAdvanceLineAddr(int64_t LineDelta,
614 const MCSymbol *LastLabel,
615 const MCSymbol *Label,
616 unsigned PointerSize) = 0;
618 virtual void EmitDwarfAdvanceFrameAddr(const MCSymbol *LastLabel,
619 const MCSymbol *Label) {}
621 void EmitDwarfSetLineAddr(int64_t LineDelta, const MCSymbol *Label,
624 virtual void EmitCompactUnwindEncoding(uint32_t CompactUnwindEncoding);
625 virtual void EmitCFISections(bool EH, bool Debug);
626 void EmitCFIStartProc();
627 void EmitCFIEndProc();
628 virtual void EmitCFIDefCfa(int64_t Register, int64_t Offset);
629 virtual void EmitCFIDefCfaOffset(int64_t Offset);
630 virtual void EmitCFIDefCfaRegister(int64_t Register);
631 virtual void EmitCFIOffset(int64_t Register, int64_t Offset);
632 virtual void EmitCFIPersonality(const MCSymbol *Sym, unsigned Encoding);
633 virtual void EmitCFILsda(const MCSymbol *Sym, unsigned Encoding);
634 virtual void EmitCFIRememberState();
635 virtual void EmitCFIRestoreState();
636 virtual void EmitCFISameValue(int64_t Register);
637 virtual void EmitCFIRestore(int64_t Register);
638 virtual void EmitCFIRelOffset(int64_t Register, int64_t Offset);
639 virtual void EmitCFIAdjustCfaOffset(int64_t Adjustment);
640 virtual void EmitCFIEscape(StringRef Values);
641 virtual void EmitCFISignalFrame();
642 virtual void EmitCFIUndefined(int64_t Register);
643 virtual void EmitCFIRegister(int64_t Register1, int64_t Register2);
644 virtual void EmitCFIWindowSave();
646 virtual void EmitWin64EHStartProc(const MCSymbol *Symbol);
647 virtual void EmitWin64EHEndProc();
648 virtual void EmitWin64EHStartChained();
649 virtual void EmitWin64EHEndChained();
650 virtual void EmitWin64EHHandler(const MCSymbol *Sym, bool Unwind,
652 virtual void EmitWin64EHHandlerData();
653 virtual void EmitWin64EHPushReg(unsigned Register);
654 virtual void EmitWin64EHSetFrame(unsigned Register, unsigned Offset);
655 virtual void EmitWin64EHAllocStack(unsigned Size);
656 virtual void EmitWin64EHSaveReg(unsigned Register, unsigned Offset);
657 virtual void EmitWin64EHSaveXMM(unsigned Register, unsigned Offset);
658 virtual void EmitWin64EHPushFrame(bool Code);
659 virtual void EmitWin64EHEndProlog();
661 /// EmitInstruction - Emit the given @p Instruction into the current
663 virtual void EmitInstruction(const MCInst &Inst) = 0;
665 /// \brief Set the bundle alignment mode from now on in the section.
666 /// The argument is the power of 2 to which the alignment is set. The
667 /// value 0 means turn the bundle alignment off.
668 virtual void EmitBundleAlignMode(unsigned AlignPow2) = 0;
670 /// \brief The following instructions are a bundle-locked group.
672 /// \param AlignToEnd - If true, the bundle-locked group will be aligned to
673 /// the end of a bundle.
674 virtual void EmitBundleLock(bool AlignToEnd) = 0;
676 /// \brief Ends a bundle-locked group.
677 virtual void EmitBundleUnlock() = 0;
679 /// EmitRawText - If this file is backed by a assembly streamer, this dumps
680 /// the specified string in the output .s file. This capability is
681 /// indicated by the hasRawTextSupport() predicate. By default this aborts.
682 void EmitRawText(const Twine &String);
684 /// Flush - Causes any cached state to be written out.
685 virtual void Flush() {}
687 /// FinishImpl - Streamer specific finalization.
688 virtual void FinishImpl() = 0;
689 /// Finish - Finish emission of machine code.
693 /// createNullStreamer - Create a dummy machine code streamer, which does
694 /// nothing. This is useful for timing the assembler front end.
695 MCStreamer *createNullStreamer(MCContext &Ctx);
697 /// createAsmStreamer - Create a machine code streamer which will print out
698 /// assembly for the native target, suitable for compiling with a native
701 /// \param InstPrint - If given, the instruction printer to use. If not given
702 /// the MCInst representation will be printed. This method takes ownership of
705 /// \param CE - If given, a code emitter to use to show the instruction
706 /// encoding inline with the assembly. This method takes ownership of \p CE.
708 /// \param TAB - If given, a target asm backend to use to show the fixup
709 /// information in conjunction with encoding information. This method takes
710 /// ownership of \p TAB.
712 /// \param ShowInst - Whether to show the MCInst representation inline with
714 MCStreamer *createAsmStreamer(MCContext &Ctx, MCTargetStreamer *TargetStreamer,
715 formatted_raw_ostream &OS, bool isVerboseAsm,
716 bool useLoc, bool useCFI, bool useDwarfDirectory,
717 MCInstPrinter *InstPrint = 0,
718 MCCodeEmitter *CE = 0, MCAsmBackend *TAB = 0,
719 bool ShowInst = false);
721 /// createMachOStreamer - Create a machine code streamer which will generate
722 /// Mach-O format object files.
724 /// Takes ownership of \p TAB and \p CE.
725 MCStreamer *createMachOStreamer(MCContext &Ctx, MCAsmBackend &TAB,
726 raw_ostream &OS, MCCodeEmitter *CE,
727 bool RelaxAll = false);
729 /// createWinCOFFStreamer - Create a machine code streamer which will
730 /// generate Microsoft COFF format object files.
732 /// Takes ownership of \p TAB and \p CE.
733 MCStreamer *createWinCOFFStreamer(MCContext &Ctx, MCAsmBackend &TAB,
734 MCCodeEmitter &CE, raw_ostream &OS,
735 bool RelaxAll = false);
737 /// createELFStreamer - Create a machine code streamer which will generate
738 /// ELF format object files.
739 MCStreamer *createELFStreamer(MCContext &Ctx, MCTargetStreamer *TargetStreamer,
740 MCAsmBackend &TAB, raw_ostream &OS,
741 MCCodeEmitter *CE, bool RelaxAll,
744 /// createPureStreamer - Create a machine code streamer which will generate
745 /// "pure" MC object files, for use with MC-JIT and testing tools.
747 /// Takes ownership of \p TAB and \p CE.
748 MCStreamer *createPureStreamer(MCContext &Ctx, MCAsmBackend &TAB,
749 raw_ostream &OS, MCCodeEmitter *CE);
751 } // end namespace llvm