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; }
76 // FIXME: declared here because it is used from
77 // lib/CodeGen/AsmPrinter/ARMException.cpp.
78 class ARMTargetStreamer : public MCTargetStreamer {
80 virtual void emitFnStart() = 0;
81 virtual void emitFnEnd() = 0;
82 virtual void emitCantUnwind() = 0;
83 virtual void emitPersonality(const MCSymbol *Personality) = 0;
84 virtual void emitHandlerData() = 0;
85 virtual void emitSetFP(unsigned FpReg, unsigned SpReg,
86 int64_t Offset = 0) = 0;
87 virtual void emitPad(int64_t Offset) = 0;
88 virtual void emitRegSave(const SmallVectorImpl<unsigned> &RegList,
92 /// MCStreamer - Streaming machine code generation interface. This interface
93 /// is intended to provide a programatic interface that is very similar to the
94 /// level that an assembler .s file provides. It has callbacks to emit bytes,
95 /// handle directives, etc. The implementation of this interface retains
96 /// state to know what the current section is etc.
98 /// There are multiple implementations of this interface: one for writing out
99 /// a .s file, and implementations that write out .o files of various formats.
103 OwningPtr<MCTargetStreamer> TargetStreamer;
105 MCStreamer(const MCStreamer &) LLVM_DELETED_FUNCTION;
106 MCStreamer &operator=(const MCStreamer &) LLVM_DELETED_FUNCTION;
111 std::vector<MCDwarfFrameInfo> FrameInfos;
112 MCDwarfFrameInfo *getCurrentFrameInfo();
113 MCSymbol *EmitCFICommon();
114 void EnsureValidFrame();
116 std::vector<MCWin64EHUnwindInfo *> W64UnwindInfos;
117 MCWin64EHUnwindInfo *CurrentW64UnwindInfo;
118 void setCurrentW64UnwindInfo(MCWin64EHUnwindInfo *Frame);
119 void EnsureValidW64UnwindInfo();
121 MCSymbol *LastSymbol;
123 // SymbolOrdering - Tracks an index to represent the order
124 // a symbol was emitted in. Zero means we did not emit that symbol.
125 DenseMap<const MCSymbol *, unsigned> SymbolOrdering;
127 /// SectionStack - This is stack of current and previous section
128 /// values saved by PushSection.
129 SmallVector<std::pair<MCSectionSubPair, MCSectionSubPair>, 4> SectionStack;
131 bool AutoInitSections;
134 MCStreamer(MCContext &Ctx, MCTargetStreamer *TargetStreamer);
136 const MCExpr *BuildSymbolDiff(MCContext &Context, const MCSymbol *A,
139 const MCExpr *ForceExpAbs(const MCExpr *Expr);
141 void RecordProcStart(MCDwarfFrameInfo &Frame);
142 virtual void EmitCFIStartProcImpl(MCDwarfFrameInfo &Frame);
143 void RecordProcEnd(MCDwarfFrameInfo &Frame);
144 virtual void EmitCFIEndProcImpl(MCDwarfFrameInfo &CurFrame);
145 void EmitFrames(MCAsmBackend *MAB, bool usingCFI);
147 MCWin64EHUnwindInfo *getCurrentW64UnwindInfo() {
148 return CurrentW64UnwindInfo;
150 void EmitW64Tables();
153 virtual ~MCStreamer();
157 virtual void reset();
159 MCContext &getContext() const { return Context; }
161 MCTargetStreamer &getTargetStreamer() {
162 assert(TargetStreamer);
163 return *TargetStreamer;
166 unsigned getNumFrameInfos() { return FrameInfos.size(); }
168 const MCDwarfFrameInfo &getFrameInfo(unsigned i) { return FrameInfos[i]; }
170 ArrayRef<MCDwarfFrameInfo> getFrameInfos() const { return FrameInfos; }
172 unsigned getNumW64UnwindInfos() { return W64UnwindInfos.size(); }
174 MCWin64EHUnwindInfo &getW64UnwindInfo(unsigned i) {
175 return *W64UnwindInfos[i];
178 void generateCompactUnwindEncodings(MCAsmBackend *MAB);
180 /// @name Assembly File Formatting.
183 /// isVerboseAsm - Return true if this streamer supports verbose assembly
184 /// and if it is enabled.
185 virtual bool isVerboseAsm() const { return false; }
187 /// hasRawTextSupport - Return true if this asm streamer supports emitting
188 /// unformatted text to the .s file with EmitRawText.
189 virtual bool hasRawTextSupport() const { return false; }
191 /// AddComment - Add a comment that can be emitted to the generated .s
192 /// file if applicable as a QoI issue to make the output of the compiler
193 /// more readable. This only affects the MCAsmStreamer, and only when
194 /// verbose assembly output is enabled.
196 /// If the comment includes embedded \n's, they will each get the comment
197 /// prefix as appropriate. The added comment should not end with a \n.
198 virtual void AddComment(const Twine &T) {}
200 /// GetCommentOS - Return a raw_ostream that comments can be written to.
201 /// Unlike AddComment, you are required to terminate comments with \n if you
203 virtual raw_ostream &GetCommentOS();
205 /// AddBlankLine - Emit a blank line to a .s file to pretty it up.
206 virtual void AddBlankLine() {}
210 /// @name Symbol & Section Management
213 /// getCurrentSection - Return the current section that the streamer is
214 /// emitting code to.
215 MCSectionSubPair getCurrentSection() const {
216 if (!SectionStack.empty())
217 return SectionStack.back().first;
218 return MCSectionSubPair();
221 /// getPreviousSection - Return the previous section that the streamer is
222 /// emitting code to.
223 MCSectionSubPair getPreviousSection() const {
224 if (!SectionStack.empty())
225 return SectionStack.back().second;
226 return MCSectionSubPair();
229 /// GetSymbolOrder - Returns an index to represent the order
230 /// a symbol was emitted in. (zero if we did not emit that symbol)
231 unsigned GetSymbolOrder(const MCSymbol *Sym) const {
232 return SymbolOrdering.lookup(Sym);
235 /// ChangeSection - Update streamer for a new active section.
237 /// This is called by PopSection and SwitchSection, if the current
239 virtual void ChangeSection(const MCSection *, const MCExpr *) = 0;
241 /// pushSection - Save the current and previous section on the
244 SectionStack.push_back(
245 std::make_pair(getCurrentSection(), getPreviousSection()));
248 /// popSection - Restore the current and previous section from
249 /// the section stack. Calls ChangeSection as needed.
251 /// Returns false if the stack was empty.
253 if (SectionStack.size() <= 1)
255 MCSectionSubPair oldSection = SectionStack.pop_back_val().first;
256 MCSectionSubPair curSection = SectionStack.back().first;
258 if (oldSection != curSection)
259 ChangeSection(curSection.first, curSection.second);
263 bool SubSection(const MCExpr *Subsection) {
264 if (SectionStack.empty())
267 SwitchSection(SectionStack.back().first.first, Subsection);
271 /// SwitchSection - Set the current section where code is being emitted to
272 /// @p Section. This is required to update CurSection.
274 /// This corresponds to assembler directives like .section, .text, etc.
275 void SwitchSection(const MCSection *Section, const MCExpr *Subsection = 0) {
276 assert(Section && "Cannot switch to a null section!");
277 MCSectionSubPair curSection = SectionStack.back().first;
278 SectionStack.back().second = curSection;
279 if (MCSectionSubPair(Section, Subsection) != curSection) {
280 SectionStack.back().first = MCSectionSubPair(Section, Subsection);
281 ChangeSection(Section, Subsection);
285 /// SwitchSectionNoChange - Set the current section where code is being
286 /// emitted to @p Section. This is required to update CurSection. This
287 /// version does not call ChangeSection.
288 void SwitchSectionNoChange(const MCSection *Section,
289 const MCExpr *Subsection = 0) {
290 assert(Section && "Cannot switch to a null section!");
291 MCSectionSubPair curSection = SectionStack.back().first;
292 SectionStack.back().second = curSection;
293 if (MCSectionSubPair(Section, Subsection) != curSection)
294 SectionStack.back().first = MCSectionSubPair(Section, Subsection);
297 /// Initialize the streamer.
298 void InitStreamer() {
299 if (AutoInitSections)
303 /// Tell this MCStreamer to call InitSections upon initialization.
304 void setAutoInitSections(bool AutoInitSections) {
305 this->AutoInitSections = AutoInitSections;
308 /// InitSections - Create the default sections and set the initial one.
309 virtual void InitSections() = 0;
311 /// InitToTextSection - Create a text section and switch the streamer to it.
312 virtual void InitToTextSection() = 0;
314 /// AssignSection - Sets the symbol's section.
316 /// Each emitted symbol will be tracked in the ordering table,
317 /// so we can sort on them later.
318 void AssignSection(MCSymbol *Symbol, const MCSection *Section);
320 /// EmitLabel - Emit a label for @p Symbol into the current section.
322 /// This corresponds to an assembler statement such as:
325 /// @param Symbol - The symbol to emit. A given symbol should only be
326 /// emitted as a label once, and symbols emitted as a label should never be
327 /// used in an assignment.
328 virtual void EmitLabel(MCSymbol *Symbol);
330 virtual void EmitDebugLabel(MCSymbol *Symbol);
332 virtual void EmitEHSymAttributes(const MCSymbol *Symbol, MCSymbol *EHSymbol);
334 /// EmitAssemblerFlag - Note in the output the specified @p Flag.
335 virtual void EmitAssemblerFlag(MCAssemblerFlag Flag) = 0;
337 /// EmitLinkerOptions - Emit the given list @p Options of strings as linker
338 /// options into the output.
339 virtual void EmitLinkerOptions(ArrayRef<std::string> Kind) {}
341 /// EmitDataRegion - Note in the output the specified region @p Kind.
342 virtual void EmitDataRegion(MCDataRegionType Kind) {}
344 /// EmitThumbFunc - Note in the output that the specified @p Func is
345 /// a Thumb mode function (ARM target only).
346 virtual void EmitThumbFunc(MCSymbol *Func) = 0;
348 /// getOrCreateSymbolData - Get symbol data for given symbol.
349 virtual MCSymbolData &getOrCreateSymbolData(MCSymbol *Symbol);
351 /// EmitAssignment - Emit an assignment of @p Value to @p Symbol.
353 /// This corresponds to an assembler statement such as:
356 /// The assignment generates no code, but has the side effect of binding the
357 /// value in the current context. For the assembly streamer, this prints the
358 /// binding into the .s file.
360 /// @param Symbol - The symbol being assigned to.
361 /// @param Value - The value for the symbol.
362 virtual void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) = 0;
364 /// EmitWeakReference - Emit an weak reference from @p Alias to @p Symbol.
366 /// This corresponds to an assembler statement such as:
367 /// .weakref alias, symbol
369 /// @param Alias - The alias that is being created.
370 /// @param Symbol - The symbol being aliased.
371 virtual void EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol) = 0;
373 /// EmitSymbolAttribute - Add the given @p Attribute to @p Symbol.
374 virtual bool EmitSymbolAttribute(MCSymbol *Symbol,
375 MCSymbolAttr Attribute) = 0;
377 /// EmitSymbolDesc - Set the @p DescValue for the @p Symbol.
379 /// @param Symbol - The symbol to have its n_desc field set.
380 /// @param DescValue - The value to set into the n_desc field.
381 virtual void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) = 0;
383 /// BeginCOFFSymbolDef - Start emitting COFF symbol definition
385 /// @param Symbol - The symbol to have its External & Type fields set.
386 virtual void BeginCOFFSymbolDef(const MCSymbol *Symbol) = 0;
388 /// EmitCOFFSymbolStorageClass - Emit the storage class of the symbol.
390 /// @param StorageClass - The storage class the symbol should have.
391 virtual void EmitCOFFSymbolStorageClass(int StorageClass) = 0;
393 /// EmitCOFFSymbolType - Emit the type of the symbol.
395 /// @param Type - A COFF type identifier (see COFF::SymbolType in X86COFF.h)
396 virtual void EmitCOFFSymbolType(int Type) = 0;
398 /// EndCOFFSymbolDef - Marks the end of the symbol definition.
399 virtual void EndCOFFSymbolDef() = 0;
401 /// EmitCOFFSecRel32 - Emits a COFF section relative relocation.
403 /// @param Symbol - Symbol the section relative realocation should point to.
404 virtual void EmitCOFFSecRel32(MCSymbol const *Symbol);
406 /// EmitELFSize - Emit an ELF .size directive.
408 /// This corresponds to an assembler statement such as:
409 /// .size symbol, expression
411 virtual void EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) = 0;
413 /// EmitCommonSymbol - Emit a common symbol.
415 /// @param Symbol - The common symbol to emit.
416 /// @param Size - The size of the common symbol.
417 /// @param ByteAlignment - The alignment of the symbol if
418 /// non-zero. This must be a power of 2.
419 virtual void EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
420 unsigned ByteAlignment) = 0;
422 /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
424 /// @param Symbol - The common symbol to emit.
425 /// @param Size - The size of the common symbol.
426 /// @param ByteAlignment - The alignment of the common symbol in bytes.
427 virtual void EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size,
428 unsigned ByteAlignment) = 0;
430 /// EmitZerofill - Emit the zerofill section and an optional symbol.
432 /// @param Section - The zerofill section to create and or to put the symbol
433 /// @param Symbol - The zerofill symbol to emit, if non-NULL.
434 /// @param Size - The size of the zerofill symbol.
435 /// @param ByteAlignment - The alignment of the zerofill symbol if
436 /// non-zero. This must be a power of 2 on some targets.
437 virtual void EmitZerofill(const MCSection *Section, MCSymbol *Symbol = 0,
438 uint64_t Size = 0, unsigned ByteAlignment = 0) = 0;
440 /// EmitTBSSSymbol - Emit a thread local bss (.tbss) symbol.
442 /// @param Section - The thread local common section.
443 /// @param Symbol - The thread local common symbol to emit.
444 /// @param Size - The size of the symbol.
445 /// @param ByteAlignment - The alignment of the thread local common symbol
446 /// if non-zero. This must be a power of 2 on some targets.
447 virtual void EmitTBSSSymbol(const MCSection *Section, MCSymbol *Symbol,
448 uint64_t Size, unsigned ByteAlignment = 0) = 0;
451 /// @name Generating Data
454 /// EmitBytes - Emit the bytes in \p Data into the output.
456 /// This is used to implement assembler directives such as .byte, .ascii,
458 virtual void EmitBytes(StringRef Data) = 0;
460 /// EmitValue - Emit the expression @p Value into the output as a native
461 /// integer of the given @p Size bytes.
463 /// This is used to implement assembler directives such as .word, .quad,
466 /// @param Value - The value to emit.
467 /// @param Size - The size of the integer (in bytes) to emit. This must
468 /// match a native machine width.
469 virtual void EmitValueImpl(const MCExpr *Value, unsigned Size) = 0;
471 void EmitValue(const MCExpr *Value, unsigned Size);
473 /// EmitIntValue - Special case of EmitValue that avoids the client having
474 /// to pass in a MCExpr for constant integers.
475 virtual void EmitIntValue(uint64_t Value, unsigned Size);
477 /// EmitAbsValue - Emit the Value, but try to avoid relocations. On MachO
478 /// this is done by producing
481 void EmitAbsValue(const MCExpr *Value, unsigned Size);
483 virtual void EmitULEB128Value(const MCExpr *Value) = 0;
485 virtual void EmitSLEB128Value(const MCExpr *Value) = 0;
487 /// EmitULEB128Value - Special case of EmitULEB128Value that avoids the
488 /// client having to pass in a MCExpr for constant integers.
489 void EmitULEB128IntValue(uint64_t Value, unsigned Padding = 0);
491 /// EmitSLEB128Value - Special case of EmitSLEB128Value that avoids the
492 /// client having to pass in a MCExpr for constant integers.
493 void EmitSLEB128IntValue(int64_t Value);
495 /// EmitSymbolValue - Special case of EmitValue that avoids the client
496 /// having to pass in a MCExpr for MCSymbols.
497 void EmitSymbolValue(const MCSymbol *Sym, unsigned Size);
499 /// EmitGPRel64Value - Emit the expression @p Value into the output as a
500 /// gprel64 (64-bit GP relative) value.
502 /// This is used to implement assembler directives such as .gpdword on
503 /// targets that support them.
504 virtual void EmitGPRel64Value(const MCExpr *Value);
506 /// EmitGPRel32Value - Emit the expression @p Value into the output as a
507 /// gprel32 (32-bit GP relative) value.
509 /// This is used to implement assembler directives such as .gprel32 on
510 /// targets that support them.
511 virtual void EmitGPRel32Value(const MCExpr *Value);
513 /// EmitFill - Emit NumBytes bytes worth of the value specified by
514 /// FillValue. This implements directives such as '.space'.
515 virtual void EmitFill(uint64_t NumBytes, uint8_t FillValue);
517 /// \brief Emit NumBytes worth of zeros.
518 /// This function properly handles data in virtual sections.
519 virtual void EmitZeros(uint64_t NumBytes);
521 /// EmitValueToAlignment - Emit some number of copies of @p Value until
522 /// the byte alignment @p ByteAlignment is reached.
524 /// If the number of bytes need to emit for the alignment is not a multiple
525 /// of @p ValueSize, then the contents of the emitted fill bytes is
528 /// This used to implement the .align assembler directive.
530 /// @param ByteAlignment - The alignment to reach. This must be a power of
531 /// two on some targets.
532 /// @param Value - The value to use when filling bytes.
533 /// @param ValueSize - The size of the integer (in bytes) to emit for
534 /// @p Value. This must match a native machine width.
535 /// @param MaxBytesToEmit - The maximum numbers of bytes to emit, or 0. If
536 /// the alignment cannot be reached in this many bytes, no bytes are
538 virtual void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
539 unsigned ValueSize = 1,
540 unsigned MaxBytesToEmit = 0) = 0;
542 /// EmitCodeAlignment - Emit nops until the byte alignment @p ByteAlignment
545 /// This used to align code where the alignment bytes may be executed. This
546 /// can emit different bytes for different sizes to optimize execution.
548 /// @param ByteAlignment - The alignment to reach. This must be a power of
549 /// two on some targets.
550 /// @param MaxBytesToEmit - The maximum numbers of bytes to emit, or 0. If
551 /// the alignment cannot be reached in this many bytes, no bytes are
553 virtual void EmitCodeAlignment(unsigned ByteAlignment,
554 unsigned MaxBytesToEmit = 0) = 0;
556 /// EmitValueToOffset - Emit some number of copies of @p Value until the
557 /// byte offset @p Offset is reached.
559 /// This is used to implement assembler directives such as .org.
561 /// @param Offset - The offset to reach. This may be an expression, but the
562 /// expression must be associated with the current section.
563 /// @param Value - The value to use when filling bytes.
564 /// @return false on success, true if the offset was invalid.
565 virtual bool EmitValueToOffset(const MCExpr *Offset,
566 unsigned char Value = 0) = 0;
570 /// EmitFileDirective - Switch to a new logical file. This is used to
571 /// implement the '.file "foo.c"' assembler directive.
572 virtual void EmitFileDirective(StringRef Filename) = 0;
574 /// Emit the "identifiers" directive. This implements the
575 /// '.ident "version foo"' assembler directive.
576 virtual void EmitIdent(StringRef IdentString) {}
578 /// EmitDwarfFileDirective - Associate a filename with a specified logical
579 /// file number. This implements the DWARF2 '.file 4 "foo.c"' assembler
581 virtual bool EmitDwarfFileDirective(unsigned FileNo, StringRef Directory,
582 StringRef Filename, unsigned CUID = 0);
584 /// EmitDwarfLocDirective - This implements the DWARF2
585 // '.loc fileno lineno ...' assembler directive.
586 virtual void EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
587 unsigned Column, unsigned Flags,
588 unsigned Isa, unsigned Discriminator,
591 virtual void EmitDwarfAdvanceLineAddr(int64_t LineDelta,
592 const MCSymbol *LastLabel,
593 const MCSymbol *Label,
594 unsigned PointerSize) = 0;
596 virtual void EmitDwarfAdvanceFrameAddr(const MCSymbol *LastLabel,
597 const MCSymbol *Label) {}
599 void EmitDwarfSetLineAddr(int64_t LineDelta, const MCSymbol *Label,
602 virtual void EmitCompactUnwindEncoding(uint32_t CompactUnwindEncoding);
603 virtual void EmitCFISections(bool EH, bool Debug);
604 void EmitCFIStartProc();
605 void EmitCFIEndProc();
606 virtual void EmitCFIDefCfa(int64_t Register, int64_t Offset);
607 virtual void EmitCFIDefCfaOffset(int64_t Offset);
608 virtual void EmitCFIDefCfaRegister(int64_t Register);
609 virtual void EmitCFIOffset(int64_t Register, int64_t Offset);
610 virtual void EmitCFIPersonality(const MCSymbol *Sym, unsigned Encoding);
611 virtual void EmitCFILsda(const MCSymbol *Sym, unsigned Encoding);
612 virtual void EmitCFIRememberState();
613 virtual void EmitCFIRestoreState();
614 virtual void EmitCFISameValue(int64_t Register);
615 virtual void EmitCFIRestore(int64_t Register);
616 virtual void EmitCFIRelOffset(int64_t Register, int64_t Offset);
617 virtual void EmitCFIAdjustCfaOffset(int64_t Adjustment);
618 virtual void EmitCFIEscape(StringRef Values);
619 virtual void EmitCFISignalFrame();
620 virtual void EmitCFIUndefined(int64_t Register);
621 virtual void EmitCFIRegister(int64_t Register1, int64_t Register2);
622 virtual void EmitCFIWindowSave();
624 virtual void EmitWin64EHStartProc(const MCSymbol *Symbol);
625 virtual void EmitWin64EHEndProc();
626 virtual void EmitWin64EHStartChained();
627 virtual void EmitWin64EHEndChained();
628 virtual void EmitWin64EHHandler(const MCSymbol *Sym, bool Unwind,
630 virtual void EmitWin64EHHandlerData();
631 virtual void EmitWin64EHPushReg(unsigned Register);
632 virtual void EmitWin64EHSetFrame(unsigned Register, unsigned Offset);
633 virtual void EmitWin64EHAllocStack(unsigned Size);
634 virtual void EmitWin64EHSaveReg(unsigned Register, unsigned Offset);
635 virtual void EmitWin64EHSaveXMM(unsigned Register, unsigned Offset);
636 virtual void EmitWin64EHPushFrame(bool Code);
637 virtual void EmitWin64EHEndProlog();
639 /// EmitInstruction - Emit the given @p Instruction into the current
641 virtual void EmitInstruction(const MCInst &Inst) = 0;
643 /// \brief Set the bundle alignment mode from now on in the section.
644 /// The argument is the power of 2 to which the alignment is set. The
645 /// value 0 means turn the bundle alignment off.
646 virtual void EmitBundleAlignMode(unsigned AlignPow2) = 0;
648 /// \brief The following instructions are a bundle-locked group.
650 /// \param AlignToEnd - If true, the bundle-locked group will be aligned to
651 /// the end of a bundle.
652 virtual void EmitBundleLock(bool AlignToEnd) = 0;
654 /// \brief Ends a bundle-locked group.
655 virtual void EmitBundleUnlock() = 0;
657 /// EmitRawText - If this file is backed by a assembly streamer, this dumps
658 /// the specified string in the output .s file. This capability is
659 /// indicated by the hasRawTextSupport() predicate. By default this aborts.
660 virtual void EmitRawText(StringRef String);
661 void EmitRawText(const Twine &String);
663 /// Flush - Causes any cached state to be written out.
664 virtual void Flush() {}
666 /// FinishImpl - Streamer specific finalization.
667 virtual void FinishImpl() = 0;
668 /// Finish - Finish emission of machine code.
672 /// createNullStreamer - Create a dummy machine code streamer, which does
673 /// nothing. This is useful for timing the assembler front end.
674 MCStreamer *createNullStreamer(MCContext &Ctx);
676 /// createAsmStreamer - Create a machine code streamer which will print out
677 /// assembly for the native target, suitable for compiling with a native
680 /// \param InstPrint - If given, the instruction printer to use. If not given
681 /// the MCInst representation will be printed. This method takes ownership of
684 /// \param CE - If given, a code emitter to use to show the instruction
685 /// encoding inline with the assembly. This method takes ownership of \p CE.
687 /// \param TAB - If given, a target asm backend to use to show the fixup
688 /// information in conjunction with encoding information. This method takes
689 /// ownership of \p TAB.
691 /// \param ShowInst - Whether to show the MCInst representation inline with
693 MCStreamer *createAsmStreamer(MCContext &Ctx, MCTargetStreamer *TargetStreamer,
694 formatted_raw_ostream &OS, bool isVerboseAsm,
695 bool useLoc, bool useCFI, bool useDwarfDirectory,
696 MCInstPrinter *InstPrint = 0,
697 MCCodeEmitter *CE = 0, MCAsmBackend *TAB = 0,
698 bool ShowInst = false);
700 /// createMachOStreamer - Create a machine code streamer which will generate
701 /// Mach-O format object files.
703 /// Takes ownership of \p TAB and \p CE.
704 MCStreamer *createMachOStreamer(MCContext &Ctx, MCAsmBackend &TAB,
705 raw_ostream &OS, MCCodeEmitter *CE,
706 bool RelaxAll = false);
708 /// createWinCOFFStreamer - Create a machine code streamer which will
709 /// generate Microsoft COFF format object files.
711 /// Takes ownership of \p TAB and \p CE.
712 MCStreamer *createWinCOFFStreamer(MCContext &Ctx, MCAsmBackend &TAB,
713 MCCodeEmitter &CE, raw_ostream &OS,
714 bool RelaxAll = false);
716 /// createELFStreamer - Create a machine code streamer which will generate
717 /// ELF format object files.
718 MCStreamer *createELFStreamer(MCContext &Ctx, MCTargetStreamer *TargetStreamer,
719 MCAsmBackend &TAB, raw_ostream &OS,
720 MCCodeEmitter *CE, bool RelaxAll,
723 /// createPureStreamer - Create a machine code streamer which will generate
724 /// "pure" MC object files, for use with MC-JIT and testing tools.
726 /// Takes ownership of \p TAB and \p CE.
727 MCStreamer *createPureStreamer(MCContext &Ctx, MCAsmBackend &TAB,
728 raw_ostream &OS, MCCodeEmitter *CE);
730 } // end namespace llvm