1 //===-- llvm/CodeGen/AsmPrinter.h - AsmPrinter Framework --------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_CODEGEN_ASMPRINTER_H
17 #define LLVM_CODEGEN_ASMPRINTER_H
19 #include "llvm/ADT/DenseMap.h"
20 #include "llvm/CodeGen/MachineFunctionPass.h"
21 #include "llvm/Support/DataTypes.h"
22 #include "llvm/Target/TargetMachine.h"
32 class GCMetadataPrinter;
34 class MachineConstantPoolEntry;
35 class MachineConstantPoolValue;
36 class MachineModuleInfo;
43 class formatted_raw_ostream;
45 /// AsmPrinter - This class is intended to be used as a driving class for all
47 class AsmPrinter : public MachineFunctionPass {
50 /// FunctionNumber - This provides a unique ID for each function emitted in
51 /// this translation unit. It is autoincremented by SetupMachineFunction,
52 /// and can be accessed with getFunctionNumber() and
53 /// IncrementFunctionNumber().
55 unsigned FunctionNumber;
57 // GCMetadataPrinters - The garbage collection metadata printer table.
58 typedef DenseMap<GCStrategy*,GCMetadataPrinter*> gcp_map_type;
59 typedef gcp_map_type::iterator gcp_iterator;
60 gcp_map_type GCMetadataPrinters;
63 /// MMI - If available, this is a pointer to the current MachineModuleInfo.
64 MachineModuleInfo *MMI;
66 /// DW - If available, this is a pointer to the current dwarf writer.
70 /// Output stream on which we're printing assembly code.
72 formatted_raw_ostream &O;
74 /// Target machine description.
78 /// Target Asm Printer information.
80 const TargetAsmInfo *TAI;
82 /// Target Register Information.
84 const TargetRegisterInfo *TRI;
86 /// The current machine function.
87 const MachineFunction *MF;
89 /// Name-mangler for global names.
93 /// Cache of mangled name for current function. This is recalculated at the
94 /// beginning of each call to runOnMachineFunction().
96 std::string CurrentFnName;
98 /// CurrentSection - The current section we are emitting to. This is
99 /// controlled and used by the SwitchSection method.
100 std::string CurrentSection;
101 const Section* CurrentSection_;
103 /// IsInTextSection - True if the current section we are emitting to is a
105 bool IsInTextSection;
107 /// VerboseAsm - Emit comments in assembly output if this is true.
111 /// Private state for PrintSpecial()
112 // Assign a unique ID to this machine instruction.
113 mutable const MachineInstr *LastMI;
114 mutable const Function *LastFn;
115 mutable unsigned Counter;
117 // Private state for processDebugLock()
118 mutable DebugLocTuple PrevDLT;
121 explicit AsmPrinter(formatted_raw_ostream &o, TargetMachine &TM,
122 const TargetAsmInfo *T, bool V);
125 virtual ~AsmPrinter();
127 /// isVerbose - Return true if assembly output should contain comments.
129 bool isVerbose() const { return VerboseAsm; }
131 /// SwitchToTextSection - Switch to the specified section of the executable
132 /// if we are not already in it! If GV is non-null and if the global has an
133 /// explicitly requested section, we switch to the section indicated for the
134 /// global instead of NewSection.
136 /// If the new section is an empty string, this method forgets what the
137 /// current section is, but does not emit a .section directive.
139 /// This method is used when about to emit executable code.
141 void SwitchToTextSection(const char *NewSection,
142 const GlobalValue *GV = NULL);
144 /// SwitchToDataSection - Switch to the specified section of the executable
145 /// if we are not already in it! If GV is non-null and if the global has an
146 /// explicitly requested section, we switch to the section indicated for the
147 /// global instead of NewSection.
149 /// If the new section is an empty string, this method forgets what the
150 /// current section is, but does not emit a .section directive.
152 /// This method is used when about to emit data. For most assemblers, this
153 /// is the same as the SwitchToTextSection method, but not all assemblers
156 void SwitchToDataSection(const char *NewSection,
157 const GlobalValue *GV = NULL);
159 /// SwitchToSection - Switch to the specified section of the executable if
160 /// we are not already in it!
161 void SwitchToSection(const Section* NS);
163 /// getGlobalLinkName - Returns the asm/link name of of the specified
164 /// global variable. Should be overridden by each target asm printer to
165 /// generate the appropriate value.
166 virtual const std::string &getGlobalLinkName(const GlobalVariable *GV,
167 std::string &LinkName) const;
169 /// EmitExternalGlobal - Emit the external reference to a global variable.
170 /// Should be overridden if an indirect reference should be used.
171 virtual void EmitExternalGlobal(const GlobalVariable *GV);
173 /// getCurrentFunctionEHName - Called to return the CurrentFnEHName.
175 std::string getCurrentFunctionEHName(const MachineFunction *MF) const;
178 /// getAnalysisUsage - Record analysis usage.
180 void getAnalysisUsage(AnalysisUsage &AU) const;
182 /// doInitialization - Set up the AsmPrinter when we are working on a new
183 /// module. If your pass overrides this, it must make sure to explicitly
184 /// call this implementation.
185 bool doInitialization(Module &M);
187 /// doFinalization - Shut down the asmprinter. If you override this in your
188 /// pass, you must make sure to call it explicitly.
189 bool doFinalization(Module &M);
191 /// PrintSpecial - Print information related to the specified machine instr
192 /// that is independent of the operand, and may be independent of the instr
193 /// itself. This can be useful for portably encoding the comment character
194 /// or other bits of target-specific knowledge into the asmstrings. The
195 /// syntax used is ${:comment}. Targets can override this to add support
196 /// for their own strange codes.
197 virtual void PrintSpecial(const MachineInstr *MI, const char *Code) const;
199 /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
200 /// instruction, using the specified assembler variant. Targets should
201 /// override this to format as appropriate. This method can return true if
202 /// the operand is erroneous.
203 virtual bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
204 unsigned AsmVariant, const char *ExtraCode);
206 /// PrintAsmMemoryOperand - Print the specified operand of MI, an INLINEASM
207 /// instruction, using the specified assembler variant as an address.
208 /// Targets should override this to format as appropriate. This method can
209 /// return true if the operand is erroneous.
210 virtual bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
212 const char *ExtraCode);
214 /// SetupMachineFunction - This should be called when a new MachineFunction
215 /// is being processed from runOnMachineFunction.
216 void SetupMachineFunction(MachineFunction &MF);
218 /// getFunctionNumber - Return a unique ID for the current function.
220 unsigned getFunctionNumber() const { return FunctionNumber; }
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++; }
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.
232 void EmitConstantPool(MachineConstantPool *MCP);
234 /// EmitJumpTableInfo - Print assembly representations of the jump tables
235 /// used by the current function to the current output stream.
237 void EmitJumpTableInfo(MachineJumpTableInfo *MJTI, MachineFunction &MF);
239 /// EmitSpecialLLVMGlobal - Check to see if the specified global is a
240 /// special global used by LLVM. If so, emit it and return true, otherwise
241 /// do nothing and return false.
242 bool EmitSpecialLLVMGlobal(const GlobalVariable *GV);
245 //===------------------------------------------------------------------===//
246 /// LEB 128 number encoding.
248 /// PrintULEB128 - Print a series of hexidecimal values(separated by commas)
249 /// representing an unsigned leb128 value.
250 void PrintULEB128(unsigned Value) const;
252 /// PrintSLEB128 - Print a series of hexidecimal values(separated by commas)
253 /// representing a signed leb128 value.
254 void PrintSLEB128(int Value) const;
256 //===------------------------------------------------------------------===//
257 // Emission and print routines
260 /// PrintHex - Print a value as a hexidecimal value.
262 void PrintHex(int Value) const;
264 /// EOL - Print a newline character to asm stream. If a comment is present
265 /// then it will be printed first. Comments should not contain '\n'.
267 void EOL(const std::string &Comment) const;
268 void EOL(const char* Comment) const;
270 /// EmitULEB128Bytes - Emit an assembler byte data directive to compose an
271 /// unsigned leb128 value.
272 void EmitULEB128Bytes(unsigned Value) const;
274 /// EmitSLEB128Bytes - print an assembler byte data directive to compose a
275 /// signed leb128 value.
276 void EmitSLEB128Bytes(int Value) const;
278 /// EmitInt8 - Emit a byte directive and value.
280 void EmitInt8(int Value) const;
282 /// EmitInt16 - Emit a short directive and value.
284 void EmitInt16(int Value) const;
286 /// EmitInt32 - Emit a long directive and value.
288 void EmitInt32(int Value) const;
290 /// EmitInt64 - Emit a long long directive and value.
292 void EmitInt64(uint64_t Value) const;
294 /// EmitString - Emit a string with quotes and a null terminator.
295 /// Special characters are emitted properly.
296 /// @verbatim (Eg. '\t') @endverbatim
297 void EmitString(const std::string &String) const;
298 void EmitString(const char *String, unsigned Size) const;
300 /// EmitFile - Emit a .file directive.
301 void EmitFile(unsigned Number, const std::string &Name) const;
303 //===------------------------------------------------------------------===//
305 /// EmitAlignment - Emit an alignment directive to the specified power of
306 /// two boundary. For example, if you pass in 3 here, you will get an 8
307 /// byte alignment. If a global value is specified, and if that global has
308 /// an explicit alignment requested, it will unconditionally override the
309 /// alignment request. However, if ForcedAlignBits is specified, this value
310 /// has final say: the ultimate alignment will be the max of ForcedAlignBits
311 /// and the alignment computed with NumBits and the global. If UseFillExpr
312 /// is true, it also emits an optional second value FillValue which the
313 /// assembler uses to fill gaps to match alignment for text sections if the
314 /// has specified a non-zero fill value.
316 /// The algorithm is:
318 /// if (GV && GV->hasalignment) Align = GV->getalignment();
319 /// Align = std::max(Align, ForcedAlignBits);
321 void EmitAlignment(unsigned NumBits, const GlobalValue *GV = 0,
322 unsigned ForcedAlignBits = 0,
323 bool UseFillExpr = true) const;
325 /// printLabel - This method prints a local label used by debug and
326 /// exception handling tables.
327 void printLabel(const MachineInstr *MI) const;
328 void printLabel(unsigned Id) const;
330 /// printDeclare - This method prints a local variable declaration used by
332 void printDeclare(const MachineInstr *MI) const;
334 /// EmitComments - Pretty-print comments for instructions
335 void EmitComments(const MachineInstr &MI) const;
336 /// EmitComments - Pretty-print comments for instructions
337 void EmitComments(const MCInst &MI) const;
340 /// EmitZeros - Emit a block of zeros.
342 void EmitZeros(uint64_t NumZeros, unsigned AddrSpace = 0) const;
344 /// EmitString - Emit a zero-byte-terminated string constant.
346 virtual void EmitString(const ConstantArray *CVA) const;
348 /// EmitConstantValueOnly - Print out the specified constant, without a
349 /// storage class. Only constants of first-class type are allowed here.
350 void EmitConstantValueOnly(const Constant *CV);
352 /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
353 void EmitGlobalConstant(const Constant* CV, unsigned AddrSpace = 0);
355 virtual void EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV);
357 /// processDebugLoc - Processes the debug information of each machine
358 /// instruction's DebugLoc.
359 void processDebugLoc(DebugLoc DL);
361 /// printInlineAsm - This method formats and prints the specified machine
362 /// instruction that is an inline asm.
363 void printInlineAsm(const MachineInstr *MI) const;
365 /// printImplicitDef - This method prints the specified machine instruction
366 /// that is an implicit def.
367 virtual void printImplicitDef(const MachineInstr *MI) const;
369 /// printBasicBlockLabel - This method prints the label for the specified
370 /// MachineBasicBlock
371 virtual void printBasicBlockLabel(const MachineBasicBlock *MBB,
372 bool printAlign = false,
373 bool printColon = false,
374 bool printComment = true) const;
376 /// printPICJumpTableSetLabel - This method prints a set label for the
377 /// specified MachineBasicBlock for a jumptable entry.
378 virtual void printPICJumpTableSetLabel(unsigned uid,
379 const MachineBasicBlock *MBB) const;
380 virtual void printPICJumpTableSetLabel(unsigned uid, unsigned uid2,
381 const MachineBasicBlock *MBB) const;
382 virtual void printPICJumpTableEntry(const MachineJumpTableInfo *MJTI,
383 const MachineBasicBlock *MBB,
386 /// printDataDirective - This method prints the asm directive for the
388 void printDataDirective(const Type *type, unsigned AddrSpace = 0);
390 /// printVisibility - This prints visibility information about symbol, if
391 /// this is suported by the target.
392 void printVisibility(const std::string& Name, unsigned Visibility) const;
394 /// printOffset - This is just convenient handler for printing offsets.
395 void printOffset(int64_t Offset) const;
398 void EmitLLVMUsedList(Constant *List);
399 void EmitXXStructorList(Constant *List);
400 void EmitGlobalConstantStruct(const ConstantStruct* CVS,
402 void EmitGlobalConstantArray(const ConstantArray* CVA, unsigned AddrSpace);
403 void EmitGlobalConstantVector(const ConstantVector* CP);
404 void EmitGlobalConstantFP(const ConstantFP* CFP, unsigned AddrSpace);
405 void EmitGlobalConstantLargeInt(const ConstantInt* CI, unsigned AddrSpace);
406 GCMetadataPrinter *GetOrCreateGCPrinter(GCStrategy *C);