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