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/System/DataTypes.h"
18 #include "llvm/MC/MCDirectives.h"
30 class TargetAsmBackend;
33 class formatted_raw_ostream;
35 /// MCStreamer - Streaming machine code generation interface. This interface
36 /// is intended to provide a programatic interface that is very similar to the
37 /// level that an assembler .s file provides. It has callbacks to emit bytes,
38 /// handle directives, etc. The implementation of this interface retains
39 /// state to know what the current section is etc.
41 /// There are multiple implementations of this interface: one for writing out
42 /// a .s file, and implementations that write out .o files of various formats.
47 MCStreamer(const MCStreamer&); // DO NOT IMPLEMENT
48 MCStreamer &operator=(const MCStreamer&); // DO NOT IMPLEMENT
51 MCStreamer(MCContext &Ctx);
53 /// CurSection - This is the current section code is being emitted to, it is
54 /// kept up to date by SwitchSection.
55 const MCSection *CurSection;
58 virtual ~MCStreamer();
60 MCContext &getContext() const { return Context; }
62 /// @name Assembly File Formatting.
65 /// isVerboseAsm - Return true if this streamer supports verbose assembly
66 /// and if it is enabled.
67 virtual bool isVerboseAsm() const { return false; }
69 /// hasRawTextSupport - Return true if this asm streamer supports emitting
70 /// unformatted text to the .s file with EmitRawText.
71 virtual bool hasRawTextSupport() const { return false; }
73 /// AddComment - Add a comment that can be emitted to the generated .s
74 /// file if applicable as a QoI issue to make the output of the compiler
75 /// more readable. This only affects the MCAsmStreamer, and only when
76 /// verbose assembly output is enabled.
78 /// If the comment includes embedded \n's, they will each get the comment
79 /// prefix as appropriate. The added comment should not end with a \n.
80 virtual void AddComment(const Twine &T) {}
82 /// GetCommentOS - Return a raw_ostream that comments can be written to.
83 /// Unlike AddComment, you are required to terminate comments with \n if you
85 virtual raw_ostream &GetCommentOS();
87 /// AddBlankLine - Emit a blank line to a .s file to pretty it up.
88 virtual void AddBlankLine() {}
92 /// @name Symbol & Section Management
95 /// getCurrentSection - Return the current section that the streamer is
97 const MCSection *getCurrentSection() const { return CurSection; }
99 /// SwitchSection - Set the current section where code is being emitted to
100 /// @p Section. This is required to update CurSection.
102 /// This corresponds to assembler directives like .section, .text, etc.
103 virtual void SwitchSection(const MCSection *Section) = 0;
105 /// EmitLabel - Emit a label for @p Symbol into the current section.
107 /// This corresponds to an assembler statement such as:
110 /// @param Symbol - The symbol to emit. A given symbol should only be
111 /// emitted as a label once, and symbols emitted as a label should never be
112 /// used in an assignment.
113 virtual void EmitLabel(MCSymbol *Symbol) = 0;
115 /// EmitAssemblerFlag - Note in the output the specified @p Flag
116 virtual void EmitAssemblerFlag(MCAssemblerFlag Flag) = 0;
118 /// EmitAssignment - Emit an assignment of @p Value to @p Symbol.
120 /// This corresponds to an assembler statement such as:
123 /// The assignment generates no code, but has the side effect of binding the
124 /// value in the current context. For the assembly streamer, this prints the
125 /// binding into the .s file.
127 /// @param Symbol - The symbol being assigned to.
128 /// @param Value - The value for the symbol.
129 virtual void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) = 0;
131 /// EmitSymbolAttribute - Add the given @p Attribute to @p Symbol.
132 virtual void EmitSymbolAttribute(MCSymbol *Symbol,
133 MCSymbolAttr Attribute) = 0;
135 /// EmitSymbolDesc - Set the @p DescValue for the @p Symbol.
137 /// @param Symbol - The symbol to have its n_desc field set.
138 /// @param DescValue - The value to set into the n_desc field.
139 virtual void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) = 0;
141 /// BeginCOFFSymbolDef - Start emitting COFF symbol definition
143 /// @param Symbol - The symbol to have its External & Type fields set.
144 virtual void BeginCOFFSymbolDef(const MCSymbol *Symbol) = 0;
146 /// EmitCOFFSymbolStorageClass - Emit the storage class of the symbol.
148 /// @param StorageClass - The storage class the symbol should have.
149 virtual void EmitCOFFSymbolStorageClass(int StorageClass) = 0;
151 /// EmitCOFFSymbolType - Emit the type of the symbol.
153 /// @param Type - A COFF type identifier (see COFF::SymbolType in X86COFF.h)
154 virtual void EmitCOFFSymbolType(int Type) = 0;
156 /// EndCOFFSymbolDef - Marks the end of the symbol definition.
157 virtual void EndCOFFSymbolDef() = 0;
159 /// EmitELFSize - Emit an ELF .size directive.
161 /// This corresponds to an assembler statement such as:
162 /// .size symbol, expression
164 virtual void EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) = 0;
166 /// EmitCommonSymbol - Emit a common symbol.
168 /// @param Symbol - The common symbol to emit.
169 /// @param Size - The size of the common symbol.
170 /// @param ByteAlignment - The alignment of the symbol if
171 /// non-zero. This must be a power of 2.
172 virtual void EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
173 unsigned ByteAlignment) = 0;
175 /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
177 /// @param Symbol - The common symbol to emit.
178 /// @param Size - The size of the common symbol.
179 virtual void EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size) = 0;
181 /// EmitZerofill - Emit a the zerofill section and an option symbol.
183 /// @param Section - The zerofill section to create and or to put the symbol
184 /// @param Symbol - The zerofill symbol to emit, if non-NULL.
185 /// @param Size - The size of the zerofill symbol.
186 /// @param ByteAlignment - The alignment of the zerofill symbol if
187 /// non-zero. This must be a power of 2 on some targets.
188 virtual void EmitZerofill(const MCSection *Section, MCSymbol *Symbol = 0,
189 unsigned Size = 0,unsigned ByteAlignment = 0) = 0;
192 /// @name Generating Data
195 /// EmitBytes - Emit the bytes in \arg Data into the output.
197 /// This is used to implement assembler directives such as .byte, .ascii,
199 virtual void EmitBytes(StringRef Data, unsigned AddrSpace) = 0;
201 /// EmitValue - Emit the expression @p Value into the output as a native
202 /// integer of the given @p Size bytes.
204 /// This is used to implement assembler directives such as .word, .quad,
207 /// @param Value - The value to emit.
208 /// @param Size - The size of the integer (in bytes) to emit. This must
209 /// match a native machine width.
210 virtual void EmitValue(const MCExpr *Value, unsigned Size,
211 unsigned AddrSpace) = 0;
213 /// EmitIntValue - Special case of EmitValue that avoids the client having
214 /// to pass in a MCExpr for constant integers.
215 virtual void EmitIntValue(uint64_t Value, unsigned Size,unsigned AddrSpace);
217 /// EmitSymbolValue - Special case of EmitValue that avoids the client
218 /// having to pass in a MCExpr for MCSymbols.
219 virtual void EmitSymbolValue(const MCSymbol *Sym, unsigned Size,
222 /// EmitGPRel32Value - Emit the expression @p Value into the output as a
223 /// gprel32 (32-bit GP relative) value.
225 /// This is used to implement assembler directives such as .gprel32 on
226 /// targets that support them.
227 virtual void EmitGPRel32Value(const MCExpr *Value) = 0;
229 /// EmitFill - Emit NumBytes bytes worth of the value specified by
230 /// FillValue. This implements directives such as '.space'.
231 virtual void EmitFill(uint64_t NumBytes, uint8_t FillValue,
234 /// EmitZeros - Emit NumBytes worth of zeros. This is a convenience
235 /// function that just wraps EmitFill.
236 void EmitZeros(uint64_t NumBytes, unsigned AddrSpace) {
237 EmitFill(NumBytes, 0, AddrSpace);
241 /// EmitValueToAlignment - Emit some number of copies of @p Value until
242 /// the byte alignment @p ByteAlignment is reached.
244 /// If the number of bytes need to emit for the alignment is not a multiple
245 /// of @p ValueSize, then the contents of the emitted fill bytes is
248 /// This used to implement the .align assembler directive.
250 /// @param ByteAlignment - The alignment to reach. This must be a power of
251 /// two on some targets.
252 /// @param Value - The value to use when filling bytes.
253 /// @param ValueSize - The size of the integer (in bytes) to emit for
254 /// @p Value. This must match a native machine width.
255 /// @param MaxBytesToEmit - The maximum numbers of bytes to emit, or 0. If
256 /// the alignment cannot be reached in this many bytes, no bytes are
258 virtual void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
259 unsigned ValueSize = 1,
260 unsigned MaxBytesToEmit = 0) = 0;
262 /// EmitCodeAlignment - Emit nops until the byte alignment @p ByteAlignment
265 /// This used to align code where the alignment bytes may be executed. This
266 /// can emit different bytes for different sizes to optimize execution.
268 /// @param ByteAlignment - The alignment to reach. This must be a power of
269 /// two on some targets.
270 /// @param MaxBytesToEmit - The maximum numbers of bytes to emit, or 0. If
271 /// the alignment cannot be reached in this many bytes, no bytes are
273 virtual void EmitCodeAlignment(unsigned ByteAlignment,
274 unsigned MaxBytesToEmit = 0) = 0;
276 /// EmitValueToOffset - Emit some number of copies of @p Value until the
277 /// byte offset @p Offset is reached.
279 /// This is used to implement assembler directives such as .org.
281 /// @param Offset - The offset to reach. This may be an expression, but the
282 /// expression must be associated with the current section.
283 /// @param Value - The value to use when filling bytes.
284 virtual void EmitValueToOffset(const MCExpr *Offset,
285 unsigned char Value = 0) = 0;
289 /// EmitFileDirective - Switch to a new logical file. This is used to
290 /// implement the '.file "foo.c"' assembler directive.
291 virtual void EmitFileDirective(StringRef Filename) = 0;
293 /// EmitDwarfFileDirective - Associate a filename with a specified logical
294 /// file number. This implements the DWARF2 '.file 4 "foo.c"' assembler
296 virtual void EmitDwarfFileDirective(unsigned FileNo,StringRef Filename) = 0;
298 /// EmitInstruction - Emit the given @p Instruction into the current
300 virtual void EmitInstruction(const MCInst &Inst) = 0;
302 /// EmitRawText - If this file is backed by a assembly streamer, this dumps
303 /// the specified string in the output .s file. This capability is
304 /// indicated by the hasRawTextSupport() predicate. By default this aborts.
305 virtual void EmitRawText(StringRef String);
306 void EmitRawText(const Twine &String);
308 /// Finish - Finish emission of machine code and flush any output.
309 virtual void Finish() = 0;
312 /// createNullStreamer - Create a dummy machine code streamer, which does
313 /// nothing. This is useful for timing the assembler front end.
314 MCStreamer *createNullStreamer(MCContext &Ctx);
316 /// createAsmStreamer - Create a machine code streamer which will print out
317 /// assembly for the native target, suitable for compiling with a native
320 /// \param InstPrint - If given, the instruction printer to use. If not given
321 /// the MCInst representation will be printed. This method takes ownership of
324 /// \param CE - If given, a code emitter to use to show the instruction
325 /// encoding inline with the assembly.
327 /// \param ShowInst - Whether to show the MCInst representation inline with
329 MCStreamer *createAsmStreamer(MCContext &Ctx, formatted_raw_ostream &OS,
330 bool isLittleEndian, bool isVerboseAsm,
331 MCInstPrinter *InstPrint = 0,
332 MCCodeEmitter *CE = 0,
333 bool ShowInst = false);
335 /// createMachOStream - Create a machine code streamer which will generative
336 /// Mach-O format object files.
337 MCStreamer *createMachOStreamer(MCContext &Ctx, TargetAsmBackend &TAB,
338 raw_ostream &OS, MCCodeEmitter *CE,
339 bool RelaxAll = false);
341 } // end namespace llvm