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 Twine;
  56   class Type;
  57   class formatted_raw_ostream;
  58
  59   /// AsmPrinter - This class is intended to be used as a driving class for all
  60   /// asm writers.
  61   class AsmPrinter : public MachineFunctionPass {
  62     static char ID;
  63
  64     // GCMetadataPrinters - The garbage collection metadata printer table.
  65     typedef DenseMap<GCStrategy*,GCMetadataPrinter*> gcp_map_type;
  66     typedef gcp_map_type::iterator gcp_iterator;
  67     gcp_map_type GCMetadataPrinters;
  68
  69     /// If VerboseAsm is set, a pointer to the loop info for this
  70     /// function.
  71     ///
  72     MachineLoopInfo *LI;
  73
  74   public:
  75     /// MMI - If available, this is a pointer to the current MachineModuleInfo.
  76     MachineModuleInfo *MMI;
  77
  78   protected:
  79     /// DW - If available, this is a pointer to the current dwarf writer.
  80     DwarfWriter *DW;
  81
  82   public:
  83
  84     /// Output stream on which we're printing assembly code.
  85     ///
  86     formatted_raw_ostream &O;
  87
  88     /// Target machine description.
  89     ///
  90     TargetMachine &TM;
  91
  92     /// getObjFileLowering - Return information about object file lowering.
  93     TargetLoweringObjectFile &getObjFileLowering() const;
  94
  95     /// Target Asm Printer information.
  96     ///
  97     const MCAsmInfo *MAI;
  98
  99     /// Target Register Information.
 100     ///
 101     const TargetRegisterInfo *TRI;
 102
 103     /// OutContext - This is the context for the output file that we are
 104     /// streaming.  This owns all of the global MC-related objects for the
 105     /// generated translation unit.
 106     MCContext &OutContext;
 107
 108     /// OutStreamer - This is the MCStreamer object for the file we are
 109     /// generating.  This contains the transient state for the current
 110     /// translation unit that we are generating (such as the current section
 111     /// etc).
 112     MCStreamer &OutStreamer;
 113
 114     /// The current machine function.
 115     const MachineFunction *MF;
 116
 117     /// Name-mangler for global names.
 118     ///
 119     Mangler *Mang;
 120
 121     /// The symbol for the current function. This is recalculated at the
 122     /// beginning of each call to runOnMachineFunction().
 123     ///
 124     MCSymbol *CurrentFnSym;
 125
 126     /// getCurrentSection() - Return the current section we are emitting to.
 127     const MCSection *getCurrentSection() const;
 128
 129
 130     /// VerboseAsm - Emit comments in assembly output if this is true.
 131     ///
 132     bool VerboseAsm;
 133
 134     /// Private state for PrintSpecial()
 135     // Assign a unique ID to this machine instruction.
 136     mutable const MachineInstr *LastMI;
 137     mutable const Function *LastFn;
 138     mutable unsigned Counter;
 139     mutable unsigned SetCounter;
 140
 141   protected:
 142     explicit AsmPrinter(formatted_raw_ostream &o, TargetMachine &TM,
 143                         MCStreamer &Streamer);
 144
 145   public:
 146     virtual ~AsmPrinter();
 147
 148     /// isVerbose - Return true if assembly output should contain comments.
 149     ///
 150     bool isVerbose() const { return VerboseAsm; }
 151
 152     /// getFunctionNumber - Return a unique ID for the current function.
 153     ///
 154     unsigned getFunctionNumber() const;
 155
 156   protected:
 157     /// getAnalysisUsage - Record analysis usage.
 158     ///
 159     void getAnalysisUsage(AnalysisUsage &AU) const;
 160
 161     /// doInitialization - Set up the AsmPrinter when we are working on a new
 162     /// module.  If your pass overrides this, it must make sure to explicitly
 163     /// call this implementation.
 164     bool doInitialization(Module &M);
 165
 166     /// EmitStartOfAsmFile - This virtual method can be overridden by targets
 167     /// that want to emit something at the start of their file.
 168     virtual void EmitStartOfAsmFile(Module &) {}
 169
 170     /// EmitEndOfAsmFile - This virtual method can be overridden by targets that
 171     /// want to emit something at the end of their file.
 172     virtual void EmitEndOfAsmFile(Module &) {}
 173
 174     /// doFinalization - Shut down the asmprinter.  If you override this in your
 175     /// pass, you must make sure to call it explicitly.
 176     bool doFinalization(Module &M);
 177
 178     /// PrintSpecial - Print information related to the specified machine instr
 179     /// that is independent of the operand, and may be independent of the instr
 180     /// itself.  This can be useful for portably encoding the comment character
 181     /// or other bits of target-specific knowledge into the asmstrings.  The
 182     /// syntax used is ${:comment}.  Targets can override this to add support
 183     /// for their own strange codes.
 184     virtual void PrintSpecial(const MachineInstr *MI, raw_ostream &OS,
 185                               const char *Code) const;
 186
 187     /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
 188     /// instruction, using the specified assembler variant.  Targets should
 189     /// override this to format as appropriate.  This method can return true if
 190     /// the operand is erroneous.
 191     virtual bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
 192                                  unsigned AsmVariant, const char *ExtraCode);
 193
 194     /// PrintAsmMemoryOperand - Print the specified operand of MI, an INLINEASM
 195     /// instruction, using the specified assembler variant as an address.
 196     /// Targets should override this to format as appropriate.  This method can
 197     /// return true if the operand is erroneous.
 198     virtual bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
 199                                        unsigned AsmVariant,
 200                                        const char *ExtraCode);
 201
 202     /// runOnMachineFunction - Emit the specified function out to the
 203     /// OutStreamer.
 204     virtual bool runOnMachineFunction(MachineFunction &MF) {
 205       SetupMachineFunction(MF);
 206       EmitFunctionHeader();
 207       EmitFunctionBody();
 208       return false;
 209     }
 210
 211     /// SetupMachineFunction - This should be called when a new MachineFunction
 212     /// is being processed from runOnMachineFunction.
 213     void SetupMachineFunction(MachineFunction &MF);
 214
 215     /// EmitFunctionHeader - This method emits the header for the current
 216     /// function.
 217     void EmitFunctionHeader();
 218
 219     /// EmitFunctionBody - This method emits the body and trailer for a
 220     /// function.
 221     void EmitFunctionBody();
 222
 223     /// EmitInstruction - Targets should implement this to emit instructions.
 224     virtual void EmitInstruction(const MachineInstr *) {
 225       assert(0 && "EmitInstruction not implemented");
 226     }
 227
 228     /// EmitFunctionBodyStart - Targets can override this to emit stuff before
 229     /// the first basic block in the function.
 230     virtual void EmitFunctionBodyStart() {}
 231
 232     /// EmitFunctionBodyEnd - Targets can override this to emit stuff after
 233     /// the last basic block in the function.
 234     virtual void EmitFunctionBodyEnd() {}
 235
 236     /// EmitConstantPool - Print to the current output stream assembly
 237     /// representations of the constants in the constant pool MCP. This is
 238     /// used to print out constants which have been "spilled to memory" by
 239     /// the code generator.
 240     ///
 241     virtual void EmitConstantPool();
 242
 243     /// EmitJumpTableInfo - Print assembly representations of the jump tables
 244     /// used by the current function to the current output stream.
 245     ///
 246     void EmitJumpTableInfo();
 247
 248     /// EmitGlobalVariable - Emit the specified global variable to the .s file.
 249     virtual void EmitGlobalVariable(const GlobalVariable *GV);
 250
 251     /// EmitSpecialLLVMGlobal - Check to see if the specified global is a
 252     /// special global used by LLVM.  If so, emit it and return true, otherwise
 253     /// do nothing and return false.
 254     bool EmitSpecialLLVMGlobal(const GlobalVariable *GV);
 255
 256   public:
 257     //===------------------------------------------------------------------===//
 258     // Emission and print routines
 259     //
 260
 261     /// EmitInt8 - Emit a byte directive and value.
 262     ///
 263     void EmitInt8(int Value) const;
 264
 265     /// EmitInt16 - Emit a short directive and value.
 266     ///
 267     void EmitInt16(int Value) const;
 268
 269     /// EmitInt32 - Emit a long directive and value.
 270     ///
 271     void EmitInt32(int Value) const;
 272
 273     /// EmitLabelDifference - Emit something like ".long Hi-Lo" where the size
 274     /// in bytes of the directive is specified by Size and Hi/Lo specify the
 275     /// labels.  This implicitly uses .set if it is available.
 276     void EmitLabelDifference(const MCSymbol *Hi, const MCSymbol *Lo,
 277                              unsigned Size) const;
 278
 279     //===------------------------------------------------------------------===//
 280
 281     /// EmitAlignment - Emit an alignment directive to the specified power of
 282     /// two boundary.  For example, if you pass in 3 here, you will get an 8
 283     /// byte alignment.  If a global value is specified, and if that global has
 284     /// an explicit alignment requested, it will unconditionally override the
 285     /// alignment request.  However, if ForcedAlignBits is specified, this value
 286     /// has final say: the ultimate alignment will be the max of ForcedAlignBits
 287     /// and the alignment computed with NumBits and the global.  If UseFillExpr
 288     /// is true, it also emits an optional second value FillValue which the
 289     /// assembler uses to fill gaps to match alignment for text sections if the
 290     /// has specified a non-zero fill value.
 291     ///
 292     /// The algorithm is:
 293     ///     Align = NumBits;
 294     ///     if (GV && GV->hasalignment) Align = GV->getalignment();
 295     ///     Align = std::max(Align, ForcedAlignBits);
 296     ///
 297     void EmitAlignment(unsigned NumBits, const GlobalValue *GV = 0,
 298                        unsigned ForcedAlignBits = 0,
 299                        bool UseFillExpr = true) const;
 300
 301     /// printDeclare - This method prints a local variable declaration used by
 302     /// debug tables.
 303     void printDeclare(const MachineInstr *MI) const;
 304
 305     /// GetSymbolWithGlobalValueBase - Return the MCSymbol for a symbol with
 306     /// global value name as its base, with the specified suffix, and where the
 307     /// symbol is forced to have private linkage if ForcePrivate is true.
 308     MCSymbol *GetSymbolWithGlobalValueBase(const GlobalValue *GV,
 309                                            StringRef Suffix,
 310                                            bool ForcePrivate = true) const;
 311
 312     /// GetExternalSymbolSymbol - Return the MCSymbol for the specified
 313     /// ExternalSymbol.
 314     MCSymbol *GetExternalSymbolSymbol(StringRef Sym) const;
 315
 316     /// GetCPISymbol - Return the symbol for the specified constant pool entry.
 317     MCSymbol *GetCPISymbol(unsigned CPID) const;
 318
 319     /// GetJTISymbol - Return the symbol for the specified jump table entry.
 320     MCSymbol *GetJTISymbol(unsigned JTID, bool isLinkerPrivate = false) const;
 321
 322     /// GetJTSetSymbol - Return the symbol for the specified jump table .set
 323     /// FIXME: privatize to AsmPrinter.
 324     MCSymbol *GetJTSetSymbol(unsigned UID, unsigned MBBID) const;
 325
 326     /// GetBlockAddressSymbol - Return the MCSymbol used to satisfy BlockAddress
 327     /// uses of the specified basic block.
 328     MCSymbol *GetBlockAddressSymbol(const BlockAddress *BA) const;
 329     MCSymbol *GetBlockAddressSymbol(const BasicBlock *BB) const;
 330
 331     /// EmitBasicBlockStart - This method prints the label for the specified
 332     /// MachineBasicBlock, an alignment (if present) and a comment describing
 333     /// it if appropriate.
 334     void EmitBasicBlockStart(const MachineBasicBlock *MBB) const;
 335
 336
 337     // Data emission.
 338
 339     /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
 340     void EmitGlobalConstant(const Constant* CV, unsigned AddrSpace = 0);
 341
 342   protected:
 343     virtual void EmitFunctionEntryLabel();
 344
 345     virtual void EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV);
 346
 347     /// printOffset - This is just convenient handler for printing offsets.
 348     void printOffset(int64_t Offset, raw_ostream &OS) const;
 349
 350     /// isBlockOnlyReachableByFallthough - Return true if the basic block has
 351     /// exactly one predecessor and the control transfer mechanism between
 352     /// the predecessor and this block is a fall-through.
 353     virtual bool
 354     isBlockOnlyReachableByFallthrough(const MachineBasicBlock *MBB) const;
 355
 356   private:
 357     /// EmitInlineAsm - Emit a blob of inline asm to the output streamer.
 358     void EmitInlineAsm(StringRef Str) const;
 359
 360     /// processDebugLoc - Processes the debug information of each machine
 361     /// instruction's DebugLoc.
 362     void processDebugLoc(const MachineInstr *MI, bool BeforePrintingInsn);
 363
 364     void printLabelInst(const MachineInstr *MI) const;
 365
 366     /// printInlineAsm - This method formats and prints the specified machine
 367     /// instruction that is an inline asm.
 368     void printInlineAsm(const MachineInstr *MI) const;
 369
 370     /// printImplicitDef - This method prints the specified machine instruction
 371     /// that is an implicit def.
 372     void printImplicitDef(const MachineInstr *MI) const;
 373
 374     /// printKill - This method prints the specified kill machine instruction.
 375     void printKill(const MachineInstr *MI) const;
 376
 377     /// EmitVisibility - This emits visibility information about symbol, if
 378     /// this is suported by the target.
 379     void EmitVisibility(MCSymbol *Sym, unsigned Visibility) const;
 380
 381     void EmitLinkage(unsigned Linkage, MCSymbol *GVSym) const;
 382
 383     void EmitJumpTableEntry(const MachineJumpTableInfo *MJTI,
 384                             const MachineBasicBlock *MBB,
 385                             unsigned uid) const;
 386     void EmitLLVMUsedList(Constant *List);
 387     void EmitXXStructorList(Constant *List);
 388     GCMetadataPrinter *GetOrCreateGCPrinter(GCStrategy *C);
 389   };
 390 }
 391
 392 #endif