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/CodeGen/MachineFunctionPass.h"
20 #include "llvm/Support/DebugLoc.h"
21 #include "llvm/Target/TargetMachine.h"
22 #include "llvm/ADT/DenseMap.h"
32 class GCMetadataPrinter;
35 class MachineBasicBlock;
36 class MachineFunction;
38 class MachineLoopInfo;
40 class MachineConstantPool;
41 class MachineConstantPoolEntry;
42 class MachineConstantPoolValue;
43 class MachineJumpTableInfo;
44 class MachineModuleInfo;
53 class TargetLoweringObjectFile;
55 class formatted_raw_ostream;
57 /// AsmPrinter - This class is intended to be used as a driving class for all
59 class AsmPrinter : public MachineFunctionPass {
62 /// FunctionNumber - This provides a unique ID for each function emitted in
63 /// this translation unit. It is autoincremented by SetupMachineFunction,
64 /// and can be accessed with getFunctionNumber() and
65 /// IncrementFunctionNumber().
67 unsigned FunctionNumber;
69 // GCMetadataPrinters - The garbage collection metadata printer table.
70 typedef DenseMap<GCStrategy*,GCMetadataPrinter*> gcp_map_type;
71 typedef gcp_map_type::iterator gcp_iterator;
72 gcp_map_type GCMetadataPrinters;
74 /// If VerboseAsm is set, a pointer to the loop info for this
80 /// MMI - If available, this is a pointer to the current MachineModuleInfo.
81 MachineModuleInfo *MMI;
83 /// DW - If available, this is a pointer to the current dwarf writer.
87 /// Output stream on which we're printing assembly code.
89 formatted_raw_ostream &O;
91 /// Target machine description.
95 /// getObjFileLowering - Return information about object file lowering.
96 TargetLoweringObjectFile &getObjFileLowering() const;
98 /// Target Asm Printer information.
100 const MCAsmInfo *MAI;
102 /// Target Register Information.
104 const TargetRegisterInfo *TRI;
106 /// OutContext - This is the context for the output file that we are
107 /// streaming. This owns all of the global MC-related objects for the
108 /// generated translation unit.
109 MCContext &OutContext;
111 /// OutStreamer - This is the MCStreamer object for the file we are
112 /// generating. This contains the transient state for the current
113 /// translation unit that we are generating (such as the current section
115 MCStreamer &OutStreamer;
117 /// The current machine function.
118 const MachineFunction *MF;
120 /// Name-mangler for global names.
124 /// Cache of mangled name for current function. This is recalculated at the
125 /// beginning of each call to runOnMachineFunction().
127 std::string CurrentFnName;
129 /// getCurrentSection() - Return the current section we are emitting to.
130 const MCSection *getCurrentSection() const;
133 /// VerboseAsm - Emit comments in assembly output if this is true.
137 /// ExuberantAsm - Emit many more comments in assembly output if
142 /// Private state for PrintSpecial()
143 // Assign a unique ID to this machine instruction.
144 mutable const MachineInstr *LastMI;
145 mutable const Function *LastFn;
146 mutable unsigned Counter;
148 // Private state for processDebugLock()
149 mutable DebugLocTuple PrevDLT;
152 explicit AsmPrinter(formatted_raw_ostream &o, TargetMachine &TM,
153 const MCAsmInfo *T, bool V);
156 virtual ~AsmPrinter();
158 /// isVerbose - Return true if assembly output should contain comments.
160 bool isVerbose() const { return VerboseAsm; }
162 /// getGlobalLinkName - Returns the asm/link name of of the specified
163 /// global variable. Should be overridden by each target asm printer to
164 /// generate the appropriate value.
165 virtual const std::string &getGlobalLinkName(const GlobalVariable *GV,
166 std::string &LinkName) const;
168 /// EmitExternalGlobal - Emit the external reference to a global variable.
169 /// Should be overridden if an indirect reference should be used.
170 virtual void EmitExternalGlobal(const GlobalVariable *GV);
172 /// getCurrentFunctionEHName - Called to return the CurrentFnEHName.
174 std::string getCurrentFunctionEHName(const MachineFunction *MF) const;
176 /// getFunctionNumber - Return a unique ID for the current function.
178 unsigned getFunctionNumber() const { return FunctionNumber; }
181 /// getAnalysisUsage - Record analysis usage.
183 void getAnalysisUsage(AnalysisUsage &AU) const;
185 /// doInitialization - Set up the AsmPrinter when we are working on a new
186 /// module. If your pass overrides this, it must make sure to explicitly
187 /// call this implementation.
188 bool doInitialization(Module &M);
190 /// doFinalization - Shut down the asmprinter. If you override this in your
191 /// pass, you must make sure to call it explicitly.
192 bool doFinalization(Module &M);
194 /// PrintSpecial - Print information related to the specified machine instr
195 /// that is independent of the operand, and may be independent of the instr
196 /// itself. This can be useful for portably encoding the comment character
197 /// or other bits of target-specific knowledge into the asmstrings. The
198 /// syntax used is ${:comment}. Targets can override this to add support
199 /// for their own strange codes.
200 virtual void PrintSpecial(const MachineInstr *MI, const char *Code) const;
202 /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
203 /// instruction, using the specified assembler variant. Targets should
204 /// override this to format as appropriate. This method can return true if
205 /// the operand is erroneous.
206 virtual bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
207 unsigned AsmVariant, const char *ExtraCode);
209 /// PrintAsmMemoryOperand - Print the specified operand of MI, an INLINEASM
210 /// instruction, using the specified assembler variant as an address.
211 /// Targets should override this to format as appropriate. This method can
212 /// return true if the operand is erroneous.
213 virtual bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
215 const char *ExtraCode);
217 /// PrintGlobalVariable - Emit the specified global variable and its
218 /// initializer to the output stream.
219 virtual void PrintGlobalVariable(const GlobalVariable *GV) = 0;
221 /// SetupMachineFunction - This should be called when a new MachineFunction
222 /// is being processed from runOnMachineFunction.
223 void SetupMachineFunction(MachineFunction &MF);
225 /// IncrementFunctionNumber - Increase Function Number. AsmPrinters should
226 /// not normally call this, as the counter is automatically bumped by
227 /// SetupMachineFunction.
228 void IncrementFunctionNumber() { FunctionNumber++; }
230 /// EmitConstantPool - Print to the current output stream assembly
231 /// representations of the constants in the constant pool MCP. This is
232 /// used to print out constants which have been "spilled to memory" by
233 /// the code generator.
235 void EmitConstantPool(MachineConstantPool *MCP);
237 /// EmitJumpTableInfo - Print assembly representations of the jump tables
238 /// used by the current function to the current output stream.
240 void EmitJumpTableInfo(MachineJumpTableInfo *MJTI, MachineFunction &MF);
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);
248 //===------------------------------------------------------------------===//
249 /// LEB 128 number encoding.
251 /// PrintULEB128 - Print a series of hexidecimal values(separated by commas)
252 /// representing an unsigned leb128 value.
253 void PrintULEB128(unsigned Value) const;
255 /// PrintSLEB128 - Print a series of hexidecimal values(separated by commas)
256 /// representing a signed leb128 value.
257 void PrintSLEB128(int Value) const;
259 //===------------------------------------------------------------------===//
260 // Emission and print routines
263 /// PrintHex - Print a value as a hexidecimal value.
265 void PrintHex(int Value) const;
267 /// EOL - Print a newline character to asm stream. If a comment is present
268 /// then it will be printed first. Comments should not contain '\n'.
270 void EOL(const std::string &Comment) const;
271 void EOL(const char* Comment) const;
272 void EOL(const char *Comment, unsigned Encoding) const;
274 /// EmitULEB128Bytes - Emit an assembler byte data directive to compose an
275 /// unsigned leb128 value.
276 void EmitULEB128Bytes(unsigned Value) const;
278 /// EmitSLEB128Bytes - print an assembler byte data directive to compose a
279 /// signed leb128 value.
280 void EmitSLEB128Bytes(int Value) const;
282 /// EmitInt8 - Emit a byte directive and value.
284 void EmitInt8(int Value) const;
286 /// EmitInt16 - Emit a short directive and value.
288 void EmitInt16(int Value) const;
290 /// EmitInt32 - Emit a long directive and value.
292 void EmitInt32(int Value) const;
294 /// EmitInt64 - Emit a long long directive and value.
296 void EmitInt64(uint64_t Value) const;
298 /// EmitString - Emit a string with quotes and a null terminator.
299 /// Special characters are emitted properly.
300 /// @verbatim (Eg. '\t') @endverbatim
301 void EmitString(const std::string &String) const;
302 void EmitString(const char *String, unsigned Size) const;
304 /// EmitFile - Emit a .file directive.
305 void EmitFile(unsigned Number, const std::string &Name) const;
307 //===------------------------------------------------------------------===//
309 /// EmitAlignment - Emit an alignment directive to the specified power of
310 /// two boundary. For example, if you pass in 3 here, you will get an 8
311 /// byte alignment. If a global value is specified, and if that global has
312 /// an explicit alignment requested, it will unconditionally override the
313 /// alignment request. However, if ForcedAlignBits is specified, this value
314 /// has final say: the ultimate alignment will be the max of ForcedAlignBits
315 /// and the alignment computed with NumBits and the global. If UseFillExpr
316 /// is true, it also emits an optional second value FillValue which the
317 /// assembler uses to fill gaps to match alignment for text sections if the
318 /// has specified a non-zero fill value.
320 /// The algorithm is:
322 /// if (GV && GV->hasalignment) Align = GV->getalignment();
323 /// Align = std::max(Align, ForcedAlignBits);
325 void EmitAlignment(unsigned NumBits, const GlobalValue *GV = 0,
326 unsigned ForcedAlignBits = 0,
327 bool UseFillExpr = true) const;
329 /// printLabel - This method prints a local label used by debug and
330 /// exception handling tables.
331 void printLabel(const MachineInstr *MI) const;
332 void printLabel(unsigned Id) const;
334 /// printDeclare - This method prints a local variable declaration used by
336 void printDeclare(const MachineInstr *MI) const;
338 /// EmitComments - Pretty-print comments for instructions
339 void EmitComments(const MachineInstr &MI) const;
340 /// EmitComments - Pretty-print comments for basic blocks
341 void EmitComments(const MachineBasicBlock &MBB) const;
343 /// printMCInst - Print an MCInst for this target.
345 /// Note, this is only a temporary hack to allow the MCStreamer to print
346 /// instructions, do not use this function outside of llvm-mc.
347 virtual void printMCInst(const MCInst *MI);
349 /// GetMBBSymbol - Return the MCSymbol corresponding to the specified basic
351 MCSymbol *GetMBBSymbol(unsigned MBBID) const;
353 /// printBasicBlockLabel - This method prints the label for the specified
354 /// MachineBasicBlock
355 void printBasicBlockLabel(const MachineBasicBlock *MBB,
356 bool printAlign = false,
357 bool printColon = false,
358 bool printComment = true) const;
360 /// EmitZeros - Emit a block of zeros.
362 void EmitZeros(uint64_t NumZeros, unsigned AddrSpace = 0) const;
364 /// EmitString - Emit a zero-byte-terminated string constant.
366 virtual void EmitString(const ConstantArray *CVA) const;
368 /// EmitConstantValueOnly - Print out the specified constant, without a
369 /// storage class. Only constants of first-class type are allowed here.
370 void EmitConstantValueOnly(const Constant *CV);
372 /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
373 void EmitGlobalConstant(const Constant* CV, unsigned AddrSpace = 0);
375 virtual void EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV);
377 /// processDebugLoc - Processes the debug information of each machine
378 /// instruction's DebugLoc.
379 void processDebugLoc(DebugLoc DL);
381 /// printInlineAsm - This method formats and prints the specified machine
382 /// instruction that is an inline asm.
383 void printInlineAsm(const MachineInstr *MI) const;
385 /// printImplicitDef - This method prints the specified machine instruction
386 /// that is an implicit def.
387 virtual void printImplicitDef(const MachineInstr *MI) const;
390 /// printPICJumpTableSetLabel - This method prints a set label for the
391 /// specified MachineBasicBlock for a jumptable entry.
392 virtual void printPICJumpTableSetLabel(unsigned uid,
393 const MachineBasicBlock *MBB) const;
394 virtual void printPICJumpTableSetLabel(unsigned uid, unsigned uid2,
395 const MachineBasicBlock *MBB) const;
396 virtual void printPICJumpTableEntry(const MachineJumpTableInfo *MJTI,
397 const MachineBasicBlock *MBB,
400 /// printDataDirective - This method prints the asm directive for the
402 void printDataDirective(const Type *type, unsigned AddrSpace = 0);
404 /// printVisibility - This prints visibility information about symbol, if
405 /// this is suported by the target.
406 void printVisibility(const std::string& Name, unsigned Visibility) const;
408 /// printOffset - This is just convenient handler for printing offsets.
409 void printOffset(int64_t Offset) const;
412 void EmitLLVMUsedList(Constant *List);
413 void EmitXXStructorList(Constant *List);
414 void EmitGlobalConstantStruct(const ConstantStruct* CVS,
416 void EmitGlobalConstantArray(const ConstantArray* CVA, unsigned AddrSpace);
417 void EmitGlobalConstantVector(const ConstantVector* CP);
418 void EmitGlobalConstantFP(const ConstantFP* CFP, unsigned AddrSpace);
419 void EmitGlobalConstantLargeInt(const ConstantInt* CI, unsigned AddrSpace);
420 GCMetadataPrinter *GetOrCreateGCPrinter(GCStrategy *C);