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/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"
  24 #include <string>
  25
  26 namespace llvm {
  27 class MCAsmBackend;
  28 class MCCodeEmitter;
  29 class MCContext;
  30 class MCExpr;
  31 class MCInst;
  32 class MCInstPrinter;
  33 class MCSection;
  34 class MCStreamer;
  35 class MCSymbol;
  36 class MCSymbolRefExpr;
  37 class MCSubtargetInfo;
  38 class StringRef;
  39 class Twine;
  40 class raw_ostream;
  41 class formatted_raw_ostream;
  42 class AssemblerConstantPools;
  43
  44 typedef std::pair<const MCSection *, const MCExpr *> MCSectionSubPair;
  45
  46 /// Target specific streamer interface. This is used so that targets can
  47 /// implement support for target specific assembly directives.
  48 ///
  49 /// If target foo wants to use this, it should implement 3 classes:
  50 /// * FooTargetStreamer : public MCTargetStreamer
  51 /// * FooTargetAsmSreamer : public FooTargetStreamer
  52 /// * FooTargetELFStreamer : public FooTargetStreamer
  53 ///
  54 /// FooTargetStreamer should have a pure virtual method for each directive. For
  55 /// example, for a ".bar symbol_name" directive, it should have
  56 /// virtual emitBar(const MCSymbol &Symbol) = 0;
  57 ///
  58 /// The FooTargetAsmSreamer and FooTargetELFStreamer classes implement the
  59 /// method. The assembly streamer just prints ".bar symbol_name". The object
  60 /// streamer does whatever is needed to implement .bar in the object file.
  61 ///
  62 /// In the assembly printer and parser the target streamer can be used by
  63 /// calling getTargetStreamer and casting it to FooTargetStreamer:
  64 ///
  65 /// MCTargetStreamer &TS = OutStreamer.getTargetStreamer();
  66 /// FooTargetStreamer &ATS = static_cast<FooTargetStreamer &>(TS);
  67 ///
  68 /// The base classes FooTargetAsmSreamer and FooTargetELFStreamer should *never*
  69 /// be treated differently. Callers should always talk to a FooTargetStreamer.
  70 class MCTargetStreamer {
  71 protected:
  72   MCStreamer &Streamer;
  73
  74 public:
  75   MCTargetStreamer(MCStreamer &S);
  76   virtual ~MCTargetStreamer();
  77
  78   const MCStreamer &getStreamer() { return Streamer; }
  79
  80   // Allow a target to add behavior to the EmitLabel of MCStreamer.
  81   virtual void emitLabel(MCSymbol *Symbol);
  82
  83   virtual void finish();
  84 };
  85
  86 // FIXME: declared here because it is used from
  87 // lib/CodeGen/AsmPrinter/ARMException.cpp.
  88 class ARMTargetStreamer : public MCTargetStreamer {
  89 public:
  90   ARMTargetStreamer(MCStreamer &S);
  91   ~ARMTargetStreamer();
  92
  93   virtual void emitFnStart();
  94   virtual void emitFnEnd();
  95   virtual void emitCantUnwind();
  96   virtual void emitPersonality(const MCSymbol *Personality);
  97   virtual void emitPersonalityIndex(unsigned Index);
  98   virtual void emitHandlerData();
  99   virtual void emitSetFP(unsigned FpReg, unsigned SpReg,
 100                          int64_t Offset = 0);
 101   virtual void emitMovSP(unsigned Reg, int64_t Offset = 0);
 102   virtual void emitPad(int64_t Offset);
 103   virtual void emitRegSave(const SmallVectorImpl<unsigned> &RegList,
 104                            bool isVector);
 105   virtual void emitUnwindRaw(int64_t StackOffset,
 106                              const SmallVectorImpl<uint8_t> &Opcodes);
 107
 108   virtual void switchVendor(StringRef Vendor);
 109   virtual void emitAttribute(unsigned Attribute, unsigned Value);
 110   virtual void emitTextAttribute(unsigned Attribute, StringRef String);
 111   virtual void emitIntTextAttribute(unsigned Attribute, unsigned IntValue,
 112                                     StringRef StringValue = "");
 113   virtual void emitFPU(unsigned FPU);
 114   virtual void emitArch(unsigned Arch);
 115   virtual void emitObjectArch(unsigned Arch);
 116   virtual void finishAttributeSection();
 117   virtual void emitInst(uint32_t Inst, char Suffix = '\0');
 118
 119   virtual void AnnotateTLSDescriptorSequence(const MCSymbolRefExpr *SRE);
 120
 121   void finish() override;
 122
 123   /// Callback used to implement the ldr= pseudo.
 124   /// Add a new entry to the constant pool for the current section and return an
 125   /// MCExpr that can be used to refer to the constant pool location.
 126   const MCExpr *addConstantPoolEntry(const MCExpr *);
 127
 128   /// Callback used to implemnt the .ltorg directive.
 129   /// Emit contents of constant pool for the current section.
 130   void emitCurrentConstantPool();
 131
 132 private:
 133   std::unique_ptr<AssemblerConstantPools> ConstantPools;
 134 };
 135
 136 /// MCStreamer - Streaming machine code generation interface.  This interface
 137 /// is intended to provide a programatic interface that is very similar to the
 138 /// level that an assembler .s file provides.  It has callbacks to emit bytes,
 139 /// handle directives, etc.  The implementation of this interface retains
 140 /// state to know what the current section is etc.
 141 ///
 142 /// There are multiple implementations of this interface: one for writing out
 143 /// a .s file, and implementations that write out .o files of various formats.
 144 ///
 145 class MCStreamer {
 146   MCContext &Context;
 147   std::unique_ptr<MCTargetStreamer> TargetStreamer;
 148
 149   MCStreamer(const MCStreamer &) LLVM_DELETED_FUNCTION;
 150   MCStreamer &operator=(const MCStreamer &) LLVM_DELETED_FUNCTION;
 151
 152   bool EmitEHFrame;
 153   bool EmitDebugFrame;
 154
 155   std::vector<MCDwarfFrameInfo> FrameInfos;
 156   MCDwarfFrameInfo *getCurrentFrameInfo();
 157   MCSymbol *EmitCFICommon();
 158   void EnsureValidFrame();
 159
 160   std::vector<MCWin64EHUnwindInfo *> W64UnwindInfos;
 161   MCWin64EHUnwindInfo *CurrentW64UnwindInfo;
 162   void setCurrentW64UnwindInfo(MCWin64EHUnwindInfo *Frame);
 163   void EnsureValidW64UnwindInfo();
 164
 165   MCSymbol *LastSymbol;
 166
 167   // SymbolOrdering - Tracks an index to represent the order
 168   // a symbol was emitted in. Zero means we did not emit that symbol.
 169   DenseMap<const MCSymbol *, unsigned> SymbolOrdering;
 170
 171   /// SectionStack - This is stack of current and previous section
 172   /// values saved by PushSection.
 173   SmallVector<std::pair<MCSectionSubPair, MCSectionSubPair>, 4> SectionStack;
 174
 175 protected:
 176   MCStreamer(MCContext &Ctx);
 177
 178   const MCExpr *BuildSymbolDiff(MCContext &Context, const MCSymbol *A,
 179                                 const MCSymbol *B);
 180
 181   const MCExpr *ForceExpAbs(const MCExpr *Expr);
 182
 183   void RecordProcStart(MCDwarfFrameInfo &Frame);
 184   virtual void EmitCFIStartProcImpl(MCDwarfFrameInfo &Frame);
 185   void RecordProcEnd(MCDwarfFrameInfo &Frame);
 186   virtual void EmitCFIEndProcImpl(MCDwarfFrameInfo &CurFrame);
 187   void EmitFrames(MCAsmBackend *MAB, bool usingCFI);
 188
 189   MCWin64EHUnwindInfo *getCurrentW64UnwindInfo() {
 190     return CurrentW64UnwindInfo;
 191   }
 192   void EmitW64Tables();
 193
 194   virtual void EmitRawTextImpl(StringRef String);
 195
 196 public:
 197   virtual ~MCStreamer();
 198
 199   void setTargetStreamer(MCTargetStreamer *TS) {
 200     TargetStreamer.reset(TS);
 201   }
 202
 203   /// State management
 204   ///
 205   virtual void reset();
 206
 207   MCContext &getContext() const { return Context; }
 208
 209   MCTargetStreamer *getTargetStreamer() {
 210     return TargetStreamer.get();
 211   }
 212
 213   unsigned getNumFrameInfos() { return FrameInfos.size(); }
 214
 215   const MCDwarfFrameInfo &getFrameInfo(unsigned i) { return FrameInfos[i]; }
 216
 217   ArrayRef<MCDwarfFrameInfo> getFrameInfos() const { return FrameInfos; }
 218
 219   unsigned getNumW64UnwindInfos() { return W64UnwindInfos.size(); }
 220
 221   MCWin64EHUnwindInfo &getW64UnwindInfo(unsigned i) {
 222     return *W64UnwindInfos[i];
 223   }
 224
 225   void generateCompactUnwindEncodings(MCAsmBackend *MAB);
 226
 227   /// @name Assembly File Formatting.
 228   /// @{
 229
 230   /// isVerboseAsm - Return true if this streamer supports verbose assembly
 231   /// and if it is enabled.
 232   virtual bool isVerboseAsm() const { return false; }
 233
 234   /// hasRawTextSupport - Return true if this asm streamer supports emitting
 235   /// unformatted text to the .s file with EmitRawText.
 236   virtual bool hasRawTextSupport() const { return false; }
 237
 238   /// Is the integrated assembler required for this streamer to function
 239   /// correctly?
 240   virtual bool isIntegratedAssemblerRequired() const { return false; }
 241
 242   /// AddComment - Add a comment that can be emitted to the generated .s
 243   /// file if applicable as a QoI issue to make the output of the compiler
 244   /// more readable.  This only affects the MCAsmStreamer, and only when
 245   /// verbose assembly output is enabled.
 246   ///
 247   /// If the comment includes embedded \n's, they will each get the comment
 248   /// prefix as appropriate.  The added comment should not end with a \n.
 249   virtual void AddComment(const Twine &T) {}
 250
 251   /// GetCommentOS - Return a raw_ostream that comments can be written to.
 252   /// Unlike AddComment, you are required to terminate comments with \n if you
 253   /// use this method.
 254   virtual raw_ostream &GetCommentOS();
 255
 256   /// Print T and prefix it with the comment string (normally #) and optionally
 257   /// a tab. This prints the comment immediately, not at the end of the
 258   /// current line. It is basically a safe version of EmitRawText: since it
 259   /// only prints comments, the object streamer ignores it instead of asserting.
 260   virtual void emitRawComment(const Twine &T, bool TabPrefix = true);
 261
 262   /// AddBlankLine - Emit a blank line to a .s file to pretty it up.
 263   virtual void AddBlankLine() {}
 264
 265   /// @}
 266
 267   /// @name Symbol & Section Management
 268   /// @{
 269
 270   /// getCurrentSection - Return the current section that the streamer is
 271   /// emitting code to.
 272   MCSectionSubPair getCurrentSection() const {
 273     if (!SectionStack.empty())
 274       return SectionStack.back().first;
 275     return MCSectionSubPair();
 276   }
 277
 278   /// getPreviousSection - Return the previous section that the streamer is
 279   /// emitting code to.
 280   MCSectionSubPair getPreviousSection() const {
 281     if (!SectionStack.empty())
 282       return SectionStack.back().second;
 283     return MCSectionSubPair();
 284   }
 285
 286   /// GetSymbolOrder - Returns an index to represent the order
 287   /// a symbol was emitted in. (zero if we did not emit that symbol)
 288   unsigned GetSymbolOrder(const MCSymbol *Sym) const {
 289     return SymbolOrdering.lookup(Sym);
 290   }
 291
 292   /// ChangeSection - Update streamer for a new active section.
 293   ///
 294   /// This is called by PopSection and SwitchSection, if the current
 295   /// section changes.
 296   virtual void ChangeSection(const MCSection *, const MCExpr *) = 0;
 297
 298   /// pushSection - Save the current and previous section on the
 299   /// section stack.
 300   void PushSection() {
 301     SectionStack.push_back(
 302         std::make_pair(getCurrentSection(), getPreviousSection()));
 303   }
 304
 305   /// popSection - Restore the current and previous section from
 306   /// the section stack.  Calls ChangeSection as needed.
 307   ///
 308   /// Returns false if the stack was empty.
 309   bool PopSection() {
 310     if (SectionStack.size() <= 1)
 311       return false;
 312     MCSectionSubPair oldSection = SectionStack.pop_back_val().first;
 313     MCSectionSubPair curSection = SectionStack.back().first;
 314
 315     if (oldSection != curSection)
 316       ChangeSection(curSection.first, curSection.second);
 317     return true;
 318   }
 319
 320   bool SubSection(const MCExpr *Subsection) {
 321     if (SectionStack.empty())
 322       return false;
 323
 324     SwitchSection(SectionStack.back().first.first, Subsection);
 325     return true;
 326   }
 327
 328   /// SwitchSection - Set the current section where code is being emitted to
 329   /// @p Section.  This is required to update CurSection.
 330   ///
 331   /// This corresponds to assembler directives like .section, .text, etc.
 332   void SwitchSection(const MCSection *Section, const MCExpr *Subsection = 0) {
 333     assert(Section && "Cannot switch to a null section!");
 334     MCSectionSubPair curSection = SectionStack.back().first;
 335     SectionStack.back().second = curSection;
 336     if (MCSectionSubPair(Section, Subsection) != curSection) {
 337       SectionStack.back().first = MCSectionSubPair(Section, Subsection);
 338       ChangeSection(Section, Subsection);
 339     }
 340   }
 341
 342   /// SwitchSectionNoChange - Set the current section where code is being
 343   /// emitted to @p Section.  This is required to update CurSection. This
 344   /// version does not call ChangeSection.
 345   void SwitchSectionNoChange(const MCSection *Section,
 346                              const MCExpr *Subsection = 0) {
 347     assert(Section && "Cannot switch to a null section!");
 348     MCSectionSubPair curSection = SectionStack.back().first;
 349     SectionStack.back().second = curSection;
 350     if (MCSectionSubPair(Section, Subsection) != curSection)
 351       SectionStack.back().first = MCSectionSubPair(Section, Subsection);
 352   }
 353
 354   /// Create the default sections and set the initial one.
 355   virtual void InitSections();
 356
 357   /// AssignSection - Sets the symbol's section.
 358   ///
 359   /// Each emitted symbol will be tracked in the ordering table,
 360   /// so we can sort on them later.
 361   void AssignSection(MCSymbol *Symbol, const MCSection *Section);
 362
 363   /// EmitLabel - Emit a label for @p Symbol into the current section.
 364   ///
 365   /// This corresponds to an assembler statement such as:
 366   ///   foo:
 367   ///
 368   /// @param Symbol - The symbol to emit. A given symbol should only be
 369   /// emitted as a label once, and symbols emitted as a label should never be
 370   /// used in an assignment.
 371   // FIXME: These emission are non-const because we mutate the symbol to
 372   // add the section we're emitting it to later.
 373   virtual void EmitLabel(MCSymbol *Symbol);
 374
 375   virtual void EmitDebugLabel(MCSymbol *Symbol);
 376
 377   virtual void EmitEHSymAttributes(const MCSymbol *Symbol, MCSymbol *EHSymbol);
 378
 379   /// EmitAssemblerFlag - Note in the output the specified @p Flag.
 380   virtual void EmitAssemblerFlag(MCAssemblerFlag Flag) = 0;
 381
 382   /// EmitLinkerOptions - Emit the given list @p Options of strings as linker
 383   /// options into the output.
 384   virtual void EmitLinkerOptions(ArrayRef<std::string> Kind) {}
 385
 386   /// EmitDataRegion - Note in the output the specified region @p Kind.
 387   virtual void EmitDataRegion(MCDataRegionType Kind) {}
 388
 389   /// EmitVersionMin - Specify the MachO minimum deployment target version.
 390   virtual void EmitVersionMin(MCVersionMinType, unsigned Major, unsigned Minor,
 391                               unsigned Update) {}
 392
 393   /// EmitThumbFunc - Note in the output that the specified @p Func is
 394   /// a Thumb mode function (ARM target only).
 395   virtual void EmitThumbFunc(MCSymbol *Func) = 0;
 396
 397   /// getOrCreateSymbolData - Get symbol data for given symbol.
 398   virtual MCSymbolData &getOrCreateSymbolData(MCSymbol *Symbol);
 399
 400   /// EmitAssignment - Emit an assignment of @p Value to @p Symbol.
 401   ///
 402   /// This corresponds to an assembler statement such as:
 403   ///  symbol = value
 404   ///
 405   /// The assignment generates no code, but has the side effect of binding the
 406   /// value in the current context. For the assembly streamer, this prints the
 407   /// binding into the .s file.
 408   ///
 409   /// @param Symbol - The symbol being assigned to.
 410   /// @param Value - The value for the symbol.
 411   virtual void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) = 0;
 412
 413   /// EmitWeakReference - Emit an weak reference from @p Alias to @p Symbol.
 414   ///
 415   /// This corresponds to an assembler statement such as:
 416   ///  .weakref alias, symbol
 417   ///
 418   /// @param Alias - The alias that is being created.
 419   /// @param Symbol - The symbol being aliased.
 420   virtual void EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol) = 0;
 421
 422   /// EmitSymbolAttribute - Add the given @p Attribute to @p Symbol.
 423   virtual bool EmitSymbolAttribute(MCSymbol *Symbol,
 424                                    MCSymbolAttr Attribute) = 0;
 425
 426   /// EmitSymbolDesc - Set the @p DescValue for the @p Symbol.
 427   ///
 428   /// @param Symbol - The symbol to have its n_desc field set.
 429   /// @param DescValue - The value to set into the n_desc field.
 430   virtual void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) = 0;
 431
 432   /// BeginCOFFSymbolDef - Start emitting COFF symbol definition
 433   ///
 434   /// @param Symbol - The symbol to have its External & Type fields set.
 435   virtual void BeginCOFFSymbolDef(const MCSymbol *Symbol) = 0;
 436
 437   /// EmitCOFFSymbolStorageClass - Emit the storage class of the symbol.
 438   ///
 439   /// @param StorageClass - The storage class the symbol should have.
 440   virtual void EmitCOFFSymbolStorageClass(int StorageClass) = 0;
 441
 442   /// EmitCOFFSymbolType - Emit the type of the symbol.
 443   ///
 444   /// @param Type - A COFF type identifier (see COFF::SymbolType in X86COFF.h)
 445   virtual void EmitCOFFSymbolType(int Type) = 0;
 446
 447   /// EndCOFFSymbolDef - Marks the end of the symbol definition.
 448   virtual void EndCOFFSymbolDef() = 0;
 449
 450   /// EmitCOFFSectionIndex - Emits a COFF section index.
 451   ///
 452   /// @param Symbol - Symbol the section number relocation should point to.
 453   virtual void EmitCOFFSectionIndex(MCSymbol const *Symbol);
 454
 455   /// EmitCOFFSecRel32 - Emits a COFF section relative relocation.
 456   ///
 457   /// @param Symbol - Symbol the section relative relocation should point to.
 458   virtual void EmitCOFFSecRel32(MCSymbol const *Symbol);
 459
 460   /// EmitELFSize - Emit an ELF .size directive.
 461   ///
 462   /// This corresponds to an assembler statement such as:
 463   ///  .size symbol, expression
 464   ///
 465   virtual void EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) = 0;
 466
 467   /// EmitCommonSymbol - Emit a common symbol.
 468   ///
 469   /// @param Symbol - The common symbol to emit.
 470   /// @param Size - The size of the common symbol.
 471   /// @param ByteAlignment - The alignment of the symbol if
 472   /// non-zero. This must be a power of 2.
 473   virtual void EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
 474                                 unsigned ByteAlignment) = 0;
 475
 476   /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
 477   ///
 478   /// @param Symbol - The common symbol to emit.
 479   /// @param Size - The size of the common symbol.
 480   /// @param ByteAlignment - The alignment of the common symbol in bytes.
 481   virtual void EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size,
 482                                      unsigned ByteAlignment) = 0;
 483
 484   /// EmitZerofill - Emit the zerofill section and an optional symbol.
 485   ///
 486   /// @param Section - The zerofill section to create and or to put the symbol
 487   /// @param Symbol - The zerofill symbol to emit, if non-NULL.
 488   /// @param Size - The size of the zerofill symbol.
 489   /// @param ByteAlignment - The alignment of the zerofill symbol if
 490   /// non-zero. This must be a power of 2 on some targets.
 491   virtual void EmitZerofill(const MCSection *Section, MCSymbol *Symbol = 0,
 492                             uint64_t Size = 0, unsigned ByteAlignment = 0) = 0;
 493
 494   /// EmitTBSSSymbol - Emit a thread local bss (.tbss) symbol.
 495   ///
 496   /// @param Section - The thread local common section.
 497   /// @param Symbol - The thread local common symbol to emit.
 498   /// @param Size - The size of the symbol.
 499   /// @param ByteAlignment - The alignment of the thread local common symbol
 500   /// if non-zero.  This must be a power of 2 on some targets.
 501   virtual void EmitTBSSSymbol(const MCSection *Section, MCSymbol *Symbol,
 502                               uint64_t Size, unsigned ByteAlignment = 0) = 0;
 503
 504   /// @}
 505   /// @name Generating Data
 506   /// @{
 507
 508   /// EmitBytes - Emit the bytes in \p Data into the output.
 509   ///
 510   /// This is used to implement assembler directives such as .byte, .ascii,
 511   /// etc.
 512   virtual void EmitBytes(StringRef Data) = 0;
 513
 514   /// EmitValue - Emit the expression @p Value into the output as a native
 515   /// integer of the given @p Size bytes.
 516   ///
 517   /// This is used to implement assembler directives such as .word, .quad,
 518   /// etc.
 519   ///
 520   /// @param Value - The value to emit.
 521   /// @param Size - The size of the integer (in bytes) to emit. This must
 522   /// match a native machine width.
 523   virtual void EmitValueImpl(const MCExpr *Value, unsigned Size) = 0;
 524
 525   void EmitValue(const MCExpr *Value, unsigned Size);
 526
 527   /// EmitIntValue - Special case of EmitValue that avoids the client having
 528   /// to pass in a MCExpr for constant integers.
 529   virtual void EmitIntValue(uint64_t Value, unsigned Size);
 530
 531   /// EmitAbsValue - Emit the Value, but try to avoid relocations. On MachO
 532   /// this is done by producing
 533   /// foo = value
 534   /// .long foo
 535   void EmitAbsValue(const MCExpr *Value, unsigned Size);
 536
 537   virtual void EmitULEB128Value(const MCExpr *Value) = 0;
 538
 539   virtual void EmitSLEB128Value(const MCExpr *Value) = 0;
 540
 541   /// EmitULEB128Value - Special case of EmitULEB128Value that avoids the
 542   /// client having to pass in a MCExpr for constant integers.
 543   void EmitULEB128IntValue(uint64_t Value, unsigned Padding = 0);
 544
 545   /// EmitSLEB128Value - Special case of EmitSLEB128Value that avoids the
 546   /// client having to pass in a MCExpr for constant integers.
 547   void EmitSLEB128IntValue(int64_t Value);
 548
 549   /// EmitSymbolValue - Special case of EmitValue that avoids the client
 550   /// having to pass in a MCExpr for MCSymbols.
 551   void EmitSymbolValue(const MCSymbol *Sym, unsigned Size);
 552
 553   /// EmitGPRel64Value - Emit the expression @p Value into the output as a
 554   /// gprel64 (64-bit GP relative) value.
 555   ///
 556   /// This is used to implement assembler directives such as .gpdword on
 557   /// targets that support them.
 558   virtual void EmitGPRel64Value(const MCExpr *Value);
 559
 560   /// EmitGPRel32Value - Emit the expression @p Value into the output as a
 561   /// gprel32 (32-bit GP relative) value.
 562   ///
 563   /// This is used to implement assembler directives such as .gprel32 on
 564   /// targets that support them.
 565   virtual void EmitGPRel32Value(const MCExpr *Value);
 566
 567   /// EmitFill - Emit NumBytes bytes worth of the value specified by
 568   /// FillValue.  This implements directives such as '.space'.
 569   virtual void EmitFill(uint64_t NumBytes, uint8_t FillValue);
 570
 571   /// \brief Emit NumBytes worth of zeros.
 572   /// This function properly handles data in virtual sections.
 573   virtual void EmitZeros(uint64_t NumBytes);
 574
 575   /// EmitValueToAlignment - Emit some number of copies of @p Value until
 576   /// the byte alignment @p ByteAlignment is reached.
 577   ///
 578   /// If the number of bytes need to emit for the alignment is not a multiple
 579   /// of @p ValueSize, then the contents of the emitted fill bytes is
 580   /// undefined.
 581   ///
 582   /// This used to implement the .align assembler directive.
 583   ///
 584   /// @param ByteAlignment - The alignment to reach. This must be a power of
 585   /// two on some targets.
 586   /// @param Value - The value to use when filling bytes.
 587   /// @param ValueSize - The size of the integer (in bytes) to emit for
 588   /// @p Value. This must match a native machine width.
 589   /// @param MaxBytesToEmit - The maximum numbers of bytes to emit, or 0. If
 590   /// the alignment cannot be reached in this many bytes, no bytes are
 591   /// emitted.
 592   virtual void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
 593                                     unsigned ValueSize = 1,
 594                                     unsigned MaxBytesToEmit = 0) = 0;
 595
 596   /// EmitCodeAlignment - Emit nops until the byte alignment @p ByteAlignment
 597   /// is reached.
 598   ///
 599   /// This used to align code where the alignment bytes may be executed.  This
 600   /// can emit different bytes for different sizes to optimize execution.
 601   ///
 602   /// @param ByteAlignment - The alignment to reach. This must be a power of
 603   /// two on some targets.
 604   /// @param MaxBytesToEmit - The maximum numbers of bytes to emit, or 0. If
 605   /// the alignment cannot be reached in this many bytes, no bytes are
 606   /// emitted.
 607   virtual void EmitCodeAlignment(unsigned ByteAlignment,
 608                                  unsigned MaxBytesToEmit = 0) = 0;
 609
 610   /// EmitValueToOffset - Emit some number of copies of @p Value until the
 611   /// byte offset @p Offset is reached.
 612   ///
 613   /// This is used to implement assembler directives such as .org.
 614   ///
 615   /// @param Offset - The offset to reach. This may be an expression, but the
 616   /// expression must be associated with the current section.
 617   /// @param Value - The value to use when filling bytes.
 618   /// @return false on success, true if the offset was invalid.
 619   virtual bool EmitValueToOffset(const MCExpr *Offset,
 620                                  unsigned char Value = 0) = 0;
 621
 622   /// @}
 623
 624   /// EmitFileDirective - Switch to a new logical file.  This is used to
 625   /// implement the '.file "foo.c"' assembler directive.
 626   virtual void EmitFileDirective(StringRef Filename) = 0;
 627
 628   /// Emit the "identifiers" directive.  This implements the
 629   /// '.ident "version foo"' assembler directive.
 630   virtual void EmitIdent(StringRef IdentString) {}
 631
 632   /// EmitDwarfFileDirective - Associate a filename with a specified logical
 633   /// file number.  This implements the DWARF2 '.file 4 "foo.c"' assembler
 634   /// directive.
 635   virtual unsigned EmitDwarfFileDirective(unsigned FileNo, StringRef Directory,
 636                                           StringRef Filename,
 637                                           unsigned CUID = 0);
 638
 639   /// EmitDwarfLocDirective - This implements the DWARF2
 640   // '.loc fileno lineno ...' assembler directive.
 641   virtual void EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
 642                                      unsigned Column, unsigned Flags,
 643                                      unsigned Isa, unsigned Discriminator,
 644                                      StringRef FileName);
 645
 646   virtual void EmitDwarfAdvanceLineAddr(int64_t LineDelta,
 647                                         const MCSymbol *LastLabel,
 648                                         const MCSymbol *Label,
 649                                         unsigned PointerSize) = 0;
 650
 651   virtual void EmitDwarfAdvanceFrameAddr(const MCSymbol *LastLabel,
 652                                          const MCSymbol *Label) {}
 653
 654   void EmitDwarfSetLineAddr(int64_t LineDelta, const MCSymbol *Label,
 655                             int PointerSize);
 656
 657   virtual void EmitCompactUnwindEncoding(uint32_t CompactUnwindEncoding);
 658   virtual void EmitCFISections(bool EH, bool Debug);
 659   void EmitCFIStartProc(bool IsSimple);
 660   void EmitCFIEndProc();
 661   virtual void EmitCFIDefCfa(int64_t Register, int64_t Offset);
 662   virtual void EmitCFIDefCfaOffset(int64_t Offset);
 663   virtual void EmitCFIDefCfaRegister(int64_t Register);
 664   virtual void EmitCFIOffset(int64_t Register, int64_t Offset);
 665   virtual void EmitCFIPersonality(const MCSymbol *Sym, unsigned Encoding);
 666   virtual void EmitCFILsda(const MCSymbol *Sym, unsigned Encoding);
 667   virtual void EmitCFIRememberState();
 668   virtual void EmitCFIRestoreState();
 669   virtual void EmitCFISameValue(int64_t Register);
 670   virtual void EmitCFIRestore(int64_t Register);
 671   virtual void EmitCFIRelOffset(int64_t Register, int64_t Offset);
 672   virtual void EmitCFIAdjustCfaOffset(int64_t Adjustment);
 673   virtual void EmitCFIEscape(StringRef Values);
 674   virtual void EmitCFISignalFrame();
 675   virtual void EmitCFIUndefined(int64_t Register);
 676   virtual void EmitCFIRegister(int64_t Register1, int64_t Register2);
 677   virtual void EmitCFIWindowSave();
 678
 679   virtual void EmitWin64EHStartProc(const MCSymbol *Symbol);
 680   virtual void EmitWin64EHEndProc();
 681   virtual void EmitWin64EHStartChained();
 682   virtual void EmitWin64EHEndChained();
 683   virtual void EmitWin64EHHandler(const MCSymbol *Sym, bool Unwind,
 684                                   bool Except);
 685   virtual void EmitWin64EHHandlerData();
 686   virtual void EmitWin64EHPushReg(unsigned Register);
 687   virtual void EmitWin64EHSetFrame(unsigned Register, unsigned Offset);
 688   virtual void EmitWin64EHAllocStack(unsigned Size);
 689   virtual void EmitWin64EHSaveReg(unsigned Register, unsigned Offset);
 690   virtual void EmitWin64EHSaveXMM(unsigned Register, unsigned Offset);
 691   virtual void EmitWin64EHPushFrame(bool Code);
 692   virtual void EmitWin64EHEndProlog();
 693
 694   /// EmitInstruction - Emit the given @p Instruction into the current
 695   /// section.
 696   virtual void EmitInstruction(const MCInst &Inst, const MCSubtargetInfo &STI) = 0;
 697
 698   /// \brief Set the bundle alignment mode from now on in the section.
 699   /// The argument is the power of 2 to which the alignment is set. The
 700   /// value 0 means turn the bundle alignment off.
 701   virtual void EmitBundleAlignMode(unsigned AlignPow2) = 0;
 702
 703   /// \brief The following instructions are a bundle-locked group.
 704   ///
 705   /// \param AlignToEnd - If true, the bundle-locked group will be aligned to
 706   ///                     the end of a bundle.
 707   virtual void EmitBundleLock(bool AlignToEnd) = 0;
 708
 709   /// \brief Ends a bundle-locked group.
 710   virtual void EmitBundleUnlock() = 0;
 711
 712   /// EmitRawText - If this file is backed by a assembly streamer, this dumps
 713   /// the specified string in the output .s file.  This capability is
 714   /// indicated by the hasRawTextSupport() predicate.  By default this aborts.
 715   void EmitRawText(const Twine &String);
 716
 717   /// Flush - Causes any cached state to be written out.
 718   virtual void Flush() {}
 719
 720   /// FinishImpl - Streamer specific finalization.
 721   virtual void FinishImpl() = 0;
 722   /// Finish - Finish emission of machine code.
 723   void Finish();
 724 };
 725
 726 /// createNullStreamer - Create a dummy machine code streamer, which does
 727 /// nothing. This is useful for timing the assembler front end.
 728 MCStreamer *createNullStreamer(MCContext &Ctx);
 729
 730 /// createAsmStreamer - Create a machine code streamer which will print out
 731 /// assembly for the native target, suitable for compiling with a native
 732 /// assembler.
 733 ///
 734 /// \param InstPrint - If given, the instruction printer to use. If not given
 735 /// the MCInst representation will be printed.  This method takes ownership of
 736 /// InstPrint.
 737 ///
 738 /// \param CE - If given, a code emitter to use to show the instruction
 739 /// encoding inline with the assembly. This method takes ownership of \p CE.
 740 ///
 741 /// \param TAB - If given, a target asm backend to use to show the fixup
 742 /// information in conjunction with encoding information. This method takes
 743 /// ownership of \p TAB.
 744 ///
 745 /// \param ShowInst - Whether to show the MCInst representation inline with
 746 /// the assembly.
 747 MCStreamer *createAsmStreamer(MCContext &Ctx, formatted_raw_ostream &OS,
 748                               bool isVerboseAsm, bool useCFI,
 749                               bool useDwarfDirectory, MCInstPrinter *InstPrint,
 750                               MCCodeEmitter *CE, MCAsmBackend *TAB,
 751                               bool ShowInst);
 752
 753 /// createMachOStreamer - Create a machine code streamer which will generate
 754 /// Mach-O format object files.
 755 ///
 756 /// Takes ownership of \p TAB and \p CE.
 757 MCStreamer *createMachOStreamer(MCContext &Ctx, MCAsmBackend &TAB,
 758                                 raw_ostream &OS, MCCodeEmitter *CE,
 759                                 bool RelaxAll = false);
 760
 761 /// createWinCOFFStreamer - Create a machine code streamer which will
 762 /// generate Microsoft COFF format object files.
 763 ///
 764 /// Takes ownership of \p TAB and \p CE.
 765 MCStreamer *createWinCOFFStreamer(MCContext &Ctx, MCAsmBackend &TAB,
 766                                   MCCodeEmitter &CE, raw_ostream &OS,
 767                                   bool RelaxAll = false);
 768
 769 /// createELFStreamer - Create a machine code streamer which will generate
 770 /// ELF format object files.
 771 MCStreamer *createELFStreamer(MCContext &Ctx, MCAsmBackend &TAB,
 772                               raw_ostream &OS, MCCodeEmitter *CE, bool RelaxAll,
 773                               bool NoExecStack);
 774
 775 } // end namespace llvm
 776
 777 #endif