include/llvm/MC/MCStreamer.h

   1 //===- MCStreamer.h - High-level Streaming Machine Code Output --*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file declares the MCStreamer class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_MC_MCSTREAMER_H
  15 #define LLVM_MC_MCSTREAMER_H
  16
  17 #include "llvm/System/DataTypes.h"
  18 #include "llvm/MC/MCDirectives.h"
  19
  20 namespace llvm {
  21   class MCAsmInfo;
  22   class MCCodeEmitter;
  23   class MCContext;
  24   class MCExpr;
  25   class MCInst;
  26   class MCInstPrinter;
  27   class MCSection;
  28   class MCSymbol;
  29   class StringRef;
  30   class TargetAsmBackend;
  31   class TargetLoweringObjectFile;
  32   class Twine;
  33   class raw_ostream;
  34   class formatted_raw_ostream;
  35
  36   /// MCStreamer - Streaming machine code generation interface.  This interface
  37   /// is intended to provide a programatic interface that is very similar to the
  38   /// level that an assembler .s file provides.  It has callbacks to emit bytes,
  39   /// handle directives, etc.  The implementation of this interface retains
  40   /// state to know what the current section is etc.
  41   ///
  42   /// There are multiple implementations of this interface: one for writing out
  43   /// a .s file, and implementations that write out .o files of various formats.
  44   ///
  45   class MCStreamer {
  46     MCContext &Context;
  47
  48     MCStreamer(const MCStreamer&); // DO NOT IMPLEMENT
  49     MCStreamer &operator=(const MCStreamer&); // DO NOT IMPLEMENT
  50
  51   protected:
  52     MCStreamer(MCContext &Ctx);
  53
  54     /// CurSection - This is the current section code is being emitted to, it is
  55     /// kept up to date by SwitchSection.
  56     const MCSection *CurSection;
  57
  58     /// PrevSection - This is the previous section code is being emitted to, it
  59     /// is kept up to date by SwitchSection.
  60     const MCSection *PrevSection;
  61
  62   public:
  63     virtual ~MCStreamer();
  64
  65     MCContext &getContext() const { return Context; }
  66
  67     /// @name Assembly File Formatting.
  68     /// @{
  69
  70     /// isVerboseAsm - Return true if this streamer supports verbose assembly
  71     /// and if it is enabled.
  72     virtual bool isVerboseAsm() const { return false; }
  73
  74     /// hasRawTextSupport - Return true if this asm streamer supports emitting
  75     /// unformatted text to the .s file with EmitRawText.
  76     virtual bool hasRawTextSupport() const { return false; }
  77
  78     /// AddComment - Add a comment that can be emitted to the generated .s
  79     /// file if applicable as a QoI issue to make the output of the compiler
  80     /// more readable.  This only affects the MCAsmStreamer, and only when
  81     /// verbose assembly output is enabled.
  82     ///
  83     /// If the comment includes embedded \n's, they will each get the comment
  84     /// prefix as appropriate.  The added comment should not end with a \n.
  85     virtual void AddComment(const Twine &T) {}
  86
  87     /// GetCommentOS - Return a raw_ostream that comments can be written to.
  88     /// Unlike AddComment, you are required to terminate comments with \n if you
  89     /// use this method.
  90     virtual raw_ostream &GetCommentOS();
  91
  92     /// AddBlankLine - Emit a blank line to a .s file to pretty it up.
  93     virtual void AddBlankLine() {}
  94
  95     /// @}
  96
  97     /// @name Symbol & Section Management
  98     /// @{
  99
 100     /// getCurrentSection - Return the current section that the streamer is
 101     /// emitting code to.
 102     const MCSection *getCurrentSection() const { return CurSection; }
 103
 104     /// getPreviousSection - Return the previous section that the streamer is
 105     /// emitting code to.
 106     const MCSection *getPreviousSection() const { return PrevSection; }
 107
 108     /// SwitchSection - Set the current section where code is being emitted to
 109     /// @p Section.  This is required to update CurSection.
 110     ///
 111     /// This corresponds to assembler directives like .section, .text, etc.
 112     virtual void SwitchSection(const MCSection *Section) = 0;
 113
 114     /// InitSections - Create the default sections and set the initial one.
 115     virtual void InitSections() = 0;
 116
 117     /// EmitLabel - Emit a label for @p Symbol into the current section.
 118     ///
 119     /// This corresponds to an assembler statement such as:
 120     ///   foo:
 121     ///
 122     /// @param Symbol - The symbol to emit. A given symbol should only be
 123     /// emitted as a label once, and symbols emitted as a label should never be
 124     /// used in an assignment.
 125     virtual void EmitLabel(MCSymbol *Symbol) = 0;
 126
 127     /// EmitAssemblerFlag - Note in the output the specified @p Flag
 128     virtual void EmitAssemblerFlag(MCAssemblerFlag Flag) = 0;
 129
 130     /// EmitThumbFunc - Note in the output that the specified @p Func is
 131     /// a Thumb mode function (ARM target only).
 132     virtual void EmitThumbFunc(MCSymbol *Func) = 0;
 133
 134     /// EmitAssignment - Emit an assignment of @p Value to @p Symbol.
 135     ///
 136     /// This corresponds to an assembler statement such as:
 137     ///  symbol = value
 138     ///
 139     /// The assignment generates no code, but has the side effect of binding the
 140     /// value in the current context. For the assembly streamer, this prints the
 141     /// binding into the .s file.
 142     ///
 143     /// @param Symbol - The symbol being assigned to.
 144     /// @param Value - The value for the symbol.
 145     virtual void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) = 0;
 146
 147     /// EmitWeakReference - Emit an weak reference from @p Alias to @p Symbol.
 148     ///
 149     /// This corresponds to an assembler statement such as:
 150     ///  .weakref alias, symbol
 151     ///
 152     /// @param Alias - The alias that is being created.
 153     /// @param Symbol - The symbol being aliased.
 154     virtual void EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol) = 0;
 155
 156     /// EmitSymbolAttribute - Add the given @p Attribute to @p Symbol.
 157     virtual void EmitSymbolAttribute(MCSymbol *Symbol,
 158                                      MCSymbolAttr Attribute) = 0;
 159
 160     /// EmitSymbolDesc - Set the @p DescValue for the @p Symbol.
 161     ///
 162     /// @param Symbol - The symbol to have its n_desc field set.
 163     /// @param DescValue - The value to set into the n_desc field.
 164     virtual void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) = 0;
 165
 166     /// BeginCOFFSymbolDef - Start emitting COFF symbol definition
 167     ///
 168     /// @param Symbol - The symbol to have its External & Type fields set.
 169     virtual void BeginCOFFSymbolDef(const MCSymbol *Symbol) = 0;
 170
 171     /// EmitCOFFSymbolStorageClass - Emit the storage class of the symbol.
 172     ///
 173     /// @param StorageClass - The storage class the symbol should have.
 174     virtual void EmitCOFFSymbolStorageClass(int StorageClass) = 0;
 175
 176     /// EmitCOFFSymbolType - Emit the type of the symbol.
 177     ///
 178     /// @param Type - A COFF type identifier (see COFF::SymbolType in X86COFF.h)
 179     virtual void EmitCOFFSymbolType(int Type) = 0;
 180
 181     /// EndCOFFSymbolDef - Marks the end of the symbol definition.
 182     virtual void EndCOFFSymbolDef() = 0;
 183
 184     /// EmitELFSize - Emit an ELF .size directive.
 185     ///
 186     /// This corresponds to an assembler statement such as:
 187     ///  .size symbol, expression
 188     ///
 189     virtual void EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) = 0;
 190
 191     /// EmitCommonSymbol - Emit a common symbol.
 192     ///
 193     /// @param Symbol - The common symbol to emit.
 194     /// @param Size - The size of the common symbol.
 195     /// @param ByteAlignment - The alignment of the symbol if
 196     /// non-zero. This must be a power of 2.
 197     virtual void EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
 198                                   unsigned ByteAlignment) = 0;
 199
 200     /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
 201     ///
 202     /// @param Symbol - The common symbol to emit.
 203     /// @param Size - The size of the common symbol.
 204     virtual void EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size) = 0;
 205
 206     /// EmitZerofill - Emit the zerofill section and an optional symbol.
 207     ///
 208     /// @param Section - The zerofill section to create and or to put the symbol
 209     /// @param Symbol - The zerofill symbol to emit, if non-NULL.
 210     /// @param Size - The size of the zerofill symbol.
 211     /// @param ByteAlignment - The alignment of the zerofill symbol if
 212     /// non-zero. This must be a power of 2 on some targets.
 213     virtual void EmitZerofill(const MCSection *Section, MCSymbol *Symbol = 0,
 214                               unsigned Size = 0,unsigned ByteAlignment = 0) = 0;
 215
 216     /// EmitTBSSSymbol - Emit a thread local bss (.tbss) symbol.
 217     ///
 218     /// @param Section - The thread local common section.
 219     /// @param Symbol - The thread local common symbol to emit.
 220     /// @param Size - The size of the symbol.
 221     /// @param ByteAlignment - The alignment of the thread local common symbol
 222     /// if non-zero.  This must be a power of 2 on some targets.
 223     virtual void EmitTBSSSymbol(const MCSection *Section, MCSymbol *Symbol,
 224                                 uint64_t Size, unsigned ByteAlignment = 0) = 0;
 225     /// @}
 226     /// @name Generating Data
 227     /// @{
 228
 229     /// EmitBytes - Emit the bytes in \arg Data into the output.
 230     ///
 231     /// This is used to implement assembler directives such as .byte, .ascii,
 232     /// etc.
 233     virtual void EmitBytes(StringRef Data, unsigned AddrSpace) = 0;
 234
 235     /// EmitValue - Emit the expression @p Value into the output as a native
 236     /// integer of the given @p Size bytes.
 237     ///
 238     /// This is used to implement assembler directives such as .word, .quad,
 239     /// etc.
 240     ///
 241     /// @param Value - The value to emit.
 242     /// @param Size - The size of the integer (in bytes) to emit. This must
 243     /// match a native machine width.
 244     virtual void EmitValue(const MCExpr *Value, unsigned Size,
 245                            unsigned AddrSpace = 0) = 0;
 246
 247     /// EmitIntValue - Special case of EmitValue that avoids the client having
 248     /// to pass in a MCExpr for constant integers.
 249     void EmitIntValue(uint64_t Value, unsigned Size, unsigned AddrSpace = 0);
 250
 251
 252     virtual void EmitULEB128Value(const MCExpr *Value,
 253                                   unsigned AddrSpace = 0) = 0;
 254
 255     virtual void EmitSLEB128Value(const MCExpr *Value,
 256                                   unsigned AddrSpace = 0) = 0;
 257
 258     /// EmitULEB128Value - Special case of EmitULEB128Value that avoids the
 259     /// client having to pass in a MCExpr for constant integers.
 260     void EmitULEB128IntValue(uint64_t Value, unsigned AddrSpace = 0);
 261
 262     /// EmitSLEB128Value - Special case of EmitSLEB128Value that avoids the
 263     /// client having to pass in a MCExpr for constant integers.
 264     void EmitSLEB128IntValue(int64_t Value, unsigned AddrSpace = 0);
 265
 266     /// EmitSymbolValue - Special case of EmitValue that avoids the client
 267     /// having to pass in a MCExpr for MCSymbols.
 268     void EmitSymbolValue(const MCSymbol *Sym, unsigned Size,
 269                          unsigned AddrSpace = 0);
 270
 271     /// EmitGPRel32Value - Emit the expression @p Value into the output as a
 272     /// gprel32 (32-bit GP relative) value.
 273     ///
 274     /// This is used to implement assembler directives such as .gprel32 on
 275     /// targets that support them.
 276     virtual void EmitGPRel32Value(const MCExpr *Value);
 277
 278     /// EmitFill - Emit NumBytes bytes worth of the value specified by
 279     /// FillValue.  This implements directives such as '.space'.
 280     virtual void EmitFill(uint64_t NumBytes, uint8_t FillValue,
 281                           unsigned AddrSpace);
 282
 283     /// EmitZeros - Emit NumBytes worth of zeros.  This is a convenience
 284     /// function that just wraps EmitFill.
 285     void EmitZeros(uint64_t NumBytes, unsigned AddrSpace) {
 286       EmitFill(NumBytes, 0, AddrSpace);
 287     }
 288
 289
 290     /// EmitValueToAlignment - Emit some number of copies of @p Value until
 291     /// the byte alignment @p ByteAlignment is reached.
 292     ///
 293     /// If the number of bytes need to emit for the alignment is not a multiple
 294     /// of @p ValueSize, then the contents of the emitted fill bytes is
 295     /// undefined.
 296     ///
 297     /// This used to implement the .align assembler directive.
 298     ///
 299     /// @param ByteAlignment - The alignment to reach. This must be a power of
 300     /// two on some targets.
 301     /// @param Value - The value to use when filling bytes.
 302     /// @param ValueSize - The size of the integer (in bytes) to emit for
 303     /// @p Value. This must match a native machine width.
 304     /// @param MaxBytesToEmit - The maximum numbers of bytes to emit, or 0. If
 305     /// the alignment cannot be reached in this many bytes, no bytes are
 306     /// emitted.
 307     virtual void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
 308                                       unsigned ValueSize = 1,
 309                                       unsigned MaxBytesToEmit = 0) = 0;
 310
 311     /// EmitCodeAlignment - Emit nops until the byte alignment @p ByteAlignment
 312     /// is reached.
 313     ///
 314     /// This used to align code where the alignment bytes may be executed.  This
 315     /// can emit different bytes for different sizes to optimize execution.
 316     ///
 317     /// @param ByteAlignment - The alignment to reach. This must be a power of
 318     /// two on some targets.
 319     /// @param MaxBytesToEmit - The maximum numbers of bytes to emit, or 0. If
 320     /// the alignment cannot be reached in this many bytes, no bytes are
 321     /// emitted.
 322     virtual void EmitCodeAlignment(unsigned ByteAlignment,
 323                                    unsigned MaxBytesToEmit = 0) = 0;
 324
 325     /// EmitValueToOffset - Emit some number of copies of @p Value until the
 326     /// byte offset @p Offset is reached.
 327     ///
 328     /// This is used to implement assembler directives such as .org.
 329     ///
 330     /// @param Offset - The offset to reach. This may be an expression, but the
 331     /// expression must be associated with the current section.
 332     /// @param Value - The value to use when filling bytes.
 333     virtual void EmitValueToOffset(const MCExpr *Offset,
 334                                    unsigned char Value = 0) = 0;
 335
 336     /// @}
 337
 338     /// EmitFileDirective - Switch to a new logical file.  This is used to
 339     /// implement the '.file "foo.c"' assembler directive.
 340     virtual void EmitFileDirective(StringRef Filename) = 0;
 341
 342     /// EmitDwarfFileDirective - Associate a filename with a specified logical
 343     /// file number.  This implements the DWARF2 '.file 4 "foo.c"' assembler
 344     /// directive.
 345     virtual bool EmitDwarfFileDirective(unsigned FileNo,StringRef Filename);
 346
 347     /// EmitDwarfLocDirective - This implements the DWARF2
 348     // '.loc fileno lineno ...' assembler directive.
 349     virtual void EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
 350                                        unsigned Column, unsigned Flags,
 351                                        unsigned Isa,
 352                                        unsigned Discriminator);
 353
 354     virtual bool EmitCFIStartProc();
 355     virtual bool EmitCFIEndProc();
 356     virtual bool EmitCFIDefCfaOffset(int64_t Offset);
 357     virtual bool EmitCFIDefCfaRegister(int64_t Register);
 358     virtual bool EmitCFIOffset(int64_t Register, int64_t Offset);
 359     virtual bool EmitCFIPersonality(const MCSymbol *Sym);
 360     virtual bool EmitCFILsda(const MCSymbol *Sym);
 361
 362     /// EmitInstruction - Emit the given @p Instruction into the current
 363     /// section.
 364     virtual void EmitInstruction(const MCInst &Inst) = 0;
 365
 366     /// EmitRawText - If this file is backed by a assembly streamer, this dumps
 367     /// the specified string in the output .s file.  This capability is
 368     /// indicated by the hasRawTextSupport() predicate.  By default this aborts.
 369     virtual void EmitRawText(StringRef String);
 370     void EmitRawText(const Twine &String);
 371
 372     /// Finish - Finish emission of machine code.
 373     virtual void Finish() = 0;
 374   };
 375
 376   /// createNullStreamer - Create a dummy machine code streamer, which does
 377   /// nothing. This is useful for timing the assembler front end.
 378   MCStreamer *createNullStreamer(MCContext &Ctx);
 379
 380   /// createAsmStreamer - Create a machine code streamer which will print out
 381   /// assembly for the native target, suitable for compiling with a native
 382   /// assembler.
 383   ///
 384   /// \param InstPrint - If given, the instruction printer to use. If not given
 385   /// the MCInst representation will be printed.  This method takes ownership of
 386   /// InstPrint.
 387   ///
 388   /// \param CE - If given, a code emitter to use to show the instruction
 389   /// encoding inline with the assembly. This method takes ownership of \arg CE.
 390   ///
 391   /// \param ShowInst - Whether to show the MCInst representation inline with
 392   /// the assembly.
 393   MCStreamer *createAsmStreamer(MCContext &Ctx, formatted_raw_ostream &OS,
 394                                 bool isLittleEndian, bool isVerboseAsm,
 395                                 MCInstPrinter *InstPrint = 0,
 396                                 MCCodeEmitter *CE = 0,
 397                                 bool ShowInst = false);
 398
 399   MCStreamer *createAsmStreamerNoLoc(MCContext &Ctx, formatted_raw_ostream &OS,
 400                                      bool isLittleEndian, bool isVerboseAsm,
 401                                      const TargetLoweringObjectFile *TLOF,
 402                                      int PointerSize,
 403                                      MCInstPrinter *InstPrint = 0,
 404                                      MCCodeEmitter *CE = 0,
 405                                      bool ShowInst = false);
 406
 407   /// createMachOStreamer - Create a machine code streamer which will generate
 408   /// Mach-O format object files.
 409   ///
 410   /// Takes ownership of \arg TAB and \arg CE.
 411   MCStreamer *createMachOStreamer(MCContext &Ctx, TargetAsmBackend &TAB,
 412                                   raw_ostream &OS, MCCodeEmitter *CE,
 413                                   bool RelaxAll = false);
 414
 415   /// createWinCOFFStreamer - Create a machine code streamer which will
 416   /// generate Microsoft COFF format object files.
 417   ///
 418   /// Takes ownership of \arg TAB and \arg CE.
 419   MCStreamer *createWinCOFFStreamer(MCContext &Ctx,
 420                                     TargetAsmBackend &TAB,
 421                                     MCCodeEmitter &CE, raw_ostream &OS,
 422                                     bool RelaxAll = false);
 423
 424   /// createELFStreamer - Create a machine code streamer which will generate
 425   /// ELF format object files.
 426   MCStreamer *createELFStreamer(MCContext &Ctx, TargetAsmBackend &TAB,
 427                                 raw_ostream &OS, MCCodeEmitter *CE,
 428                                 bool RelaxAll = false);
 429
 430   /// createLoggingStreamer - Create a machine code streamer which just logs the
 431   /// API calls and then dispatches to another streamer.
 432   ///
 433   /// The new streamer takes ownership of the \arg Child.
 434   MCStreamer *createLoggingStreamer(MCStreamer *Child, raw_ostream &OS);
 435
 436   /// createPureStreamer - Create a machine code streamer which will generate
 437   /// "pure" MC object files, for use with MC-JIT and testing tools.
 438   ///
 439   /// Takes ownership of \arg TAB and \arg CE.
 440   MCStreamer *createPureStreamer(MCContext &Ctx, TargetAsmBackend &TAB,
 441                                  raw_ostream &OS, MCCodeEmitter *CE);
 442
 443 } // end namespace llvm
 444
 445 #endif