AsmPrinter.h revision 3ce9b67e0c0f171c6d09c19407930ce6989f1b9d
1//===-- llvm/CodeGen/AsmPrinter.h - AsmPrinter Framework --------*- C++ -*-===// 2// 3// The LLVM Compiler Infrastructure 4// 5// This file was developed by the LLVM research group and is distributed under 6// the University of Illinois Open Source 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 22namespace llvm { 23 class Constant; 24 class ConstantArray; 25 class GlobalVariable; 26 class MachineConstantPoolEntry; 27 class MachineConstantPoolValue; 28 class Mangler; 29 class TargetAsmInfo; 30 31 32 /// AsmPrinter - This class is intended to be used as a driving class for all 33 /// asm writers. 34 class AsmPrinter : public MachineFunctionPass { 35 /// FunctionNumber - This provides a unique ID for each function emitted in 36 /// this translation unit. It is autoincremented by SetupMachineFunction, 37 /// and can be accessed with getFunctionNumber() and 38 /// IncrementFunctionNumber(). 39 /// 40 unsigned FunctionNumber; 41 42 public: 43 /// Output stream on which we're printing assembly code. 44 /// 45 std::ostream &O; 46 47 /// Target machine description. 48 /// 49 TargetMachine &TM; 50 51 /// Target Asm Printer information. 52 /// 53 const TargetAsmInfo *TAI; 54 55 /// Name-mangler for global names. 56 /// 57 Mangler *Mang; 58 59 /// Cache of mangled name for current function. This is recalculated at the 60 /// beginning of each call to runOnMachineFunction(). 61 /// 62 std::string CurrentFnName; 63 64 /// CurrentSection - The current section we are emitting to. This is 65 /// controlled and used by the SwitchSection method. 66 std::string CurrentSection; 67 68 protected: 69 AsmPrinter(std::ostream &o, TargetMachine &TM, const TargetAsmInfo *T); 70 71 public: 72 /// SwitchToTextSection - Switch to the specified section of the executable 73 /// if we are not already in it! If GV is non-null and if the global has an 74 /// explicitly requested section, we switch to the section indicated for the 75 /// global instead of NewSection. 76 /// 77 /// If the new section is an empty string, this method forgets what the 78 /// current section is, but does not emit a .section directive. 79 /// 80 /// This method is used when about to emit executable code. 81 /// 82 void SwitchToTextSection(const char *NewSection, const GlobalValue *GV); 83 84 /// SwitchToDataSection - Switch to the specified section of the executable 85 /// if we are not already in it! If GV is non-null and if the global has an 86 /// explicitly requested section, we switch to the section indicated for the 87 /// global instead of NewSection. 88 /// 89 /// If the new section is an empty string, this method forgets what the 90 /// current section is, but does not emit a .section directive. 91 /// 92 /// This method is used when about to emit data. For most assemblers, this 93 /// is the same as the SwitchToTextSection method, but not all assemblers 94 /// are the same. 95 /// 96 void SwitchToDataSection(const char *NewSection, const GlobalValue *GV); 97 98 /// getPreferredAlignmentLog - Return the preferred alignment of the 99 /// specified global, returned in log form. This includes an explicitly 100 /// requested alignment (if the global has one). 101 unsigned getPreferredAlignmentLog(const GlobalVariable *GV) const; 102 protected: 103 /// doInitialization - Set up the AsmPrinter when we are working on a new 104 /// module. If your pass overrides this, it must make sure to explicitly 105 /// call this implementation. 106 bool doInitialization(Module &M); 107 108 /// doFinalization - Shut down the asmprinter. If you override this in your 109 /// pass, you must make sure to call it explicitly. 110 bool doFinalization(Module &M); 111 112 /// PrintSpecial - Print information related to the specified machine instr 113 /// that is independent of the operand, and may be independent of the instr 114 /// itself. This can be useful for portably encoding the comment character 115 /// or other bits of target-specific knowledge into the asmstrings. The 116 /// syntax used is ${:comment}. Targets can override this to add support 117 /// for their own strange codes. 118 virtual void PrintSpecial(const MachineInstr *MI, const char *Code); 119 120 /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM 121 /// instruction, using the specified assembler variant. Targets should 122 /// override this to format as appropriate. This method can return true if 123 /// the operand is erroneous. 124 virtual bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo, 125 unsigned AsmVariant, const char *ExtraCode); 126 127 /// PrintAsmMemoryOperand - Print the specified operand of MI, an INLINEASM 128 /// instruction, using the specified assembler variant as an address. 129 /// Targets should override this to format as appropriate. This method can 130 /// return true if the operand is erroneous. 131 virtual bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo, 132 unsigned AsmVariant, 133 const char *ExtraCode); 134 135 /// SetupMachineFunction - This should be called when a new MachineFunction 136 /// is being processed from runOnMachineFunction. 137 void SetupMachineFunction(MachineFunction &MF); 138 139 /// getFunctionNumber - Return a unique ID for the current function. 140 /// 141 unsigned getFunctionNumber() const { return FunctionNumber; } 142 143 /// IncrementFunctionNumber - Increase Function Number. AsmPrinters should 144 /// not normally call this, as the counter is automatically bumped by 145 /// SetupMachineFunction. 146 void IncrementFunctionNumber() { FunctionNumber++; } 147 148 /// EmitConstantPool - Print to the current output stream assembly 149 /// representations of the constants in the constant pool MCP. This is 150 /// used to print out constants which have been "spilled to memory" by 151 /// the code generator. 152 /// 153 void EmitConstantPool(MachineConstantPool *MCP); 154 155 /// EmitJumpTableInfo - Print assembly representations of the jump tables 156 /// used by the current function to the current output stream. 157 /// 158 void EmitJumpTableInfo(MachineJumpTableInfo *MJTI); 159 160 /// EmitSpecialLLVMGlobal - Check to see if the specified global is a 161 /// special global used by LLVM. If so, emit it and return true, otherwise 162 /// do nothing and return false. 163 bool EmitSpecialLLVMGlobal(const GlobalVariable *GV); 164 165 /// EmitAlignment - Emit an alignment directive to the specified power of 166 /// two boundary. For example, if you pass in 3 here, you will get an 8 167 /// byte alignment. If a global value is specified, and if that global has 168 /// an explicit alignment requested, it will override the alignment request. 169 void EmitAlignment(unsigned NumBits, const GlobalValue *GV = 0) const; 170 171 /// EmitZeros - Emit a block of zeros. 172 /// 173 void EmitZeros(uint64_t NumZeros) const; 174 175 /// EmitString - Emit a zero-byte-terminated string constant. 176 /// 177 virtual void EmitString(const ConstantArray *CVA) const; 178 179 /// EmitConstantValueOnly - Print out the specified constant, without a 180 /// storage class. Only constants of first-class type are allowed here. 181 void EmitConstantValueOnly(const Constant *CV); 182 183 /// EmitGlobalConstant - Print a general LLVM constant to the .s file. 184 /// 185 void EmitGlobalConstant(const Constant* CV); 186 187 virtual void EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV); 188 189 /// printInlineAsm - This method formats and prints the specified machine 190 /// instruction that is an inline asm. 191 void printInlineAsm(const MachineInstr *MI) const; 192 193 /// printBasicBlockLabel - This method prints the label for the specified 194 /// MachineBasicBlock 195 virtual void printBasicBlockLabel(const MachineBasicBlock *MBB, 196 bool printColon = false, 197 bool printComment = true) const; 198 199 /// printSetLabel - This method prints a set label for the specified 200 /// MachineBasicBlock 201 void printSetLabel(unsigned uid, const MachineBasicBlock *MBB) const; 202 203 /// printDataDirective - This method prints the asm directive for the 204 /// specified type. 205 void printDataDirective(const Type *type); 206 207 private: 208 void EmitLLVMUsedList(Constant *List); 209 void EmitXXStructorList(Constant *List); 210 void EmitConstantPool(unsigned Alignment, const char *Section, 211 std::vector<std::pair<MachineConstantPoolEntry,unsigned> > &CP); 212 213 }; 214} 215 216#endif 217