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 #include <set>
  22
  23 namespace llvm {
  24   class Constant;
  25   class ConstantArray;
  26   class GlobalVariable;
  27   class GlobalAlias;
  28   class MachineConstantPoolEntry;
  29   class MachineConstantPoolValue;
  30   class Mangler;
  31   class TargetAsmInfo;
  32   class Type;
  33
  34   /// AsmPrinter - This class is intended to be used as a driving class for all
  35   /// asm writers.
  36   class AsmPrinter : public MachineFunctionPass {
  37     static char ID;
  38
  39     /// FunctionNumber - This provides a unique ID for each function emitted in
  40     /// this translation unit.  It is autoincremented by SetupMachineFunction,
  41     /// and can be accessed with getFunctionNumber() and
  42     /// IncrementFunctionNumber().
  43     ///
  44     unsigned FunctionNumber;
  45
  46   protected:
  47     // Necessary for external weak linkage support
  48     std::set<const GlobalValue*> ExtWeakSymbols;
  49
  50   public:
  51     /// Output stream on which we're printing assembly code.
  52     ///
  53     std::ostream &O;
  54
  55     /// Target machine description.
  56     ///
  57     TargetMachine &TM;
  58
  59     /// Target Asm Printer information.
  60     ///
  61     const TargetAsmInfo *TAI;
  62
  63     /// Name-mangler for global names.
  64     ///
  65     Mangler *Mang;
  66
  67     /// Cache of mangled name for current function. This is recalculated at the
  68     /// beginning of each call to runOnMachineFunction().
  69     ///
  70     std::string CurrentFnName;
  71
  72     /// CurrentSection - The current section we are emitting to.  This is
  73     /// controlled and used by the SwitchSection method.
  74     std::string CurrentSection;
  75
  76   protected:
  77     AsmPrinter(std::ostream &o, TargetMachine &TM, const TargetAsmInfo *T);
  78
  79   public:
  80     /// SwitchToTextSection - Switch to the specified section of the executable
  81     /// if we are not already in it!  If GV is non-null and if the global has an
  82     /// explicitly requested section, we switch to the section indicated for the
  83     /// global instead of NewSection.
  84     ///
  85     /// If the new section is an empty string, this method forgets what the
  86     /// current section is, but does not emit a .section directive.
  87     ///
  88     /// This method is used when about to emit executable code.
  89     ///
  90     void SwitchToTextSection(const char *NewSection, const GlobalValue *GV = NULL);
  91
  92     /// SwitchToDataSection - Switch to the specified section of the executable
  93     /// if we are not already in it!  If GV is non-null and if the global has an
  94     /// explicitly requested section, we switch to the section indicated for the
  95     /// global instead of NewSection.
  96     ///
  97     /// If the new section is an empty string, this method forgets what the
  98     /// current section is, but does not emit a .section directive.
  99     ///
 100     /// This method is used when about to emit data.  For most assemblers, this
 101     /// is the same as the SwitchToTextSection method, but not all assemblers
 102     /// are the same.
 103     ///
 104     void SwitchToDataSection(const char *NewSection, const GlobalValue *GV = NULL);
 105
 106     /// getGlobalLinkName - Returns the asm/link name of of the specified
 107     /// global variable.  Should be overridden by each target asm printer to
 108     /// generate the appropriate value.
 109     virtual const std::string getGlobalLinkName(const GlobalVariable *GV) const;
 110
 111     /// EmitExternalGlobal - Emit the external reference to a global variable.
 112     /// Should be overridden if an indirect reference should be used.
 113     virtual void EmitExternalGlobal(const GlobalVariable *GV);
 114
 115     /// getCurrentFunctionEHName - Called to return (and cache) the
 116     /// CurrentFnEHName.
 117     ///
 118     std::string getCurrentFunctionEHName(const MachineFunction *MF);
 119
 120   protected:
 121     /// getAnalysisUsage - Record analysis usage.
 122     ///
 123     void getAnalysisUsage(AnalysisUsage &AU) const;
 124
 125     /// doInitialization - Set up the AsmPrinter when we are working on a new
 126     /// module.  If your pass overrides this, it must make sure to explicitly
 127     /// call this implementation.
 128     bool doInitialization(Module &M);
 129
 130     /// doFinalization - Shut down the asmprinter.  If you override this in your
 131     /// pass, you must make sure to call it explicitly.
 132     bool doFinalization(Module &M);
 133
 134     /// PrintSpecial - Print information related to the specified machine instr
 135     /// that is independent of the operand, and may be independent of the instr
 136     /// itself.  This can be useful for portably encoding the comment character
 137     /// or other bits of target-specific knowledge into the asmstrings.  The
 138     /// syntax used is ${:comment}.  Targets can override this to add support
 139     /// for their own strange codes.
 140     virtual void PrintSpecial(const MachineInstr *MI, const char *Code);
 141
 142     /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
 143     /// instruction, using the specified assembler variant.  Targets should
 144     /// override this to format as appropriate.  This method can return true if
 145     /// the operand is erroneous.
 146     virtual bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
 147                                  unsigned AsmVariant, const char *ExtraCode);
 148
 149     /// PrintAsmMemoryOperand - Print the specified operand of MI, an INLINEASM
 150     /// instruction, using the specified assembler variant as an address.
 151     /// Targets should override this to format as appropriate.  This method can
 152     /// return true if the operand is erroneous.
 153     virtual bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
 154                                        unsigned AsmVariant,
 155                                        const char *ExtraCode);
 156
 157     /// getSectionForFunction - Return the section that we should emit the
 158     /// specified function body into.  This defaults to 'TextSection'.  This
 159     /// should most likely be overridden by the target to put linkonce/weak
 160     /// functions into special sections.
 161     virtual std::string getSectionForFunction(const Function &F) const;
 162
 163     /// SetupMachineFunction - This should be called when a new MachineFunction
 164     /// is being processed from runOnMachineFunction.
 165     void SetupMachineFunction(MachineFunction &MF);
 166
 167     /// getFunctionNumber - Return a unique ID for the current function.
 168     ///
 169     unsigned getFunctionNumber() const { return FunctionNumber; }
 170
 171     /// IncrementFunctionNumber - Increase Function Number.  AsmPrinters should
 172     /// not normally call this, as the counter is automatically bumped by
 173     /// SetupMachineFunction.
 174     void IncrementFunctionNumber() { FunctionNumber++; }
 175
 176     /// EmitConstantPool - Print to the current output stream assembly
 177     /// representations of the constants in the constant pool MCP. This is
 178     /// used to print out constants which have been "spilled to memory" by
 179     /// the code generator.
 180     ///
 181     void EmitConstantPool(MachineConstantPool *MCP);
 182
 183     /// EmitJumpTableInfo - Print assembly representations of the jump tables
 184     /// used by the current function to the current output stream.
 185     ///
 186     void EmitJumpTableInfo(MachineJumpTableInfo *MJTI, MachineFunction &MF);
 187
 188     /// EmitSpecialLLVMGlobal - Check to see if the specified global is a
 189     /// special global used by LLVM.  If so, emit it and return true, otherwise
 190     /// do nothing and return false.
 191     bool EmitSpecialLLVMGlobal(const GlobalVariable *GV);
 192
 193   public:
 194     //===------------------------------------------------------------------===//
 195     /// LEB 128 number encoding.
 196
 197     /// PrintULEB128 - Print a series of hexidecimal values(separated by commas)
 198     /// representing an unsigned leb128 value.
 199     void PrintULEB128(unsigned Value) const;
 200
 201     /// SizeULEB128 - Compute the number of bytes required for an unsigned
 202     /// leb128 value.
 203     static unsigned SizeULEB128(unsigned Value);
 204
 205     /// PrintSLEB128 - Print a series of hexidecimal values(separated by commas)
 206     /// representing a signed leb128 value.
 207     void PrintSLEB128(int Value) const;
 208
 209     /// SizeSLEB128 - Compute the number of bytes required for a signed leb128
 210     /// value.
 211     static unsigned SizeSLEB128(int Value);
 212
 213     //===------------------------------------------------------------------===//
 214     // Emission and print routines
 215     //
 216
 217     /// PrintHex - Print a value as a hexidecimal value.
 218     ///
 219     void PrintHex(int Value) const;
 220
 221     /// EOL - Print a newline character to asm stream.  If a comment is present
 222     /// then it will be printed first.  Comments should not contain '\n'.
 223     void EOL() const;
 224     void EOL(const std::string &Comment) const;
 225
 226     /// EmitULEB128Bytes - Emit an assembler byte data directive to compose an
 227     /// unsigned leb128 value.
 228     void EmitULEB128Bytes(unsigned Value) const;
 229
 230     /// EmitSLEB128Bytes - print an assembler byte data directive to compose a
 231     /// signed leb128 value.
 232     void EmitSLEB128Bytes(int Value) const;
 233
 234     /// EmitInt8 - Emit a byte directive and value.
 235     ///
 236     void EmitInt8(int Value) const;
 237
 238     /// EmitInt16 - Emit a short directive and value.
 239     ///
 240     void EmitInt16(int Value) const;
 241
 242     /// EmitInt32 - Emit a long directive and value.
 243     ///
 244     void EmitInt32(int Value) const;
 245
 246     /// EmitInt64 - Emit a long long directive and value.
 247     ///
 248     void EmitInt64(uint64_t Value) const;
 249
 250     /// EmitString - Emit a string with quotes and a null terminator.
 251     /// Special characters are emitted properly.
 252     /// @verbatim (Eg. '\t') @endverbatim
 253     void EmitString(const std::string &String) const;
 254
 255     /// EmitFile - Emit a .file directive.
 256     void EmitFile(unsigned Number, const std::string &Name) const;
 257
 258     //===------------------------------------------------------------------===//
 259
 260     /// EmitAlignment - Emit an alignment directive to the specified power of
 261     /// two boundary.  For example, if you pass in 3 here, you will get an 8
 262     /// byte alignment.  If a global value is specified, and if that global has
 263     /// an explicit alignment requested, it will unconditionally override the
 264     /// alignment request.  However, if ForcedAlignBits is specified, this value
 265     /// has final say: the ultimate alignment will be the max of ForcedAlignBits
 266     /// and the alignment computed with NumBits and the global. If UseFillExpr
 267     /// is true, it also emits an optional second value FillValue which the
 268     /// assembler uses to fill gaps to match alignment.
 269     ///
 270     /// The algorithm is:
 271     ///     Align = NumBits;
 272     ///     if (GV && GV->hasalignment) Align = GV->getalignment();
 273     ///     Align = std::max(Align, ForcedAlignBits);
 274     ///
 275     void EmitAlignment(unsigned NumBits, const GlobalValue *GV = 0,
 276                        unsigned ForcedAlignBits = 0, bool UseFillExpr = false,
 277                        unsigned FillValue = 0) const;
 278
 279   protected:
 280     /// EmitZeros - Emit a block of zeros.
 281     ///
 282     void EmitZeros(uint64_t NumZeros) const;
 283
 284     /// EmitString - Emit a zero-byte-terminated string constant.
 285     ///
 286     virtual void EmitString(const ConstantArray *CVA) const;
 287
 288     /// EmitConstantValueOnly - Print out the specified constant, without a
 289     /// storage class.  Only constants of first-class type are allowed here.
 290     void EmitConstantValueOnly(const Constant *CV);
 291
 292     /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
 293     /// If Packed is false, pad to the ABI size.
 294     void EmitGlobalConstant(const Constant* CV, bool Packed = false);
 295
 296     virtual void EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV);
 297
 298     /// printInlineAsm - This method formats and prints the specified machine
 299     /// instruction that is an inline asm.
 300     void printInlineAsm(const MachineInstr *MI) const;
 301
 302     /// printLabel - This method prints a local label used by debug and
 303     /// exception handling tables.
 304     void printLabel(const MachineInstr *MI) const;
 305
 306     /// printBasicBlockLabel - This method prints the label for the specified
 307     /// MachineBasicBlock
 308     virtual void printBasicBlockLabel(const MachineBasicBlock *MBB,
 309                                       bool printColon = false,
 310                                       bool printComment = true) const;
 311
 312     /// printPICJumpTableSetLabel - This method prints a set label for the
 313     /// specified MachineBasicBlock for a jumptable entry.
 314     virtual void printPICJumpTableSetLabel(unsigned uid,
 315                                            const MachineBasicBlock *MBB) const;
 316     virtual void printPICJumpTableSetLabel(unsigned uid, unsigned uid2,
 317                                            const MachineBasicBlock *MBB) const;
 318     virtual void printPICJumpTableEntry(const MachineJumpTableInfo *MJTI,
 319                                         const MachineBasicBlock *MBB,
 320                                         unsigned uid) const;
 321
 322     /// printDataDirective - This method prints the asm directive for the
 323     /// specified type.
 324     void printDataDirective(const Type *type);
 325
 326   private:
 327     void EmitLLVMUsedList(Constant *List);
 328     void EmitXXStructorList(Constant *List);
 329     void EmitConstantPool(unsigned Alignment, const char *Section,
 330                 std::vector<std::pair<MachineConstantPoolEntry,unsigned> > &CP);
 331
 332   };
 333 }
 334
 335 #endif