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 {
79 virtual void anchor();
81 virtual void emitFnStart() = 0;
82 virtual void emitFnEnd() = 0;
83 virtual void emitCantUnwind() = 0;
84 virtual void emitPersonality(const MCSymbol *Personality) = 0;
85 virtual void emitHandlerData() = 0;
86 virtual void emitSetFP(unsigned FpReg, unsigned SpReg,
87 int64_t Offset = 0) = 0;
88 virtual void emitPad(int64_t Offset) = 0;
89 virtual void emitRegSave(const SmallVectorImpl<unsigned> &RegList,
92 virtual void switchVendor(StringRef Vendor) = 0;
93 virtual void emitAttribute(unsigned Attribute, unsigned Value) = 0;
94 virtual void emitTextAttribute(unsigned Attribute, StringRef String) = 0;
95 virtual void emitFPU(unsigned FPU) = 0;
96 virtual void emitArch(unsigned Arch) = 0;
97 virtual void finishAttributeSection() = 0;
98 virtual void emitInst(uint32_t Inst, char Suffix = '\0') = 0;
101 /// MCStreamer - Streaming machine code generation interface. This interface
102 /// is intended to provide a programatic interface that is very similar to the
103 /// level that an assembler .s file provides. It has callbacks to emit bytes,
104 /// handle directives, etc. The implementation of this interface retains
105 /// state to know what the current section is etc.
107 /// There are multiple implementations of this interface: one for writing out
108 /// a .s file, and implementations that write out .o files of various formats.
112 OwningPtr<MCTargetStreamer> TargetStreamer;
114 MCStreamer(const MCStreamer &) LLVM_DELETED_FUNCTION;
115 MCStreamer &operator=(const MCStreamer &) LLVM_DELETED_FUNCTION;
120 std::vector<MCDwarfFrameInfo> FrameInfos;
121 MCDwarfFrameInfo *getCurrentFrameInfo();
122 MCSymbol *EmitCFICommon();
123 void EnsureValidFrame();
125 std::vector<MCWin64EHUnwindInfo *> W64UnwindInfos;
126 MCWin64EHUnwindInfo *CurrentW64UnwindInfo;
127 void setCurrentW64UnwindInfo(MCWin64EHUnwindInfo *Frame);
128 void EnsureValidW64UnwindInfo();
130 MCSymbol *LastSymbol;
132 // SymbolOrdering - Tracks an index to represent the order
133 // a symbol was emitted in. Zero means we did not emit that symbol.
134 DenseMap<const MCSymbol *, unsigned> SymbolOrdering;
136 /// SectionStack - This is stack of current and previous section
137 /// values saved by PushSection.
138 SmallVector<std::pair<MCSectionSubPair, MCSectionSubPair>, 4> SectionStack;
140 bool AutoInitSections;
143 MCStreamer(MCContext &Ctx, MCTargetStreamer *TargetStreamer);
145 const MCExpr *BuildSymbolDiff(MCContext &Context, const MCSymbol *A,
148 const MCExpr *ForceExpAbs(const MCExpr *Expr);
150 void RecordProcStart(MCDwarfFrameInfo &Frame);
151 virtual void EmitCFIStartProcImpl(MCDwarfFrameInfo &Frame);
152 void RecordProcEnd(MCDwarfFrameInfo &Frame);
153 virtual void EmitCFIEndProcImpl(MCDwarfFrameInfo &CurFrame);
154 void EmitFrames(MCAsmBackend *MAB, bool usingCFI);
156 MCWin64EHUnwindInfo *getCurrentW64UnwindInfo() {
157 return CurrentW64UnwindInfo;
159 void EmitW64Tables();
161 virtual void EmitRawTextImpl(StringRef String);
164 virtual ~MCStreamer();
168 virtual void reset();
170 MCContext &getContext() const { return Context; }
172 MCTargetStreamer &getTargetStreamer() {
173 assert(TargetStreamer);
174 return *TargetStreamer;
177 unsigned getNumFrameInfos() { return FrameInfos.size(); }
179 const MCDwarfFrameInfo &getFrameInfo(unsigned i) { return FrameInfos[i]; }
181 ArrayRef<MCDwarfFrameInfo> getFrameInfos() const { return FrameInfos; }
183 unsigned getNumW64UnwindInfos() { return W64UnwindInfos.size(); }
185 MCWin64EHUnwindInfo &getW64UnwindInfo(unsigned i) {
186 return *W64UnwindInfos[i];
189 void generateCompactUnwindEncodings(MCAsmBackend *MAB);
191 /// @name Assembly File Formatting.
194 /// isVerboseAsm - Return true if this streamer supports verbose assembly
195 /// and if it is enabled.
196 virtual bool isVerboseAsm() const { return false; }
198 /// hasRawTextSupport - Return true if this asm streamer supports emitting
199 /// unformatted text to the .s file with EmitRawText.
200 virtual bool hasRawTextSupport() const { return false; }
202 /// AddComment - Add a comment that can be emitted to the generated .s
203 /// file if applicable as a QoI issue to make the output of the compiler
204 /// more readable. This only affects the MCAsmStreamer, and only when
205 /// verbose assembly output is enabled.
207 /// If the comment includes embedded \n's, they will each get the comment
208 /// prefix as appropriate. The added comment should not end with a \n.
209 virtual void AddComment(const Twine &T) {}
211 /// GetCommentOS - Return a raw_ostream that comments can be written to.
212 /// Unlike AddComment, you are required to terminate comments with \n if you
214 virtual raw_ostream &GetCommentOS();
216 /// AddBlankLine - Emit a blank line to a .s file to pretty it up.
217 virtual void AddBlankLine() {}
221 /// @name Symbol & Section Management
224 /// getCurrentSection - Return the current section that the streamer is
225 /// emitting code to.
226 MCSectionSubPair getCurrentSection() const {
227 if (!SectionStack.empty())
228 return SectionStack.back().first;
229 return MCSectionSubPair();
232 /// getPreviousSection - Return the previous section that the streamer is
233 /// emitting code to.
234 MCSectionSubPair getPreviousSection() const {
235 if (!SectionStack.empty())
236 return SectionStack.back().second;
237 return MCSectionSubPair();
240 /// GetSymbolOrder - Returns an index to represent the order
241 /// a symbol was emitted in. (zero if we did not emit that symbol)
242 unsigned GetSymbolOrder(const MCSymbol *Sym) const {
243 return SymbolOrdering.lookup(Sym);
246 /// ChangeSection - Update streamer for a new active section.
248 /// This is called by PopSection and SwitchSection, if the current
250 virtual void ChangeSection(const MCSection *, const MCExpr *) = 0;
252 /// pushSection - Save the current and previous section on the
255 SectionStack.push_back(
256 std::make_pair(getCurrentSection(), getPreviousSection()));
259 /// popSection - Restore the current and previous section from
260 /// the section stack. Calls ChangeSection as needed.
262 /// Returns false if the stack was empty.
264 if (SectionStack.size() <= 1)
266 MCSectionSubPair oldSection = SectionStack.pop_back_val().first;
267 MCSectionSubPair curSection = SectionStack.back().first;
269 if (oldSection != curSection)
270 ChangeSection(curSection.first, curSection.second);
274 bool SubSection(const MCExpr *Subsection) {
275 if (SectionStack.empty())
278 SwitchSection(SectionStack.back().first.first, Subsection);
282 /// SwitchSection - Set the current section where code is being emitted to
283 /// @p Section. This is required to update CurSection.
285 /// This corresponds to assembler directives like .section, .text, etc.
286 void SwitchSection(const MCSection *Section, const MCExpr *Subsection = 0) {
287 assert(Section && "Cannot switch to a null section!");
288 MCSectionSubPair curSection = SectionStack.back().first;
289 SectionStack.back().second = curSection;
290 if (MCSectionSubPair(Section, Subsection) != curSection) {
291 SectionStack.back().first = MCSectionSubPair(Section, Subsection);
292 ChangeSection(Section, Subsection);
296 /// SwitchSectionNoChange - Set the current section where code is being
297 /// emitted to @p Section. This is required to update CurSection. This
298 /// version does not call ChangeSection.
299 void SwitchSectionNoChange(const MCSection *Section,
300 const MCExpr *Subsection = 0) {
301 assert(Section && "Cannot switch to a null section!");
302 MCSectionSubPair curSection = SectionStack.back().first;
303 SectionStack.back().second = curSection;
304 if (MCSectionSubPair(Section, Subsection) != curSection)
305 SectionStack.back().first = MCSectionSubPair(Section, Subsection);
308 /// Initialize the streamer.
309 void InitStreamer() {
310 if (AutoInitSections)
314 /// Tell this MCStreamer to call InitSections upon initialization.
315 void setAutoInitSections(bool AutoInitSections) {
316 this->AutoInitSections = AutoInitSections;
319 /// InitSections - Create the default sections and set the initial one.
320 virtual void InitSections() = 0;
322 /// InitToTextSection - Create a text section and switch the streamer to it.
323 virtual void InitToTextSection() = 0;
325 /// AssignSection - Sets the symbol's section.
327 /// Each emitted symbol will be tracked in the ordering table,
328 /// so we can sort on them later.
329 void AssignSection(MCSymbol *Symbol, const MCSection *Section);
331 /// EmitLabel - Emit a label for @p Symbol into the current section.
333 /// This corresponds to an assembler statement such as:
336 /// @param Symbol - The symbol to emit. A given symbol should only be
337 /// emitted as a label once, and symbols emitted as a label should never be
338 /// used in an assignment.
339 // FIXME: These emission are non-const because we mutate the symbol to
340 // add the section we're emitting it to later.
341 virtual void EmitLabel(MCSymbol *Symbol);
343 virtual void EmitDebugLabel(MCSymbol *Symbol);
345 virtual void EmitEHSymAttributes(const MCSymbol *Symbol, MCSymbol *EHSymbol);
347 /// EmitAssemblerFlag - Note in the output the specified @p Flag.
348 virtual void EmitAssemblerFlag(MCAssemblerFlag Flag) = 0;
350 /// EmitLinkerOptions - Emit the given list @p Options of strings as linker
351 /// options into the output.
352 virtual void EmitLinkerOptions(ArrayRef<std::string> Kind) {}
354 /// EmitDataRegion - Note in the output the specified region @p Kind.
355 virtual void EmitDataRegion(MCDataRegionType Kind) {}
357 /// EmitThumbFunc - Note in the output that the specified @p Func is
358 /// a Thumb mode function (ARM target only).
359 virtual void EmitThumbFunc(MCSymbol *Func) = 0;
361 /// getOrCreateSymbolData - Get symbol data for given symbol.
362 virtual MCSymbolData &getOrCreateSymbolData(MCSymbol *Symbol);
364 /// EmitAssignment - Emit an assignment of @p Value to @p Symbol.
366 /// This corresponds to an assembler statement such as:
369 /// The assignment generates no code, but has the side effect of binding the
370 /// value in the current context. For the assembly streamer, this prints the
371 /// binding into the .s file.
373 /// @param Symbol - The symbol being assigned to.
374 /// @param Value - The value for the symbol.
375 virtual void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) = 0;
377 /// EmitWeakReference - Emit an weak reference from @p Alias to @p Symbol.
379 /// This corresponds to an assembler statement such as:
380 /// .weakref alias, symbol
382 /// @param Alias - The alias that is being created.
383 /// @param Symbol - The symbol being aliased.
384 virtual void EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol) = 0;
386 /// EmitSymbolAttribute - Add the given @p Attribute to @p Symbol.
387 virtual bool EmitSymbolAttribute(MCSymbol *Symbol,
388 MCSymbolAttr Attribute) = 0;
390 /// EmitSymbolDesc - Set the @p DescValue for the @p Symbol.
392 /// @param Symbol - The symbol to have its n_desc field set.
393 /// @param DescValue - The value to set into the n_desc field.
394 virtual void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) = 0;
396 /// BeginCOFFSymbolDef - Start emitting COFF symbol definition
398 /// @param Symbol - The symbol to have its External & Type fields set.
399 virtual void BeginCOFFSymbolDef(const MCSymbol *Symbol) = 0;
401 /// EmitCOFFSymbolStorageClass - Emit the storage class of the symbol.
403 /// @param StorageClass - The storage class the symbol should have.
404 virtual void EmitCOFFSymbolStorageClass(int StorageClass) = 0;
406 /// EmitCOFFSymbolType - Emit the type of the symbol.
408 /// @param Type - A COFF type identifier (see COFF::SymbolType in X86COFF.h)
409 virtual void EmitCOFFSymbolType(int Type) = 0;
411 /// EndCOFFSymbolDef - Marks the end of the symbol definition.
412 virtual void EndCOFFSymbolDef() = 0;
414 /// EmitCOFFSecRel32 - Emits a COFF section relative relocation.
416 /// @param Symbol - Symbol the section relative realocation should point to.
417 virtual void EmitCOFFSecRel32(MCSymbol const *Symbol);
419 /// EmitELFSize - Emit an ELF .size directive.
421 /// This corresponds to an assembler statement such as:
422 /// .size symbol, expression
424 virtual void EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) = 0;
426 /// EmitCommonSymbol - Emit a common symbol.
428 /// @param Symbol - The common symbol to emit.
429 /// @param Size - The size of the common symbol.
430 /// @param ByteAlignment - The alignment of the symbol if
431 /// non-zero. This must be a power of 2.
432 virtual void EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
433 unsigned ByteAlignment) = 0;
435 /// EmitLocalCommonSymbol - Emit a local common (.lcomm) 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 common symbol in bytes.
440 virtual void EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size,
441 unsigned ByteAlignment) = 0;
443 /// EmitZerofill - Emit the zerofill section and an optional symbol.
445 /// @param Section - The zerofill section to create and or to put the symbol
446 /// @param Symbol - The zerofill symbol to emit, if non-NULL.
447 /// @param Size - The size of the zerofill symbol.
448 /// @param ByteAlignment - The alignment of the zerofill symbol if
449 /// non-zero. This must be a power of 2 on some targets.
450 virtual void EmitZerofill(const MCSection *Section, MCSymbol *Symbol = 0,
451 uint64_t Size = 0, unsigned ByteAlignment = 0) = 0;
453 /// EmitTBSSSymbol - Emit a thread local bss (.tbss) symbol.
455 /// @param Section - The thread local common section.
456 /// @param Symbol - The thread local common symbol to emit.
457 /// @param Size - The size of the symbol.
458 /// @param ByteAlignment - The alignment of the thread local common symbol
459 /// if non-zero. This must be a power of 2 on some targets.
460 virtual void EmitTBSSSymbol(const MCSection *Section, MCSymbol *Symbol,
461 uint64_t Size, unsigned ByteAlignment = 0) = 0;
464 /// @name Generating Data
467 /// EmitBytes - Emit the bytes in \p Data into the output.
469 /// This is used to implement assembler directives such as .byte, .ascii,
471 virtual void EmitBytes(StringRef Data) = 0;
473 /// EmitValue - Emit the expression @p Value into the output as a native
474 /// integer of the given @p Size bytes.
476 /// This is used to implement assembler directives such as .word, .quad,
479 /// @param Value - The value to emit.
480 /// @param Size - The size of the integer (in bytes) to emit. This must
481 /// match a native machine width.
482 virtual void EmitValueImpl(const MCExpr *Value, unsigned Size) = 0;
484 void EmitValue(const MCExpr *Value, unsigned Size);
486 /// EmitIntValue - Special case of EmitValue that avoids the client having
487 /// to pass in a MCExpr for constant integers.
488 virtual void EmitIntValue(uint64_t Value, unsigned Size);
490 /// EmitAbsValue - Emit the Value, but try to avoid relocations. On MachO
491 /// this is done by producing
494 void EmitAbsValue(const MCExpr *Value, unsigned Size);
496 virtual void EmitULEB128Value(const MCExpr *Value) = 0;
498 virtual void EmitSLEB128Value(const MCExpr *Value) = 0;
500 /// EmitULEB128Value - Special case of EmitULEB128Value that avoids the
501 /// client having to pass in a MCExpr for constant integers.
502 void EmitULEB128IntValue(uint64_t Value, unsigned Padding = 0);
504 /// EmitSLEB128Value - Special case of EmitSLEB128Value that avoids the
505 /// client having to pass in a MCExpr for constant integers.
506 void EmitSLEB128IntValue(int64_t Value);
508 /// EmitSymbolValue - Special case of EmitValue that avoids the client
509 /// having to pass in a MCExpr for MCSymbols.
510 void EmitSymbolValue(const MCSymbol *Sym, unsigned Size);
512 /// EmitGPRel64Value - Emit the expression @p Value into the output as a
513 /// gprel64 (64-bit GP relative) value.
515 /// This is used to implement assembler directives such as .gpdword on
516 /// targets that support them.
517 virtual void EmitGPRel64Value(const MCExpr *Value);
519 /// EmitGPRel32Value - Emit the expression @p Value into the output as a
520 /// gprel32 (32-bit GP relative) value.
522 /// This is used to implement assembler directives such as .gprel32 on
523 /// targets that support them.
524 virtual void EmitGPRel32Value(const MCExpr *Value);
526 /// EmitFill - Emit NumBytes bytes worth of the value specified by
527 /// FillValue. This implements directives such as '.space'.
528 virtual void EmitFill(uint64_t NumBytes, uint8_t FillValue);
530 /// \brief Emit NumBytes worth of zeros.
531 /// This function properly handles data in virtual sections.
532 virtual void EmitZeros(uint64_t NumBytes);
534 /// EmitValueToAlignment - Emit some number of copies of @p Value until
535 /// the byte alignment @p ByteAlignment is reached.
537 /// If the number of bytes need to emit for the alignment is not a multiple
538 /// of @p ValueSize, then the contents of the emitted fill bytes is
541 /// This used to implement the .align assembler directive.
543 /// @param ByteAlignment - The alignment to reach. This must be a power of
544 /// two on some targets.
545 /// @param Value - The value to use when filling bytes.
546 /// @param ValueSize - The size of the integer (in bytes) to emit for
547 /// @p Value. This must match a native machine width.
548 /// @param MaxBytesToEmit - The maximum numbers of bytes to emit, or 0. If
549 /// the alignment cannot be reached in this many bytes, no bytes are
551 virtual void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
552 unsigned ValueSize = 1,
553 unsigned MaxBytesToEmit = 0) = 0;
555 /// EmitCodeAlignment - Emit nops until the byte alignment @p ByteAlignment
558 /// This used to align code where the alignment bytes may be executed. This
559 /// can emit different bytes for different sizes to optimize execution.
561 /// @param ByteAlignment - The alignment to reach. This must be a power of
562 /// two on some targets.
563 /// @param MaxBytesToEmit - The maximum numbers of bytes to emit, or 0. If
564 /// the alignment cannot be reached in this many bytes, no bytes are
566 virtual void EmitCodeAlignment(unsigned ByteAlignment,
567 unsigned MaxBytesToEmit = 0) = 0;
569 /// EmitValueToOffset - Emit some number of copies of @p Value until the
570 /// byte offset @p Offset is reached.
572 /// This is used to implement assembler directives such as .org.
574 /// @param Offset - The offset to reach. This may be an expression, but the
575 /// expression must be associated with the current section.
576 /// @param Value - The value to use when filling bytes.
577 /// @return false on success, true if the offset was invalid.
578 virtual bool EmitValueToOffset(const MCExpr *Offset,
579 unsigned char Value = 0) = 0;
583 /// EmitFileDirective - Switch to a new logical file. This is used to
584 /// implement the '.file "foo.c"' assembler directive.
585 virtual void EmitFileDirective(StringRef Filename) = 0;
587 /// Emit the "identifiers" directive. This implements the
588 /// '.ident "version foo"' assembler directive.
589 virtual void EmitIdent(StringRef IdentString) {}
591 /// EmitDwarfFileDirective - Associate a filename with a specified logical
592 /// file number. This implements the DWARF2 '.file 4 "foo.c"' assembler
594 virtual bool EmitDwarfFileDirective(unsigned FileNo, StringRef Directory,
595 StringRef Filename, unsigned CUID = 0);
597 /// EmitDwarfLocDirective - This implements the DWARF2
598 // '.loc fileno lineno ...' assembler directive.
599 virtual void EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
600 unsigned Column, unsigned Flags,
601 unsigned Isa, unsigned Discriminator,
604 virtual void EmitDwarfAdvanceLineAddr(int64_t LineDelta,
605 const MCSymbol *LastLabel,
606 const MCSymbol *Label,
607 unsigned PointerSize) = 0;
609 virtual void EmitDwarfAdvanceFrameAddr(const MCSymbol *LastLabel,
610 const MCSymbol *Label) {}
612 void EmitDwarfSetLineAddr(int64_t LineDelta, const MCSymbol *Label,
615 virtual void EmitCompactUnwindEncoding(uint32_t CompactUnwindEncoding);
616 virtual void EmitCFISections(bool EH, bool Debug);
617 void EmitCFIStartProc();
618 void EmitCFIEndProc();
619 virtual void EmitCFIDefCfa(int64_t Register, int64_t Offset);
620 virtual void EmitCFIDefCfaOffset(int64_t Offset);
621 virtual void EmitCFIDefCfaRegister(int64_t Register);
622 virtual void EmitCFIOffset(int64_t Register, int64_t Offset);
623 virtual void EmitCFIPersonality(const MCSymbol *Sym, unsigned Encoding);
624 virtual void EmitCFILsda(const MCSymbol *Sym, unsigned Encoding);
625 virtual void EmitCFIRememberState();
626 virtual void EmitCFIRestoreState();
627 virtual void EmitCFISameValue(int64_t Register);
628 virtual void EmitCFIRestore(int64_t Register);
629 virtual void EmitCFIRelOffset(int64_t Register, int64_t Offset);
630 virtual void EmitCFIAdjustCfaOffset(int64_t Adjustment);
631 virtual void EmitCFIEscape(StringRef Values);
632 virtual void EmitCFISignalFrame();
633 virtual void EmitCFIUndefined(int64_t Register);
634 virtual void EmitCFIRegister(int64_t Register1, int64_t Register2);
635 virtual void EmitCFIWindowSave();
637 virtual void EmitWin64EHStartProc(const MCSymbol *Symbol);
638 virtual void EmitWin64EHEndProc();
639 virtual void EmitWin64EHStartChained();
640 virtual void EmitWin64EHEndChained();
641 virtual void EmitWin64EHHandler(const MCSymbol *Sym, bool Unwind,
643 virtual void EmitWin64EHHandlerData();
644 virtual void EmitWin64EHPushReg(unsigned Register);
645 virtual void EmitWin64EHSetFrame(unsigned Register, unsigned Offset);
646 virtual void EmitWin64EHAllocStack(unsigned Size);
647 virtual void EmitWin64EHSaveReg(unsigned Register, unsigned Offset);
648 virtual void EmitWin64EHSaveXMM(unsigned Register, unsigned Offset);
649 virtual void EmitWin64EHPushFrame(bool Code);
650 virtual void EmitWin64EHEndProlog();
652 /// EmitInstruction - Emit the given @p Instruction into the current
654 virtual void EmitInstruction(const MCInst &Inst) = 0;
656 /// \brief Set the bundle alignment mode from now on in the section.
657 /// The argument is the power of 2 to which the alignment is set. The
658 /// value 0 means turn the bundle alignment off.
659 virtual void EmitBundleAlignMode(unsigned AlignPow2) = 0;
661 /// \brief The following instructions are a bundle-locked group.
663 /// \param AlignToEnd - If true, the bundle-locked group will be aligned to
664 /// the end of a bundle.
665 virtual void EmitBundleLock(bool AlignToEnd) = 0;
667 /// \brief Ends a bundle-locked group.
668 virtual void EmitBundleUnlock() = 0;
670 /// EmitRawText - If this file is backed by a assembly streamer, this dumps
671 /// the specified string in the output .s file. This capability is
672 /// indicated by the hasRawTextSupport() predicate. By default this aborts.
673 void EmitRawText(const Twine &String);
675 /// Flush - Causes any cached state to be written out.
676 virtual void Flush() {}
678 /// FinishImpl - Streamer specific finalization.
679 virtual void FinishImpl() = 0;
680 /// Finish - Finish emission of machine code.
684 /// createNullStreamer - Create a dummy machine code streamer, which does
685 /// nothing. This is useful for timing the assembler front end.
686 MCStreamer *createNullStreamer(MCContext &Ctx);
688 /// createAsmStreamer - Create a machine code streamer which will print out
689 /// assembly for the native target, suitable for compiling with a native
692 /// \param InstPrint - If given, the instruction printer to use. If not given
693 /// the MCInst representation will be printed. This method takes ownership of
696 /// \param CE - If given, a code emitter to use to show the instruction
697 /// encoding inline with the assembly. This method takes ownership of \p CE.
699 /// \param TAB - If given, a target asm backend to use to show the fixup
700 /// information in conjunction with encoding information. This method takes
701 /// ownership of \p TAB.
703 /// \param ShowInst - Whether to show the MCInst representation inline with
705 MCStreamer *createAsmStreamer(MCContext &Ctx, MCTargetStreamer *TargetStreamer,
706 formatted_raw_ostream &OS, bool isVerboseAsm,
707 bool useLoc, bool useCFI, bool useDwarfDirectory,
708 MCInstPrinter *InstPrint = 0,
709 MCCodeEmitter *CE = 0, MCAsmBackend *TAB = 0,
710 bool ShowInst = false);
712 /// createMachOStreamer - Create a machine code streamer which will generate
713 /// Mach-O format object files.
715 /// Takes ownership of \p TAB and \p CE.
716 MCStreamer *createMachOStreamer(MCContext &Ctx, MCAsmBackend &TAB,
717 raw_ostream &OS, MCCodeEmitter *CE,
718 bool RelaxAll = false);
720 /// createWinCOFFStreamer - Create a machine code streamer which will
721 /// generate Microsoft COFF format object files.
723 /// Takes ownership of \p TAB and \p CE.
724 MCStreamer *createWinCOFFStreamer(MCContext &Ctx, MCAsmBackend &TAB,
725 MCCodeEmitter &CE, raw_ostream &OS,
726 bool RelaxAll = false);
728 /// createELFStreamer - Create a machine code streamer which will generate
729 /// ELF format object files.
730 MCStreamer *createELFStreamer(MCContext &Ctx, MCTargetStreamer *TargetStreamer,
731 MCAsmBackend &TAB, raw_ostream &OS,
732 MCCodeEmitter *CE, bool RelaxAll,
735 /// createPureStreamer - Create a machine code streamer which will generate
736 /// "pure" MC object files, for use with MC-JIT and testing tools.
738 /// Takes ownership of \p TAB and \p CE.
739 MCStreamer *createPureStreamer(MCContext &Ctx, MCAsmBackend &TAB,
740 raw_ostream &OS, MCCodeEmitter *CE);
742 } // end namespace llvm