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;
52 class TargetLoweringObjectFile;
54 class formatted_raw_ostream;
56 /// AsmPrinter - This class is intended to be used as a driving class for all
58 class AsmPrinter : public MachineFunctionPass {
61 /// FunctionNumber - This provides a unique ID for each function emitted in
62 /// this translation unit. It is autoincremented by SetupMachineFunction,
63 /// and can be accessed with getFunctionNumber() and
64 /// IncrementFunctionNumber().
66 unsigned FunctionNumber;
68 // GCMetadataPrinters - The garbage collection metadata printer table.
69 typedef DenseMap<GCStrategy*,GCMetadataPrinter*> gcp_map_type;
70 typedef gcp_map_type::iterator gcp_iterator;
71 gcp_map_type GCMetadataPrinters;
73 /// If VerboseAsm is set, a pointer to the loop info for this
79 /// MMI - If available, this is a pointer to the current MachineModuleInfo.
80 MachineModuleInfo *MMI;
82 /// DW - If available, this is a pointer to the current dwarf writer.
86 /// Output stream on which we're printing assembly code.
88 formatted_raw_ostream &O;
90 /// Target machine description.
94 /// getObjFileLowering - Return information about object file lowering.
95 TargetLoweringObjectFile &getObjFileLowering() const;
97 /// Target Asm Printer information.
101 /// Target Register Information.
103 const TargetRegisterInfo *TRI;
105 /// OutContext - This is the context for the output file that we are
106 /// streaming. This owns all of the global MC-related objects for the
107 /// generated translation unit.
108 MCContext &OutContext;
110 /// OutStreamer - This is the MCStreamer object for the file we are
111 /// generating. This contains the transient state for the current
112 /// translation unit that we are generating (such as the current section
114 MCStreamer &OutStreamer;
116 /// The current machine function.
117 const MachineFunction *MF;
119 /// Name-mangler for global names.
123 /// Cache of mangled name for current function. This is recalculated at the
124 /// beginning of each call to runOnMachineFunction().
126 std::string CurrentFnName;
128 /// getCurrentSection() - Return the current section we are emitting to.
129 const MCSection *getCurrentSection() const;
132 /// VerboseAsm - Emit comments in assembly output if this is true.
136 /// ExuberantAsm - Emit many more comments in assembly output if
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;
147 // Private state for processDebugLock()
148 mutable DebugLocTuple PrevDLT;
151 explicit AsmPrinter(formatted_raw_ostream &o, TargetMachine &TM,
152 const MCAsmInfo *T, bool V);
155 virtual ~AsmPrinter();
157 /// isVerbose - Return true if assembly output should contain comments.
159 bool isVerbose() const { return VerboseAsm; }
161 /// getGlobalLinkName - Returns the asm/link name of of the specified
162 /// global variable. Should be overridden by each target asm printer to
163 /// generate the appropriate value.
164 virtual const std::string &getGlobalLinkName(const GlobalVariable *GV,
165 std::string &LinkName) const;
167 /// EmitExternalGlobal - Emit the external reference to a global variable.
168 /// Should be overridden if an indirect reference should be used.
169 virtual void EmitExternalGlobal(const GlobalVariable *GV);
171 /// getCurrentFunctionEHName - Called to return the CurrentFnEHName.
173 std::string getCurrentFunctionEHName(const MachineFunction *MF) const;
176 /// getAnalysisUsage - Record analysis usage.
178 void getAnalysisUsage(AnalysisUsage &AU) const;
180 /// doInitialization - Set up the AsmPrinter when we are working on a new
181 /// module. If your pass overrides this, it must make sure to explicitly
182 /// call this implementation.
183 bool doInitialization(Module &M);
185 /// doFinalization - Shut down the asmprinter. If you override this in your
186 /// pass, you must make sure to call it explicitly.
187 bool doFinalization(Module &M);
189 /// PrintSpecial - Print information related to the specified machine instr
190 /// that is independent of the operand, and may be independent of the instr
191 /// itself. This can be useful for portably encoding the comment character
192 /// or other bits of target-specific knowledge into the asmstrings. The
193 /// syntax used is ${:comment}. Targets can override this to add support
194 /// for their own strange codes.
195 virtual void PrintSpecial(const MachineInstr *MI, const char *Code) const;
197 /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
198 /// instruction, using the specified assembler variant. Targets should
199 /// override this to format as appropriate. This method can return true if
200 /// the operand is erroneous.
201 virtual bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
202 unsigned AsmVariant, const char *ExtraCode);
204 /// PrintAsmMemoryOperand - Print the specified operand of MI, an INLINEASM
205 /// instruction, using the specified assembler variant as an address.
206 /// Targets should override this to format as appropriate. This method can
207 /// return true if the operand is erroneous.
208 virtual bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
210 const char *ExtraCode);
212 /// PrintGlobalVariable - Emit the specified global variable and its
213 /// initializer to the output stream.
214 virtual void PrintGlobalVariable(const GlobalVariable *GV) = 0;
216 /// SetupMachineFunction - This should be called when a new MachineFunction
217 /// is being processed from runOnMachineFunction.
218 void SetupMachineFunction(MachineFunction &MF);
220 /// getFunctionNumber - Return a unique ID for the current function.
222 unsigned getFunctionNumber() const { return FunctionNumber; }
224 /// IncrementFunctionNumber - Increase Function Number. AsmPrinters should
225 /// not normally call this, as the counter is automatically bumped by
226 /// SetupMachineFunction.
227 void IncrementFunctionNumber() { FunctionNumber++; }
229 /// EmitConstantPool - Print to the current output stream assembly
230 /// representations of the constants in the constant pool MCP. This is
231 /// used to print out constants which have been "spilled to memory" by
232 /// the code generator.
234 void EmitConstantPool(MachineConstantPool *MCP);
236 /// EmitJumpTableInfo - Print assembly representations of the jump tables
237 /// used by the current function to the current output stream.
239 void EmitJumpTableInfo(MachineJumpTableInfo *MJTI, MachineFunction &MF);
241 /// EmitSpecialLLVMGlobal - Check to see if the specified global is a
242 /// special global used by LLVM. If so, emit it and return true, otherwise
243 /// do nothing and return false.
244 bool EmitSpecialLLVMGlobal(const GlobalVariable *GV);
247 //===------------------------------------------------------------------===//
248 /// LEB 128 number encoding.
250 /// PrintULEB128 - Print a series of hexidecimal values(separated by commas)
251 /// representing an unsigned leb128 value.
252 void PrintULEB128(unsigned Value) const;
254 /// PrintSLEB128 - Print a series of hexidecimal values(separated by commas)
255 /// representing a signed leb128 value.
256 void PrintSLEB128(int Value) const;
258 //===------------------------------------------------------------------===//
259 // Emission and print routines
262 /// PrintHex - Print a value as a hexidecimal value.
264 void PrintHex(int Value) const;
266 /// EOL - Print a newline character to asm stream. If a comment is present
267 /// then it will be printed first. Comments should not contain '\n'.
269 void EOL(const std::string &Comment) const;
270 void EOL(const char* Comment) const;
271 void EOL(const std::string &Comment, unsigned DatFormat) const;
272 void EOL(const char* Comment, unsigned DataFormat) 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 instructions
341 void EmitComments(const MCInst &MI) const;
342 /// EmitComments - Pretty-print comments for basic blocks
343 void EmitComments(const MachineBasicBlock &MBB) const;
345 /// printMCInst - Print an MCInst for this target.
347 /// Note, this is only a temporary hack to allow the MCStreamer to print
348 /// instructions, do not use this function outside of llvm-mc.
349 virtual void printMCInst(const MCInst *MI);
352 /// EmitZeros - Emit a block of zeros.
354 void EmitZeros(uint64_t NumZeros, unsigned AddrSpace = 0) const;
356 /// EmitString - Emit a zero-byte-terminated string constant.
358 virtual void EmitString(const ConstantArray *CVA) const;
360 /// EmitConstantValueOnly - Print out the specified constant, without a
361 /// storage class. Only constants of first-class type are allowed here.
362 void EmitConstantValueOnly(const Constant *CV);
364 /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
365 void EmitGlobalConstant(const Constant* CV, unsigned AddrSpace = 0);
367 virtual void EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV);
369 /// processDebugLoc - Processes the debug information of each machine
370 /// instruction's DebugLoc.
371 void processDebugLoc(DebugLoc DL);
373 /// printInlineAsm - This method formats and prints the specified machine
374 /// instruction that is an inline asm.
375 void printInlineAsm(const MachineInstr *MI) const;
377 /// printImplicitDef - This method prints the specified machine instruction
378 /// that is an implicit def.
379 virtual void printImplicitDef(const MachineInstr *MI) const;
381 /// printBasicBlockLabel - This method prints the label for the specified
382 /// MachineBasicBlock
383 virtual void printBasicBlockLabel(const MachineBasicBlock *MBB,
384 bool printAlign = false,
385 bool printColon = false,
386 bool printComment = true) const;
388 /// printPICJumpTableSetLabel - This method prints a set label for the
389 /// specified MachineBasicBlock for a jumptable entry.
390 virtual void printPICJumpTableSetLabel(unsigned uid,
391 const MachineBasicBlock *MBB) const;
392 virtual void printPICJumpTableSetLabel(unsigned uid, unsigned uid2,
393 const MachineBasicBlock *MBB) const;
394 virtual void printPICJumpTableEntry(const MachineJumpTableInfo *MJTI,
395 const MachineBasicBlock *MBB,
398 /// printDataDirective - This method prints the asm directive for the
400 void printDataDirective(const Type *type, unsigned AddrSpace = 0);
402 /// printVisibility - This prints visibility information about symbol, if
403 /// this is suported by the target.
404 void printVisibility(const std::string& Name, unsigned Visibility) const;
406 /// printOffset - This is just convenient handler for printing offsets.
407 void printOffset(int64_t Offset) const;
410 void EmitLLVMUsedList(Constant *List);
411 void EmitXXStructorList(Constant *List);
412 void EmitGlobalConstantStruct(const ConstantStruct* CVS,
414 void EmitGlobalConstantArray(const ConstantArray* CVA, unsigned AddrSpace);
415 void EmitGlobalConstantVector(const ConstantVector* CP);
416 void EmitGlobalConstantFP(const ConstantFP* CFP, unsigned AddrSpace);
417 void EmitGlobalConstantLargeInt(const ConstantInt* CI, unsigned AddrSpace);
418 GCMetadataPrinter *GetOrCreateGCPrinter(GCStrategy *C);