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