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/DebugLoc.h"
  21 #include "llvm/Target/TargetMachine.h"
  22 #include "llvm/ADT/DenseMap.h"
  23
  24 namespace llvm {
  25   class BlockAddress;
  26   class GCStrategy;
  27   class Constant;
  28   class ConstantArray;
  29   class ConstantFP;
  30   class ConstantInt;
  31   class ConstantStruct;
  32   class ConstantVector;
  33   class GCMetadataPrinter;
  34   class GlobalValue;
  35   class GlobalVariable;
  36   class MachineBasicBlock;
  37   class MachineFunction;
  38   class MachineInstr;
  39   class MachineLoopInfo;
  40   class MachineLoop;
  41   class MachineConstantPool;
  42   class MachineConstantPoolEntry;
  43   class MachineConstantPoolValue;
  44   class MachineJumpTableInfo;
  45   class MachineModuleInfo;
  46   class MCInst;
  47   class MCContext;
  48   class MCSection;
  49   class MCStreamer;
  50   class MCSymbol;
  51   class DwarfWriter;
  52   class Mangler;
  53   class MCAsmInfo;
  54   class TargetLoweringObjectFile;
  55   class Type;
  56   class formatted_raw_ostream;
  57
  58   /// AsmPrinter - This class is intended to be used as a driving class for all
  59   /// asm writers.
  60   class AsmPrinter : public MachineFunctionPass {
  61     static char ID;
  62
  63     /// FunctionNumber - This provides a unique ID for each function emitted in
  64     /// this translation unit.  It is autoincremented by SetupMachineFunction,
  65     /// and can be accessed with getFunctionNumber() and
  66     /// IncrementFunctionNumber().
  67     ///
  68     unsigned FunctionNumber;
  69
  70     // GCMetadataPrinters - The garbage collection metadata printer table.
  71     typedef DenseMap<GCStrategy*,GCMetadataPrinter*> gcp_map_type;
  72     typedef gcp_map_type::iterator gcp_iterator;
  73     gcp_map_type GCMetadataPrinters;
  74
  75     /// If VerboseAsm is set, a pointer to the loop info for this
  76     /// function.
  77     ///
  78     MachineLoopInfo *LI;
  79
  80   public:
  81     /// MMI - If available, this is a pointer to the current MachineModuleInfo.
  82     MachineModuleInfo *MMI;
  83
  84   protected:
  85     /// DW - If available, this is a pointer to the current dwarf writer.
  86     DwarfWriter *DW;
  87
  88   public:
  89     /// Flags to specify different kinds of comments to output in
  90     /// assembly code.  These flags carry semantic information not
  91     /// otherwise easily derivable from the IR text.
  92     ///
  93     enum CommentFlag {
  94       ReloadReuse = 0x1
  95     };
  96
  97     /// Output stream on which we're printing assembly code.
  98     ///
  99     formatted_raw_ostream &O;
 100
 101     /// Target machine description.
 102     ///
 103     TargetMachine &TM;
 104
 105     /// getObjFileLowering - Return information about object file lowering.
 106     TargetLoweringObjectFile &getObjFileLowering() const;
 107
 108     /// Target Asm Printer information.
 109     ///
 110     const MCAsmInfo *MAI;
 111
 112     /// Target Register Information.
 113     ///
 114     const TargetRegisterInfo *TRI;
 115
 116     /// OutContext - This is the context for the output file that we are
 117     /// streaming.  This owns all of the global MC-related objects for the
 118     /// generated translation unit.
 119     MCContext &OutContext;
 120
 121     /// OutStreamer - This is the MCStreamer object for the file we are
 122     /// generating.  This contains the transient state for the current
 123     /// translation unit that we are generating (such as the current section
 124     /// etc).
 125     MCStreamer &OutStreamer;
 126
 127     /// The current machine function.
 128     const MachineFunction *MF;
 129
 130     /// Name-mangler for global names.
 131     ///
 132     Mangler *Mang;
 133
 134     /// Cache of mangled name for current function. This is recalculated at the
 135     /// beginning of each call to runOnMachineFunction().
 136     ///
 137     std::string CurrentFnName;  // FIXME: REMOVE.
 138     const MCSymbol *CurrentFnSym;
 139
 140     /// getCurrentSection() - Return the current section we are emitting to.
 141     const MCSection *getCurrentSection() const;
 142
 143
 144     /// VerboseAsm - Emit comments in assembly output if this is true.
 145     ///
 146     bool VerboseAsm;
 147
 148     /// Private state for PrintSpecial()
 149     // Assign a unique ID to this machine instruction.
 150     mutable const MachineInstr *LastMI;
 151     mutable const Function *LastFn;
 152     mutable unsigned Counter;
 153
 154     // Private state for processDebugLoc()
 155     mutable DebugLocTuple PrevDLT;
 156
 157   protected:
 158     explicit AsmPrinter(formatted_raw_ostream &o, TargetMachine &TM,
 159                         const MCAsmInfo *T, bool V);
 160
 161   public:
 162     virtual ~AsmPrinter();
 163
 164     /// isVerbose - Return true if assembly output should contain comments.
 165     ///
 166     bool isVerbose() const { return VerboseAsm; }
 167
 168     /// getFunctionNumber - Return a unique ID for the current function.
 169     ///
 170     unsigned getFunctionNumber() const { return FunctionNumber; }
 171
 172   protected:
 173     /// getAnalysisUsage - Record analysis usage.
 174     ///
 175     void getAnalysisUsage(AnalysisUsage &AU) const;
 176
 177     /// doInitialization - Set up the AsmPrinter when we are working on a new
 178     /// module.  If your pass overrides this, it must make sure to explicitly
 179     /// call this implementation.
 180     bool doInitialization(Module &M);
 181
 182     /// EmitStartOfAsmFile - This virtual method can be overridden by targets
 183     /// that want to emit something at the start of their file.
 184     virtual void EmitStartOfAsmFile(Module &) {}
 185
 186     /// EmitEndOfAsmFile - This virtual method can be overridden by targets that
 187     /// want to emit something at the end of their file.
 188     virtual void EmitEndOfAsmFile(Module &) {}
 189
 190     /// doFinalization - Shut down the asmprinter.  If you override this in your
 191     /// pass, you must make sure to call it explicitly.
 192     bool doFinalization(Module &M);
 193
 194     /// PrintSpecial - Print information related to the specified machine instr
 195     /// that is independent of the operand, and may be independent of the instr
 196     /// itself.  This can be useful for portably encoding the comment character
 197     /// or other bits of target-specific knowledge into the asmstrings.  The
 198     /// syntax used is ${:comment}.  Targets can override this to add support
 199     /// for their own strange codes.
 200     virtual void PrintSpecial(const MachineInstr *MI, const char *Code) const;
 201
 202     /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
 203     /// instruction, using the specified assembler variant.  Targets should
 204     /// override this to format as appropriate.  This method can return true if
 205     /// the operand is erroneous.
 206     virtual bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
 207                                  unsigned AsmVariant, const char *ExtraCode);
 208
 209     /// PrintAsmMemoryOperand - Print the specified operand of MI, an INLINEASM
 210     /// instruction, using the specified assembler variant as an address.
 211     /// Targets should override this to format as appropriate.  This method can
 212     /// return true if the operand is erroneous.
 213     virtual bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
 214                                        unsigned AsmVariant,
 215                                        const char *ExtraCode);
 216
 217     /// PrintGlobalVariable - Emit the specified global variable and its
 218     /// initializer to the output stream.
 219     virtual void PrintGlobalVariable(const GlobalVariable *GV) = 0;
 220
 221     /// SetupMachineFunction - This should be called when a new MachineFunction
 222     /// is being processed from runOnMachineFunction.
 223     void SetupMachineFunction(MachineFunction &MF);
 224
 225     /// IncrementFunctionNumber - Increase Function Number.  AsmPrinters should
 226     /// not normally call this, as the counter is automatically bumped by
 227     /// SetupMachineFunction.
 228     void IncrementFunctionNumber() { FunctionNumber++; }
 229
 230     /// EmitConstantPool - Print to the current output stream assembly
 231     /// representations of the constants in the constant pool MCP. This is
 232     /// used to print out constants which have been "spilled to memory" by
 233     /// the code generator.
 234     ///
 235     void EmitConstantPool(MachineConstantPool *MCP);
 236
 237     /// EmitJumpTableInfo - Print assembly representations of the jump tables
 238     /// used by the current function to the current output stream.
 239     ///
 240     void EmitJumpTableInfo(MachineJumpTableInfo *MJTI, MachineFunction &MF);
 241
 242     /// EmitSpecialLLVMGlobal - Check to see if the specified global is a
 243     /// special global used by LLVM.  If so, emit it and return true, otherwise
 244     /// do nothing and return false.
 245     bool EmitSpecialLLVMGlobal(const GlobalVariable *GV);
 246
 247   public:
 248     //===------------------------------------------------------------------===//
 249     /// LEB 128 number encoding.
 250
 251     /// PrintULEB128 - Print a series of hexidecimal values(separated by commas)
 252     /// representing an unsigned leb128 value.
 253     void PrintULEB128(unsigned Value) const;
 254
 255     /// PrintSLEB128 - Print a series of hexidecimal values(separated by commas)
 256     /// representing a signed leb128 value.
 257     void PrintSLEB128(int Value) const;
 258
 259     //===------------------------------------------------------------------===//
 260     // Emission and print routines
 261     //
 262
 263     /// PrintHex - Print a value as a hexidecimal value.
 264     ///
 265     void PrintHex(int Value) const;
 266
 267     /// EOL - Print a newline character to asm stream.  If a comment is present
 268     /// then it will be printed first.  Comments should not contain '\n'.
 269     void EOL() const;
 270     void EOL(const std::string &Comment) const;
 271     void EOL(const char* Comment) const;
 272     void EOL(const char *Comment, unsigned Encoding) const;
 273
 274     /// EmitULEB128Bytes - Emit an assembler byte data directive to compose an
 275     /// unsigned leb128 value.
 276     void EmitULEB128Bytes(unsigned Value) const;
 277
 278     /// EmitSLEB128Bytes - print an assembler byte data directive to compose a
 279     /// signed leb128 value.
 280     void EmitSLEB128Bytes(int Value) const;
 281
 282     /// EmitInt8 - Emit a byte directive and value.
 283     ///
 284     void EmitInt8(int Value) const;
 285
 286     /// EmitInt16 - Emit a short directive and value.
 287     ///
 288     void EmitInt16(int Value) const;
 289
 290     /// EmitInt32 - Emit a long directive and value.
 291     ///
 292     void EmitInt32(int Value) const;
 293
 294     /// EmitInt64 - Emit a long long directive and value.
 295     ///
 296     void EmitInt64(uint64_t Value) const;
 297
 298     /// EmitString - Emit a string with quotes and a null terminator.
 299     /// Special characters are emitted properly.
 300     /// @verbatim (Eg. '\t') @endverbatim
 301     void EmitString(const StringRef String) const;
 302     void EmitString(const char *String, unsigned Size) const;
 303
 304     /// EmitFile - Emit a .file directive.
 305     void EmitFile(unsigned Number, const std::string &Name) const;
 306
 307     //===------------------------------------------------------------------===//
 308
 309     /// EmitAlignment - Emit an alignment directive to the specified power of
 310     /// two boundary.  For example, if you pass in 3 here, you will get an 8
 311     /// byte alignment.  If a global value is specified, and if that global has
 312     /// an explicit alignment requested, it will unconditionally override the
 313     /// alignment request.  However, if ForcedAlignBits is specified, this value
 314     /// has final say: the ultimate alignment will be the max of ForcedAlignBits
 315     /// and the alignment computed with NumBits and the global.  If UseFillExpr
 316     /// is true, it also emits an optional second value FillValue which the
 317     /// assembler uses to fill gaps to match alignment for text sections if the
 318     /// has specified a non-zero fill value.
 319     ///
 320     /// The algorithm is:
 321     ///     Align = NumBits;
 322     ///     if (GV && GV->hasalignment) Align = GV->getalignment();
 323     ///     Align = std::max(Align, ForcedAlignBits);
 324     ///
 325     void EmitAlignment(unsigned NumBits, const GlobalValue *GV = 0,
 326                        unsigned ForcedAlignBits = 0,
 327                        bool UseFillExpr = true) const;
 328
 329     /// printLabel - This method prints a local label used by debug and
 330     /// exception handling tables.
 331     void printLabel(const MachineInstr *MI) const;
 332     void printLabel(unsigned Id) const;
 333
 334     /// printDeclare - This method prints a local variable declaration used by
 335     /// debug tables.
 336     void printDeclare(const MachineInstr *MI) const;
 337
 338     /// EmitComments - Pretty-print comments for instructions
 339     void EmitComments(const MachineInstr &MI) const;
 340     /// EmitComments - Pretty-print comments for basic blocks
 341     void EmitComments(const MachineBasicBlock &MBB) const;
 342
 343     /// GetGlobalValueSymbol - Return the MCSymbol for the specified global
 344     /// value.
 345     MCSymbol *GetGlobalValueSymbol(const GlobalValue *GV) const;
 346
 347     /// GetPrivateGlobalValueSymbolStub - Return the MCSymbol for a symbol with
 348     /// global value name as its base, with the specified suffix, and where the
 349     /// symbol is forced to have private linkage.
 350     MCSymbol *GetPrivateGlobalValueSymbolStub(const GlobalValue *GV,
 351                                               StringRef Suffix) const;
 352
 353     /// GetExternalSymbolSymbol - Return the MCSymbol for the specified
 354     /// ExternalSymbol.
 355     MCSymbol *GetExternalSymbolSymbol(StringRef Sym) const;
 356
 357     /// GetMBBSymbol - Return the MCSymbol corresponding to the specified basic
 358     /// block label.
 359     MCSymbol *GetMBBSymbol(unsigned MBBID) const;
 360
 361     /// GetBlockAddressSymbol - Return the MCSymbol used to satisfy BlockAddress
 362     /// uses of the specified basic block.
 363     MCSymbol *GetBlockAddressSymbol(const BlockAddress *BA,
 364                                     const char *Suffix = "") const;
 365     MCSymbol *GetBlockAddressSymbol(const Function *F,
 366                                     const BasicBlock *BB,
 367                                     const char *Suffix = "") const;
 368
 369     /// EmitBasicBlockStart - This method prints the label for the specified
 370     /// MachineBasicBlock, an alignment (if present) and a comment describing
 371     /// it if appropriate.
 372     void EmitBasicBlockStart(const MachineBasicBlock *MBB) const;
 373   protected:
 374     /// EmitZeros - Emit a block of zeros.
 375     ///
 376     void EmitZeros(uint64_t NumZeros, unsigned AddrSpace = 0) const;
 377
 378     /// EmitString - Emit a zero-byte-terminated string constant.
 379     ///
 380     virtual void EmitString(const ConstantArray *CVA) const;
 381
 382     /// EmitConstantValueOnly - Print out the specified constant, without a
 383     /// storage class.  Only constants of first-class type are allowed here.
 384     void EmitConstantValueOnly(const Constant *CV);
 385
 386     /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
 387     void EmitGlobalConstant(const Constant* CV, unsigned AddrSpace = 0);
 388
 389     virtual void EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV);
 390
 391     /// processDebugLoc - Processes the debug information of each machine
 392     /// instruction's DebugLoc.
 393     void processDebugLoc(const MachineInstr *MI, bool BeforePrintingInsn);
 394
 395     /// printInlineAsm - This method formats and prints the specified machine
 396     /// instruction that is an inline asm.
 397     void printInlineAsm(const MachineInstr *MI) const;
 398
 399     /// printImplicitDef - This method prints the specified machine instruction
 400     /// that is an implicit def.
 401     void printImplicitDef(const MachineInstr *MI) const;
 402
 403     /// printKill - This method prints the specified kill machine instruction.
 404     void printKill(const MachineInstr *MI) const;
 405
 406     /// printPICJumpTableSetLabel - This method prints a set label for the
 407     /// specified MachineBasicBlock for a jumptable entry.
 408     virtual void printPICJumpTableSetLabel(unsigned uid,
 409                                            const MachineBasicBlock *MBB) const;
 410     virtual void printPICJumpTableSetLabel(unsigned uid, unsigned uid2,
 411                                            const MachineBasicBlock *MBB) const;
 412     virtual void printPICJumpTableEntry(const MachineJumpTableInfo *MJTI,
 413                                         const MachineBasicBlock *MBB,
 414                                         unsigned uid) const;
 415
 416     /// printDataDirective - This method prints the asm directive for the
 417     /// specified type.
 418     void printDataDirective(const Type *type, unsigned AddrSpace = 0);
 419
 420     /// printVisibility - This prints visibility information about symbol, if
 421     /// this is suported by the target.
 422     void printVisibility(const MCSymbol *Sym, unsigned Visibility) const;
 423
 424     // FIXME: This is deprecated and should be removed.
 425     void printVisibility(const std::string& Name, unsigned Visibility) const;
 426
 427     /// printOffset - This is just convenient handler for printing offsets.
 428     void printOffset(int64_t Offset) const;
 429
 430   private:
 431     void EmitLLVMUsedList(Constant *List);
 432     void EmitXXStructorList(Constant *List);
 433     void EmitGlobalConstantStruct(const ConstantStruct* CVS,
 434                                   unsigned AddrSpace);
 435     void EmitGlobalConstantArray(const ConstantArray* CVA, unsigned AddrSpace);
 436     void EmitGlobalConstantVector(const ConstantVector* CP);
 437     void EmitGlobalConstantFP(const ConstantFP* CFP, unsigned AddrSpace);
 438     void EmitGlobalConstantLargeInt(const ConstantInt* CI, unsigned AddrSpace);
 439     GCMetadataPrinter *GetOrCreateGCPrinter(GCStrategy *C);
 440   };
 441 }
 442
 443 #endif