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/CodeGen/MachineFunctionPass.h"
  20 #include "llvm/Support/DataTypes.h"
  21
  22 namespace llvm {
  23   class BlockAddress;
  24   class GCStrategy;
  25   class Constant;
  26   class ConstantArray;
  27   class ConstantFP;
  28   class ConstantInt;
  29   class ConstantStruct;
  30   class ConstantVector;
  31   class GCMetadataPrinter;
  32   class GlobalValue;
  33   class GlobalVariable;
  34   class MachineBasicBlock;
  35   class MachineFunction;
  36   class MachineInstr;
  37   class MachineLocation;
  38   class MachineLoopInfo;
  39   class MachineLoop;
  40   class MachineConstantPool;
  41   class MachineConstantPoolEntry;
  42   class MachineConstantPoolValue;
  43   class MachineJumpTableInfo;
  44   class MachineModuleInfo;
  45   class MachineMove;
  46   class MCAsmInfo;
  47   class MCInst;
  48   class MCContext;
  49   class MCSection;
  50   class MCStreamer;
  51   class MCSymbol;
  52   class MDNode;
  53   class DwarfDebug;
  54   class DwarfException;
  55   class Mangler;
  56   class TargetLoweringObjectFile;
  57   class TargetData;
  58   class TargetMachine;
  59   class Twine;
  60   class Type;
  61
  62   /// AsmPrinter - This class is intended to be used as a driving class for all
  63   /// 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     /// OutContext - This is the context for the output file that we are
  75     /// streaming.  This owns all of the global MC-related objects for the
  76     /// generated translation unit.
  77     MCContext &OutContext;
  78
  79     /// OutStreamer - This is the MCStreamer object for the file we are
  80     /// generating.  This contains the transient state for the current
  81     /// translation unit that we are generating (such as the current section
  82     /// etc).
  83     MCStreamer &OutStreamer;
  84
  85     /// The current machine function.
  86     const MachineFunction *MF;
  87
  88     /// MMI - This is a pointer to the current MachineModuleInfo.
  89     MachineModuleInfo *MMI;
  90
  91     /// Name-mangler for global names.
  92     ///
  93     Mangler *Mang;
  94
  95     /// The symbol for the current function. This is recalculated at the
  96     /// beginning of each call to runOnMachineFunction().
  97     ///
  98     MCSymbol *CurrentFnSym;
  99
 100   private:
 101     // GCMetadataPrinters - The garbage collection metadata printer table.
 102     void *GCMetadataPrinters;  // Really a DenseMap.
 103
 104     /// VerboseAsm - 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
 110     /// function.
 111     MachineLoopInfo *LI;
 112
 113     /// DD - If the target supports dwarf debug info, this pointer is non-null.
 114     DwarfDebug *DD;
 115
 116     /// DE - If the target supports dwarf exception info, this pointer is
 117     /// non-null.
 118     DwarfException *DE;
 119
 120   protected:
 121     explicit AsmPrinter(TargetMachine &TM, MCStreamer &Streamer);
 122
 123   public:
 124     virtual ~AsmPrinter();
 125
 126     /// isVerbose - Return true if assembly output should contain comments.
 127     ///
 128     bool isVerbose() const { return VerboseAsm; }
 129
 130     /// getFunctionNumber - Return a unique ID for the current function.
 131     ///
 132     unsigned getFunctionNumber() const;
 133
 134     /// getObjFileLowering - Return information about object file lowering.
 135     const TargetLoweringObjectFile &getObjFileLowering() const;
 136
 137     /// getTargetData - Return information about data layout.
 138     const TargetData &getTargetData() const;
 139
 140     /// getCurrentSection() - Return the current section we are emitting to.
 141     const MCSection *getCurrentSection() const;
 142
 143
 144     //===------------------------------------------------------------------===//
 145     // MachineFunctionPass Implementation.
 146     //===------------------------------------------------------------------===//
 147
 148     /// getAnalysisUsage - Record analysis usage.
 149     ///
 150     void getAnalysisUsage(AnalysisUsage &AU) const;
 151
 152     /// doInitialization - Set up the AsmPrinter when we are working on a new
 153     /// module.  If your pass overrides this, it must make sure to explicitly
 154     /// call this implementation.
 155     bool doInitialization(Module &M);
 156
 157     /// doFinalization - Shut down the asmprinter.  If you override this in your
 158     /// pass, you must make sure to call it explicitly.
 159     bool doFinalization(Module &M);
 160
 161     /// runOnMachineFunction - Emit the specified function out to the
 162     /// OutStreamer.
 163     virtual bool runOnMachineFunction(MachineFunction &MF) {
 164       SetupMachineFunction(MF);
 165       EmitFunctionHeader();
 166       EmitFunctionBody();
 167       return false;
 168     }
 169
 170     //===------------------------------------------------------------------===//
 171     // Coarse grained IR lowering routines.
 172     //===------------------------------------------------------------------===//
 173
 174     /// SetupMachineFunction - This should be called when a new MachineFunction
 175     /// is being processed from runOnMachineFunction.
 176     void SetupMachineFunction(MachineFunction &MF);
 177
 178     /// EmitFunctionHeader - This method emits the header for the current
 179     /// function.
 180     void EmitFunctionHeader();
 181
 182     /// EmitFunctionBody - This method emits the body and trailer for a
 183     /// function.
 184     void EmitFunctionBody();
 185
 186     void emitPrologLabel(const MachineInstr &MI);
 187
 188     enum CFIMoveType {
 189       CFI_M_None,
 190       CFI_M_EH,
 191       CFI_M_Debug
 192     };
 193     CFIMoveType needsCFIMoves();
 194
 195     bool needsSEHMoves();
 196
 197     /// needsRelocationsForDwarfStringPool - Specifies whether the object format
 198     /// expects to use relocations to refer to debug entries. Alternatively we
 199     /// emit section offsets in bytes from the start of the string pool.
 200     bool needsRelocationsForDwarfStringPool() const;
 201
 202     /// EmitConstantPool - Print to the current output stream assembly
 203     /// representations of the constants in the constant pool MCP. This is
 204     /// used to print out constants which have been "spilled to memory" by
 205     /// the code generator.
 206     ///
 207     virtual void EmitConstantPool();
 208
 209     /// EmitJumpTableInfo - Print assembly representations of the jump tables
 210     /// used by the current function to the current output stream.
 211     ///
 212     void EmitJumpTableInfo();
 213
 214     /// EmitGlobalVariable - Emit the specified global variable to the .s file.
 215     virtual void EmitGlobalVariable(const GlobalVariable *GV);
 216
 217     /// EmitSpecialLLVMGlobal - Check to see if the specified global is a
 218     /// special global used by LLVM.  If so, emit it and return true, otherwise
 219     /// do nothing and return false.
 220     bool EmitSpecialLLVMGlobal(const GlobalVariable *GV);
 221
 222     /// EmitAlignment - Emit an alignment directive to the specified power of
 223     /// two boundary.  For example, if you pass in 3 here, you will get an 8
 224     /// byte alignment.  If a global value is specified, and if that global has
 225     /// an explicit alignment requested, it will override the alignment request
 226     /// if required for correctness.
 227     ///
 228     void EmitAlignment(unsigned NumBits, const GlobalValue *GV = 0) const;
 229
 230     /// EmitBasicBlockStart - This method prints the label for the specified
 231     /// MachineBasicBlock, an alignment (if present) and a comment describing
 232     /// it if appropriate.
 233     void EmitBasicBlockStart(const MachineBasicBlock *MBB) const;
 234
 235     /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
 236     void EmitGlobalConstant(const Constant *CV, unsigned AddrSpace = 0);
 237
 238
 239     //===------------------------------------------------------------------===//
 240     // Overridable Hooks
 241     //===------------------------------------------------------------------===//
 242
 243     // Targets can, or in the case of EmitInstruction, must implement these to
 244     // customize output.
 245
 246     /// EmitStartOfAsmFile - This virtual method can be overridden by targets
 247     /// that want to emit something at the start of their file.
 248     virtual void EmitStartOfAsmFile(Module &) {}
 249
 250     /// EmitEndOfAsmFile - This virtual method can be overridden by targets that
 251     /// want to emit something at the end of their file.
 252     virtual void EmitEndOfAsmFile(Module &) {}
 253
 254     /// EmitFunctionBodyStart - Targets can override this to emit stuff before
 255     /// the first basic block in the function.
 256     virtual void EmitFunctionBodyStart() {}
 257
 258     /// EmitFunctionBodyEnd - Targets can override this to emit stuff after
 259     /// the last basic block in the function.
 260     virtual void EmitFunctionBodyEnd() {}
 261
 262     /// EmitInstruction - Targets should implement this to emit instructions.
 263     virtual void EmitInstruction(const MachineInstr *) {
 264       assert(0 && "EmitInstruction not implemented");
 265     }
 266
 267     virtual void EmitFunctionEntryLabel();
 268
 269     virtual void EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV);
 270
 271     /// isBlockOnlyReachableByFallthough - Return true if the basic block has
 272     /// exactly one predecessor and the control transfer mechanism between
 273     /// the predecessor and this block is a fall-through.
 274     virtual bool
 275     isBlockOnlyReachableByFallthrough(const MachineBasicBlock *MBB) const;
 276
 277     //===------------------------------------------------------------------===//
 278     // Symbol Lowering Routines.
 279     //===------------------------------------------------------------------===//
 280   public:
 281
 282     /// GetTempSymbol - Return the MCSymbol corresponding to the assembler
 283     /// temporary label with the specified stem and unique ID.
 284     MCSymbol *GetTempSymbol(StringRef Name, unsigned ID) const;
 285
 286     /// GetTempSymbol - Return an assembler temporary label with the specified
 287     /// stem.
 288     MCSymbol *GetTempSymbol(StringRef Name) const;
 289
 290
 291     /// GetSymbolWithGlobalValueBase - Return the MCSymbol for a symbol with
 292     /// global value name as its base, with the specified suffix, and where the
 293     /// symbol is forced to have private linkage if ForcePrivate is true.
 294     MCSymbol *GetSymbolWithGlobalValueBase(const GlobalValue *GV,
 295                                            StringRef Suffix,
 296                                            bool ForcePrivate = true) const;
 297
 298     /// GetExternalSymbolSymbol - Return the MCSymbol for the specified
 299     /// ExternalSymbol.
 300     MCSymbol *GetExternalSymbolSymbol(StringRef Sym) const;
 301
 302     /// GetCPISymbol - Return the symbol for the specified constant pool entry.
 303     MCSymbol *GetCPISymbol(unsigned CPID) const;
 304
 305     /// GetJTISymbol - Return the symbol for the specified jump table entry.
 306     MCSymbol *GetJTISymbol(unsigned JTID, bool isLinkerPrivate = false) const;
 307
 308     /// GetJTSetSymbol - Return the symbol for the specified jump table .set
 309     /// FIXME: privatize to AsmPrinter.
 310     MCSymbol *GetJTSetSymbol(unsigned UID, unsigned MBBID) const;
 311
 312     /// GetBlockAddressSymbol - Return the MCSymbol used to satisfy BlockAddress
 313     /// uses of the specified basic block.
 314     MCSymbol *GetBlockAddressSymbol(const BlockAddress *BA) const;
 315     MCSymbol *GetBlockAddressSymbol(const BasicBlock *BB) const;
 316
 317     //===------------------------------------------------------------------===//
 318     // Emission Helper Routines.
 319     //===------------------------------------------------------------------===//
 320   public:
 321     /// printOffset - This is just convenient handler for printing offsets.
 322     void printOffset(int64_t Offset, raw_ostream &OS) const;
 323
 324     /// EmitInt8 - Emit a byte directive and value.
 325     ///
 326     void EmitInt8(int Value) const;
 327
 328     /// EmitInt16 - Emit a short directive and value.
 329     ///
 330     void EmitInt16(int Value) const;
 331
 332     /// EmitInt32 - Emit a long directive and value.
 333     ///
 334     void EmitInt32(int Value) const;
 335
 336     /// EmitLabelDifference - Emit something like ".long Hi-Lo" where the size
 337     /// in bytes of the directive is specified by Size and Hi/Lo specify the
 338     /// labels.  This implicitly uses .set if it is available.
 339     void EmitLabelDifference(const MCSymbol *Hi, const MCSymbol *Lo,
 340                              unsigned Size) const;
 341
 342     /// EmitLabelOffsetDifference - Emit something like ".long Hi+Offset-Lo"
 343     /// where the size in bytes of the directive is specified by Size and Hi/Lo
 344     /// specify the labels.  This implicitly uses .set if it is available.
 345     void EmitLabelOffsetDifference(const MCSymbol *Hi, uint64_t Offset,
 346                                    const MCSymbol *Lo, unsigned Size) const;
 347
 348     /// EmitLabelPlusOffset - Emit something like ".long Label+Offset"
 349     /// where the size in bytes of the directive is specified by Size and Label
 350     /// specifies the label.  This implicitly uses .set if it is available.
 351     void EmitLabelPlusOffset(const MCSymbol *Label, uint64_t Offset,
 352                                    unsigned Size) const;
 353
 354     //===------------------------------------------------------------------===//
 355     // Dwarf Emission Helper Routines
 356     //===------------------------------------------------------------------===//
 357
 358     /// EmitSLEB128 - emit the specified signed leb128 value.
 359     void EmitSLEB128(int Value, const char *Desc = 0) const;
 360
 361     /// EmitULEB128 - emit the specified unsigned leb128 value.
 362     void EmitULEB128(unsigned Value, const char *Desc = 0,
 363                      unsigned PadTo = 0) const;
 364
 365     /// EmitCFAByte - Emit a .byte 42 directive for a DW_CFA_xxx value.
 366     void EmitCFAByte(unsigned Val) const;
 367
 368     /// EmitEncodingByte - Emit a .byte 42 directive that corresponds to an
 369     /// encoding.  If verbose assembly output is enabled, we output comments
 370     /// describing the encoding.  Desc is a string saying what the encoding is
 371     /// specifying (e.g. "LSDA").
 372     void EmitEncodingByte(unsigned Val, const char *Desc = 0) const;
 373
 374     /// GetSizeOfEncodedValue - Return the size of the encoding in bytes.
 375     unsigned GetSizeOfEncodedValue(unsigned Encoding) const;
 376
 377     /// EmitReference - Emit a reference to a label with a specified encoding.
 378     ///
 379     void EmitReference(const MCSymbol *Sym, unsigned Encoding) const;
 380     void EmitReference(const GlobalValue *GV, unsigned Encoding) const;
 381
 382     /// EmitSectionOffset - Emit the 4-byte offset of Label from the start of
 383     /// its section.  This can be done with a special directive if the target
 384     /// supports it (e.g. cygwin) or by emitting it as an offset from a label at
 385     /// the start of the section.
 386     ///
 387     /// SectionLabel is a temporary label emitted at the start of the section
 388     /// that Label lives in.
 389     void EmitSectionOffset(const MCSymbol *Label,
 390                            const MCSymbol *SectionLabel) const;
 391
 392     /// getDebugValueLocation - Get location information encoded by DBG_VALUE
 393     /// operands.
 394     virtual MachineLocation getDebugValueLocation(const MachineInstr *MI) const;
 395
 396     /// getISAEncoding - Get the value for DW_AT_APPLE_isa. Zero if no isa
 397     /// encoding specified.
 398     virtual unsigned getISAEncoding() { return 0; }
 399
 400     /// EmitDwarfRegOp - Emit dwarf register operation.
 401     virtual void EmitDwarfRegOp(const MachineLocation &MLoc) const;
 402
 403     //===------------------------------------------------------------------===//
 404     // Dwarf Lowering Routines
 405     //===------------------------------------------------------------------===//
 406
 407     /// EmitCFIFrameMove - Emit frame instruction to describe the layout of the
 408     /// frame.
 409     void EmitCFIFrameMove(const MachineMove &Move) const;
 410
 411     //===------------------------------------------------------------------===//
 412     // Inline Asm Support
 413     //===------------------------------------------------------------------===//
 414   public:
 415     // These are hooks that targets can override to implement inline asm
 416     // support.  These should probably be moved out of AsmPrinter someday.
 417
 418     /// PrintSpecial - Print information related to the specified machine instr
 419     /// that is independent of the operand, and may be independent of the instr
 420     /// itself.  This can be useful for portably encoding the comment character
 421     /// or other bits of target-specific knowledge into the asmstrings.  The
 422     /// syntax used is ${:comment}.  Targets can override this to add support
 423     /// for their own strange codes.
 424     virtual void PrintSpecial(const MachineInstr *MI, raw_ostream &OS,
 425                               const char *Code) const;
 426
 427     /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
 428     /// instruction, using the specified assembler variant.  Targets should
 429     /// override this to format as appropriate.  This method can return true if
 430     /// the operand is erroneous.
 431     virtual bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
 432                                  unsigned AsmVariant, const char *ExtraCode,
 433                                  raw_ostream &OS);
 434
 435     /// PrintAsmMemoryOperand - Print the specified operand of MI, an INLINEASM
 436     /// instruction, using the specified assembler variant as an address.
 437     /// Targets should override this to format as appropriate.  This method can
 438     /// return true if the operand is erroneous.
 439     virtual bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
 440                                        unsigned AsmVariant,
 441                                        const char *ExtraCode,
 442                                        raw_ostream &OS);
 443
 444   private:
 445     /// Private state for PrintSpecial()
 446     // Assign a unique ID to this machine instruction.
 447     mutable const MachineInstr *LastMI;
 448     mutable unsigned LastFn;
 449     mutable unsigned Counter;
 450     mutable unsigned SetCounter;
 451
 452     /// EmitInlineAsm - Emit a blob of inline asm to the output streamer.
 453     void EmitInlineAsm(StringRef Str, const MDNode *LocMDNode = 0) const;
 454
 455     /// EmitInlineAsm - This method formats and emits the specified machine
 456     /// instruction that is an inline asm.
 457     void EmitInlineAsm(const MachineInstr *MI) const;
 458
 459     //===------------------------------------------------------------------===//
 460     // Internal Implementation Details
 461     //===------------------------------------------------------------------===//
 462
 463     /// EmitVisibility - This emits visibility information about symbol, if
 464     /// this is suported by the target.
 465     void EmitVisibility(MCSymbol *Sym, unsigned Visibility,
 466                         bool IsDefinition = true) const;
 467
 468     void EmitLinkage(unsigned Linkage, MCSymbol *GVSym) const;
 469
 470     void EmitJumpTableEntry(const MachineJumpTableInfo *MJTI,
 471                             const MachineBasicBlock *MBB,
 472                             unsigned uid) const;
 473     void EmitLLVMUsedList(const Constant *List);
 474     void EmitXXStructorList(const Constant *List);
 475     GCMetadataPrinter *GetOrCreateGCPrinter(GCStrategy *C);
 476   };
 477 }
 478
 479 #endif