include/llvm/CodeGen/AsmPrinter.h

   1 //===-- llvm/CodeGen/AsmPrinter.h - AsmPrinter Framework --------*- 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 contains a class to be used as the base class for target specific
  11 // asm writers.  This class primarily handles common functionality used by
  12 // all asm writers.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_CODEGEN_ASMPRINTER_H
  17 #define LLVM_CODEGEN_ASMPRINTER_H
  18
  19 #include "llvm/ADT/Twine.h"
  20 #include "llvm/CodeGen/MachineFunctionPass.h"
  21 #include "llvm/IR/InlineAsm.h"
  22 #include "llvm/Support/DataTypes.h"
  23 #include "llvm/Support/ErrorHandling.h"
  24
  25 namespace llvm {
  26 class AsmPrinterHandler;
  27 class BlockAddress;
  28 class ByteStreamer;
  29 class GCStrategy;
  30 class Constant;
  31 class ConstantArray;
  32 class GCMetadataPrinter;
  33 class GlobalValue;
  34 class GlobalVariable;
  35 class MachineBasicBlock;
  36 class MachineFunction;
  37 class MachineInstr;
  38 class MachineLocation;
  39 class MachineLoopInfo;
  40 class MachineLoop;
  41 class MachineConstantPoolValue;
  42 class MachineJumpTableInfo;
  43 class MachineModuleInfo;
  44 class MCAsmInfo;
  45 class MCCFIInstruction;
  46 class MCContext;
  47 class MCExpr;
  48 class MCInst;
  49 class MCSection;
  50 class MCStreamer;
  51 class MCSubtargetInfo;
  52 class MCSymbol;
  53 class MDNode;
  54 class DwarfDebug;
  55 class Mangler;
  56 class TargetLoweringObjectFile;
  57 class DataLayout;
  58 class TargetMachine;
  59
  60 /// This class is intended to be used as a driving class for all asm writers.
  61 class AsmPrinter : public MachineFunctionPass {
  62 public:
  63   /// Target machine description.
  64   ///
  65   TargetMachine &TM;
  66
  67   /// Target Asm Printer information.
  68   ///
  69   const MCAsmInfo *MAI;
  70
  71   /// This is the context for the output file that we are streaming. This owns
  72   /// all of the global MC-related objects for the generated translation unit.
  73   MCContext &OutContext;
  74
  75   /// This is the MCStreamer object for the file we are generating. This
  76   /// contains the transient state for the current translation unit that we are
  77   /// generating (such as the current section etc).
  78   MCStreamer &OutStreamer;
  79
  80   /// The current machine function.
  81   const MachineFunction *MF;
  82
  83   /// This is a pointer to the current MachineModuleInfo.
  84   MachineModuleInfo *MMI;
  85
  86   /// Name-mangler for global names.
  87   ///
  88   Mangler *Mang;
  89
  90   /// The symbol for the current function. This is recalculated at the beginning
  91   /// of each call to runOnMachineFunction().
  92   ///
  93   MCSymbol *CurrentFnSym;
  94
  95   /// The symbol used to represent the start of the current function for the
  96   /// purpose of calculating its size (e.g. using the .size directive). By
  97   /// default, this is equal to CurrentFnSym.
  98   MCSymbol *CurrentFnSymForSize;
  99
 100 private:
 101   // The garbage collection metadata printer table.
 102   void *GCMetadataPrinters; // Really a DenseMap.
 103
 104   /// Emit comments in assembly output if this is true.
 105   ///
 106   bool VerboseAsm;
 107   static char ID;
 108
 109   /// If VerboseAsm is set, a pointer to the loop info for this function.
 110   MachineLoopInfo *LI;
 111
 112   struct HandlerInfo {
 113     AsmPrinterHandler *Handler;
 114     const char *TimerName, *TimerGroupName;
 115     HandlerInfo(AsmPrinterHandler *Handler, const char *TimerName,
 116                 const char *TimerGroupName)
 117         : Handler(Handler), TimerName(TimerName),
 118           TimerGroupName(TimerGroupName) {}
 119   };
 120   /// A vector of all debug/EH info emitters we should use. This vector
 121   /// maintains ownership of the emitters.
 122   SmallVector<HandlerInfo, 1> Handlers;
 123
 124   /// If the target supports dwarf debug info, this pointer is non-null.
 125   DwarfDebug *DD;
 126
 127 protected:
 128   explicit AsmPrinter(TargetMachine &TM, std::unique_ptr<MCStreamer> Streamer);
 129
 130 public:
 131   virtual ~AsmPrinter();
 132
 133   DwarfDebug *getDwarfDebug() { return DD; }
 134   DwarfDebug *getDwarfDebug() const { return DD; }
 135
 136   /// Return true if assembly output should contain comments.
 137   ///
 138   bool isVerbose() const { return VerboseAsm; }
 139
 140   /// Return a unique ID for the current function.
 141   ///
 142   unsigned getFunctionNumber() const;
 143
 144   /// Return information about object file lowering.
 145   const TargetLoweringObjectFile &getObjFileLowering() const;
 146
 147   /// Return information about data layout.
 148   const DataLayout &getDataLayout() const;
 149
 150   /// Return information about subtarget.
 151   const MCSubtargetInfo &getSubtargetInfo() const;
 152
 153   void EmitToStreamer(MCStreamer &S, const MCInst &Inst);
 154
 155   /// Return the target triple string.
 156   StringRef getTargetTriple() const;
 157
 158   /// Return the current section we are emitting to.
 159   const MCSection *getCurrentSection() const;
 160
 161   void getNameWithPrefix(SmallVectorImpl<char> &Name,
 162                          const GlobalValue *GV) const;
 163
 164   MCSymbol *getSymbol(const GlobalValue *GV) const;
 165
 166   //===------------------------------------------------------------------===//
 167   // MachineFunctionPass Implementation.
 168   //===------------------------------------------------------------------===//
 169
 170   /// Record analysis usage.
 171   ///
 172   void getAnalysisUsage(AnalysisUsage &AU) const override;
 173
 174   /// Set up the AsmPrinter when we are working on a new module. If your pass
 175   /// overrides this, it must make sure to explicitly call this implementation.
 176   bool doInitialization(Module &M) override;
 177
 178   /// Shut down the asmprinter. If you override this in your pass, you must make
 179   /// sure to call it explicitly.
 180   bool doFinalization(Module &M) override;
 181
 182   /// Emit the specified function out to the OutStreamer.
 183   bool runOnMachineFunction(MachineFunction &MF) override {
 184     SetupMachineFunction(MF);
 185     EmitFunctionHeader();
 186     EmitFunctionBody();
 187     return false;
 188   }
 189
 190   //===------------------------------------------------------------------===//
 191   // Coarse grained IR lowering routines.
 192   //===------------------------------------------------------------------===//
 193
 194   /// This should be called when a new MachineFunction is being processed from
 195   /// runOnMachineFunction.
 196   void SetupMachineFunction(MachineFunction &MF);
 197
 198   /// This method emits the header for the current function.
 199   void EmitFunctionHeader();
 200
 201   /// This method emits the body and trailer for a function.
 202   void EmitFunctionBody();
 203
 204   void emitCFIInstruction(const MachineInstr &MI);
 205
 206   void emitFrameAlloc(const MachineInstr &MI);
 207
 208   enum CFIMoveType { CFI_M_None, CFI_M_EH, CFI_M_Debug };
 209   CFIMoveType needsCFIMoves();
 210
 211   bool needsSEHMoves();
 212
 213   /// Print to the current output stream assembly representations of the
 214   /// constants in the constant pool MCP. This is used to print out constants
 215   /// which have been "spilled to memory" by the code generator.
 216   ///
 217   virtual void EmitConstantPool();
 218
 219   /// Print assembly representations of the jump tables used by the current
 220   /// function to the current output stream.
 221   ///
 222   void EmitJumpTableInfo();
 223
 224   /// Emit the specified global variable to the .s file.
 225   virtual void EmitGlobalVariable(const GlobalVariable *GV);
 226
 227   /// Check to see if the specified global is a special global used by LLVM. If
 228   /// so, emit it and return true, otherwise do nothing and return false.
 229   bool EmitSpecialLLVMGlobal(const GlobalVariable *GV);
 230
 231   /// Emit an alignment directive to the specified power of two boundary. For
 232   /// example, if you pass in 3 here, you will get an 8 byte alignment. If a
 233   /// global value is specified, and if that global has an explicit alignment
 234   /// requested, it will override the alignment request if required for
 235   /// correctness.
 236   ///
 237   void EmitAlignment(unsigned NumBits, const GlobalObject *GO = nullptr) const;
 238
 239   /// Lower the specified LLVM Constant to an MCExpr.
 240   const MCExpr *lowerConstant(const Constant *CV);
 241
 242   /// \brief Print a general LLVM constant to the .s file.
 243   void EmitGlobalConstant(const Constant *CV);
 244
 245   //===------------------------------------------------------------------===//
 246   // Overridable Hooks
 247   //===------------------------------------------------------------------===//
 248
 249   // Targets can, or in the case of EmitInstruction, must implement these to
 250   // customize output.
 251
 252   /// This virtual method can be overridden by targets that want to emit
 253   /// something at the start of their file.
 254   virtual void EmitStartOfAsmFile(Module &) {}
 255
 256   /// This virtual method can be overridden by targets that want to emit
 257   /// something at the end of their file.
 258   virtual void EmitEndOfAsmFile(Module &) {}
 259
 260   /// Targets can override this to emit stuff before the first basic block in
 261   /// the function.
 262   virtual void EmitFunctionBodyStart() {}
 263
 264   /// Targets can override this to emit stuff after the last basic block in the
 265   /// function.
 266   virtual void EmitFunctionBodyEnd() {}
 267
 268   /// Targets can override this to emit stuff at the start of a basic block.
 269   /// By default, this method prints the label for the specified
 270   /// MachineBasicBlock, an alignment (if present) and a comment describing it
 271   /// if appropriate.
 272   virtual void EmitBasicBlockStart(const MachineBasicBlock &MBB) const;
 273
 274   /// Targets can override this to emit stuff at the end of a basic block.
 275   virtual void EmitBasicBlockEnd(const MachineBasicBlock &MBB) {}
 276
 277   /// Targets should implement this to emit instructions.
 278   virtual void EmitInstruction(const MachineInstr *) {
 279     llvm_unreachable("EmitInstruction not implemented");
 280   }
 281
 282   /// Return the symbol for the specified constant pool entry.
 283   virtual MCSymbol *GetCPISymbol(unsigned CPID) const;
 284
 285   virtual void EmitFunctionEntryLabel();
 286
 287   virtual void EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV);
 288
 289   /// Targets can override this to change how global constants that are part of
 290   /// a C++ static/global constructor list are emitted.
 291   virtual void EmitXXStructor(const Constant *CV) { EmitGlobalConstant(CV); }
 292
 293   /// Return true if the basic block has exactly one predecessor and the control
 294   /// transfer mechanism between the predecessor and this block is a
 295   /// fall-through.
 296   virtual bool
 297   isBlockOnlyReachableByFallthrough(const MachineBasicBlock *MBB) const;
 298
 299   /// Targets can override this to customize the output of IMPLICIT_DEF
 300   /// instructions in verbose mode.
 301   virtual void emitImplicitDef(const MachineInstr *MI) const;
 302
 303   //===------------------------------------------------------------------===//
 304   // Symbol Lowering Routines.
 305   //===------------------------------------------------------------------===//
 306 public:
 307   /// Return the MCSymbol corresponding to the assembler temporary label with
 308   /// the specified stem and unique ID.
 309   MCSymbol *GetTempSymbol(const Twine &Name, unsigned ID) const;
 310
 311   /// Return an assembler temporary label with the specified stem.
 312   MCSymbol *GetTempSymbol(const Twine &Name) const;
 313
 314   /// Return the MCSymbol for a private symbol with global value name as its
 315   /// base, with the specified suffix.
 316   MCSymbol *getSymbolWithGlobalValueBase(const GlobalValue *GV,
 317                                          StringRef Suffix) const;
 318
 319   /// Return the MCSymbol for the specified ExternalSymbol.
 320   MCSymbol *GetExternalSymbolSymbol(StringRef Sym) const;
 321
 322   /// Return the symbol for the specified jump table entry.
 323   MCSymbol *GetJTISymbol(unsigned JTID, bool isLinkerPrivate = false) const;
 324
 325   /// Return the symbol for the specified jump table .set
 326   /// FIXME: privatize to AsmPrinter.
 327   MCSymbol *GetJTSetSymbol(unsigned UID, unsigned MBBID) const;
 328
 329   /// Return the MCSymbol used to satisfy BlockAddress uses of the specified
 330   /// basic block.
 331   MCSymbol *GetBlockAddressSymbol(const BlockAddress *BA) const;
 332   MCSymbol *GetBlockAddressSymbol(const BasicBlock *BB) const;
 333
 334   //===------------------------------------------------------------------===//
 335   // Emission Helper Routines.
 336   //===------------------------------------------------------------------===//
 337 public:
 338   /// This is just convenient handler for printing offsets.
 339   void printOffset(int64_t Offset, raw_ostream &OS) const;
 340
 341   /// Emit a byte directive and value.
 342   ///
 343   void EmitInt8(int Value) const;
 344
 345   /// Emit a short directive and value.
 346   ///
 347   void EmitInt16(int Value) const;
 348
 349   /// Emit a long directive and value.
 350   ///
 351   void EmitInt32(int Value) const;
 352
 353   /// Emit something like ".long Hi-Lo" where the size in bytes of the directive
 354   /// is specified by Size and Hi/Lo specify the labels.  This implicitly uses
 355   /// .set if it is available.
 356   void EmitLabelDifference(const MCSymbol *Hi, const MCSymbol *Lo,
 357                            unsigned Size) const;
 358
 359   /// Emit something like ".long Label+Offset" where the size in bytes of the
 360   /// directive is specified by Size and Label specifies the label.  This
 361   /// implicitly uses .set if it is available.
 362   void EmitLabelPlusOffset(const MCSymbol *Label, uint64_t Offset,
 363                            unsigned Size, bool IsSectionRelative = false) const;
 364
 365   /// Emit something like ".long Label" where the size in bytes of the directive
 366   /// is specified by Size and Label specifies the label.
 367   void EmitLabelReference(const MCSymbol *Label, unsigned Size,
 368                           bool IsSectionRelative = false) const {
 369     EmitLabelPlusOffset(Label, 0, Size, IsSectionRelative);
 370   }
 371
 372   //===------------------------------------------------------------------===//
 373   // Dwarf Emission Helper Routines
 374   //===------------------------------------------------------------------===//
 375
 376   /// Emit the specified signed leb128 value.
 377   void EmitSLEB128(int64_t Value, const char *Desc = nullptr) const;
 378
 379   /// Emit the specified unsigned leb128 value.
 380   void EmitULEB128(uint64_t Value, const char *Desc = nullptr,
 381                    unsigned PadTo = 0) const;
 382
 383   /// Emit a .byte 42 directive for a DW_CFA_xxx value.
 384   void EmitCFAByte(unsigned Val) const;
 385
 386   /// Emit a .byte 42 directive that corresponds to an encoding.  If verbose
 387   /// assembly output is enabled, we output comments describing the encoding.
 388   /// Desc is a string saying what the encoding is specifying (e.g. "LSDA").
 389   void EmitEncodingByte(unsigned Val, const char *Desc = nullptr) const;
 390
 391   /// Return the size of the encoding in bytes.
 392   unsigned GetSizeOfEncodedValue(unsigned Encoding) const;
 393
 394   /// Emit reference to a ttype global with a specified encoding.
 395   void EmitTTypeReference(const GlobalValue *GV, unsigned Encoding) const;
 396
 397   /// Emit the 4-byte offset of Label from the start of its section.  This can
 398   /// be done with a special directive if the target supports it (e.g. cygwin)
 399   /// or by emitting it as an offset from a label at the start of the section.
 400   ///
 401   /// SectionLabel is a temporary label emitted at the start of the section
 402   /// that Label lives in.
 403   void EmitSectionOffset(const MCSymbol *Label,
 404                          const MCSymbol *SectionLabel) const;
 405
 406   /// Get the value for DW_AT_APPLE_isa. Zero if no isa encoding specified.
 407   virtual unsigned getISAEncoding(const Function *) { return 0; }
 408
 409   /// Emit a dwarf register operation for describing
 410   /// - a small value occupying only part of a register or
 411   /// - a register representing only part of a value.
 412   void EmitDwarfOpPiece(ByteStreamer &Streamer, unsigned SizeInBits,
 413                         unsigned OffsetInBits = 0) const;
 414
 415
 416   /// \brief Emit a partial DWARF register operation.
 417   /// \param MLoc             the register
 418   /// \param PieceSize        size and
 419   /// \param PieceOffset      offset of the piece in bits, if this is one
 420   ///                         piece of an aggregate value.
 421   ///
 422   /// If size and offset is zero an operation for the entire
 423   /// register is emitted: Some targets do not provide a DWARF
 424   /// register number for every register.  If this is the case, this
 425   /// function will attempt to emit a DWARF register by emitting a
 426   /// piece of a super-register or by piecing together multiple
 427   /// subregisters that alias the register.
 428   void EmitDwarfRegOpPiece(ByteStreamer &BS, const MachineLocation &MLoc,
 429                            unsigned PieceSize = 0,
 430                            unsigned PieceOffset = 0) const;
 431
 432   /// EmitDwarfRegOp - Emit a dwarf register operation.
 433   virtual void EmitDwarfRegOp(ByteStreamer &BS,
 434                               const MachineLocation &MLoc) const;
 435
 436   //===------------------------------------------------------------------===//
 437   // Dwarf Lowering Routines
 438   //===------------------------------------------------------------------===//
 439
 440   /// \brief Emit frame instruction to describe the layout of the frame.
 441   void emitCFIInstruction(const MCCFIInstruction &Inst) const;
 442
 443   //===------------------------------------------------------------------===//
 444   // Inline Asm Support
 445   //===------------------------------------------------------------------===//
 446 public:
 447   // These are hooks that targets can override to implement inline asm
 448   // support.  These should probably be moved out of AsmPrinter someday.
 449
 450   /// Print information related to the specified machine instr that is
 451   /// independent of the operand, and may be independent of the instr itself.
 452   /// This can be useful for portably encoding the comment character or other
 453   /// bits of target-specific knowledge into the asmstrings.  The syntax used is
 454   /// ${:comment}.  Targets can override this to add support for their own
 455   /// strange codes.
 456   virtual void PrintSpecial(const MachineInstr *MI, raw_ostream &OS,
 457                             const char *Code) const;
 458
 459   /// Print the specified operand of MI, an INLINEASM instruction, using the
 460   /// specified assembler variant.  Targets should override this to format as
 461   /// appropriate.  This method can return true if the operand is erroneous.
 462   virtual bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
 463                                unsigned AsmVariant, const char *ExtraCode,
 464                                raw_ostream &OS);
 465
 466   /// Print the specified operand of MI, an INLINEASM instruction, using the
 467   /// specified assembler variant as an address. Targets should override this to
 468   /// format as appropriate.  This method can return true if the operand is
 469   /// erroneous.
 470   virtual bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
 471                                      unsigned AsmVariant, const char *ExtraCode,
 472                                      raw_ostream &OS);
 473
 474   /// Let the target do anything it needs to do before emitting inlineasm.
 475   /// \p StartInfo - the subtarget info before parsing inline asm
 476   virtual void emitInlineAsmStart() const;
 477
 478   /// Let the target do anything it needs to do after emitting inlineasm.
 479   /// This callback can be used restore the original mode in case the
 480   /// inlineasm contains directives to switch modes.
 481   /// \p StartInfo - the original subtarget info before inline asm
 482   /// \p EndInfo   - the final subtarget info after parsing the inline asm,
 483   ///                or NULL if the value is unknown.
 484   virtual void emitInlineAsmEnd(const MCSubtargetInfo &StartInfo,
 485                                 const MCSubtargetInfo *EndInfo) const;
 486
 487 private:
 488   /// Private state for PrintSpecial()
 489   // Assign a unique ID to this machine instruction.
 490   mutable const MachineInstr *LastMI;
 491   mutable unsigned LastFn;
 492   mutable unsigned Counter;
 493   mutable unsigned SetCounter;
 494
 495   /// Emit a blob of inline asm to the output streamer.
 496   void
 497   EmitInlineAsm(StringRef Str, const MDNode *LocMDNode = nullptr,
 498                 InlineAsm::AsmDialect AsmDialect = InlineAsm::AD_ATT) const;
 499
 500   /// This method formats and emits the specified machine instruction that is an
 501   /// inline asm.
 502   void EmitInlineAsm(const MachineInstr *MI) const;
 503
 504   //===------------------------------------------------------------------===//
 505   // Internal Implementation Details
 506   //===------------------------------------------------------------------===//
 507
 508   /// This emits visibility information about symbol, if this is suported by the
 509   /// target.
 510   void EmitVisibility(MCSymbol *Sym, unsigned Visibility,
 511                       bool IsDefinition = true) const;
 512
 513   void EmitLinkage(const GlobalValue *GV, MCSymbol *GVSym) const;
 514
 515   void EmitJumpTableEntry(const MachineJumpTableInfo *MJTI,
 516                           const MachineBasicBlock *MBB, unsigned uid) const;
 517   void EmitLLVMUsedList(const ConstantArray *InitList);
 518   /// Emit llvm.ident metadata in an '.ident' directive.
 519   void EmitModuleIdents(Module &M);
 520   void EmitXXStructorList(const Constant *List, bool isCtor);
 521   GCMetadataPrinter *GetOrCreateGCPrinter(GCStrategy &C);
 522 };
 523 }
 524
 525 #endif