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