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;
84 /// DW - If available, this is a pointer to the current dwarf writer.
88 /// Output stream on which we're printing assembly code.
90 formatted_raw_ostream &O;
92 /// Target machine description.
96 /// getObjFileLowering - Return information about object file lowering.
97 TargetLoweringObjectFile &getObjFileLowering() const;
99 /// Target Asm Printer information.
101 const MCAsmInfo *MAI;
103 /// Target Register Information.
105 const TargetRegisterInfo *TRI;
107 /// OutContext - This is the context for the output file that we are
108 /// streaming. This owns all of the global MC-related objects for the
109 /// generated translation unit.
110 MCContext &OutContext;
112 /// OutStreamer - This is the MCStreamer object for the file we are
113 /// generating. This contains the transient state for the current
114 /// translation unit that we are generating (such as the current section
116 MCStreamer &OutStreamer;
118 /// The current machine function.
119 const MachineFunction *MF;
121 /// Name-mangler for global names.
125 /// Cache of mangled name for current function. This is recalculated at the
126 /// beginning of each call to runOnMachineFunction().
128 std::string CurrentFnName;
130 /// getCurrentSection() - Return the current section we are emitting to.
131 const MCSection *getCurrentSection() const;
134 /// VerboseAsm - Emit comments in assembly output if this is true.
138 /// Private state for PrintSpecial()
139 // Assign a unique ID to this machine instruction.
140 mutable const MachineInstr *LastMI;
141 mutable const Function *LastFn;
142 mutable unsigned Counter;
144 // Private state for processDebugLock()
145 mutable DebugLocTuple PrevDLT;
148 explicit AsmPrinter(formatted_raw_ostream &o, TargetMachine &TM,
149 const MCAsmInfo *T, bool V);
152 virtual ~AsmPrinter();
154 /// isVerbose - Return true if assembly output should contain comments.
156 bool isVerbose() const { return VerboseAsm; }
158 /// getFunctionNumber - Return a unique ID for the current function.
160 unsigned getFunctionNumber() const { return FunctionNumber; }
163 /// getAnalysisUsage - Record analysis usage.
165 void getAnalysisUsage(AnalysisUsage &AU) const;
167 /// doInitialization - Set up the AsmPrinter when we are working on a new
168 /// module. If your pass overrides this, it must make sure to explicitly
169 /// call this implementation.
170 bool doInitialization(Module &M);
172 /// EmitEndOfAsmFile - This virtual method can be overridden by targets that
173 /// want to emit something at the end of their file.
174 virtual void EmitEndOfAsmFile(Module &M) {}
176 /// doFinalization - Shut down the asmprinter. If you override this in your
177 /// pass, you must make sure to call it explicitly.
178 bool doFinalization(Module &M);
180 /// PrintSpecial - Print information related to the specified machine instr
181 /// that is independent of the operand, and may be independent of the instr
182 /// itself. This can be useful for portably encoding the comment character
183 /// or other bits of target-specific knowledge into the asmstrings. The
184 /// syntax used is ${:comment}. Targets can override this to add support
185 /// for their own strange codes.
186 virtual void PrintSpecial(const MachineInstr *MI, const char *Code) const;
188 /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
189 /// instruction, using the specified assembler variant. Targets should
190 /// override this to format as appropriate. This method can return true if
191 /// the operand is erroneous.
192 virtual bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
193 unsigned AsmVariant, const char *ExtraCode);
195 /// PrintAsmMemoryOperand - Print the specified operand of MI, an INLINEASM
196 /// instruction, using the specified assembler variant as an address.
197 /// Targets should override this to format as appropriate. This method can
198 /// return true if the operand is erroneous.
199 virtual bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
201 const char *ExtraCode);
203 /// PrintGlobalVariable - Emit the specified global variable and its
204 /// initializer to the output stream.
205 virtual void PrintGlobalVariable(const GlobalVariable *GV) = 0;
207 /// SetupMachineFunction - This should be called when a new MachineFunction
208 /// is being processed from runOnMachineFunction.
209 void SetupMachineFunction(MachineFunction &MF);
211 /// IncrementFunctionNumber - Increase Function Number. AsmPrinters should
212 /// not normally call this, as the counter is automatically bumped by
213 /// SetupMachineFunction.
214 void IncrementFunctionNumber() { FunctionNumber++; }
216 /// EmitConstantPool - Print to the current output stream assembly
217 /// representations of the constants in the constant pool MCP. This is
218 /// used to print out constants which have been "spilled to memory" by
219 /// the code generator.
221 void EmitConstantPool(MachineConstantPool *MCP);
223 /// EmitJumpTableInfo - Print assembly representations of the jump tables
224 /// used by the current function to the current output stream.
226 void EmitJumpTableInfo(MachineJumpTableInfo *MJTI, MachineFunction &MF);
228 /// EmitSpecialLLVMGlobal - Check to see if the specified global is a
229 /// special global used by LLVM. If so, emit it and return true, otherwise
230 /// do nothing and return false.
231 bool EmitSpecialLLVMGlobal(const GlobalVariable *GV);
234 //===------------------------------------------------------------------===//
235 /// LEB 128 number encoding.
237 /// PrintULEB128 - Print a series of hexidecimal values(separated by commas)
238 /// representing an unsigned leb128 value.
239 void PrintULEB128(unsigned Value) const;
241 /// PrintSLEB128 - Print a series of hexidecimal values(separated by commas)
242 /// representing a signed leb128 value.
243 void PrintSLEB128(int Value) const;
245 //===------------------------------------------------------------------===//
246 // Emission and print routines
249 /// PrintHex - Print a value as a hexidecimal value.
251 void PrintHex(int Value) const;
253 /// EOL - Print a newline character to asm stream. If a comment is present
254 /// then it will be printed first. Comments should not contain '\n'.
256 void EOL(const std::string &Comment) const;
257 void EOL(const char* Comment) const;
258 void EOL(const char *Comment, unsigned Encoding) const;
260 /// EmitULEB128Bytes - Emit an assembler byte data directive to compose an
261 /// unsigned leb128 value.
262 void EmitULEB128Bytes(unsigned Value) const;
264 /// EmitSLEB128Bytes - print an assembler byte data directive to compose a
265 /// signed leb128 value.
266 void EmitSLEB128Bytes(int Value) const;
268 /// EmitInt8 - Emit a byte directive and value.
270 void EmitInt8(int Value) const;
272 /// EmitInt16 - Emit a short directive and value.
274 void EmitInt16(int Value) const;
276 /// EmitInt32 - Emit a long directive and value.
278 void EmitInt32(int Value) const;
280 /// EmitInt64 - Emit a long long directive and value.
282 void EmitInt64(uint64_t Value) const;
284 /// EmitString - Emit a string with quotes and a null terminator.
285 /// Special characters are emitted properly.
286 /// @verbatim (Eg. '\t') @endverbatim
287 void EmitString(const std::string &String) const;
288 void EmitString(const char *String, unsigned Size) const;
290 /// EmitFile - Emit a .file directive.
291 void EmitFile(unsigned Number, const std::string &Name) const;
293 //===------------------------------------------------------------------===//
295 /// EmitAlignment - Emit an alignment directive to the specified power of
296 /// two boundary. For example, if you pass in 3 here, you will get an 8
297 /// byte alignment. If a global value is specified, and if that global has
298 /// an explicit alignment requested, it will unconditionally override the
299 /// alignment request. However, if ForcedAlignBits is specified, this value
300 /// has final say: the ultimate alignment will be the max of ForcedAlignBits
301 /// and the alignment computed with NumBits and the global. If UseFillExpr
302 /// is true, it also emits an optional second value FillValue which the
303 /// assembler uses to fill gaps to match alignment for text sections if the
304 /// has specified a non-zero fill value.
306 /// The algorithm is:
308 /// if (GV && GV->hasalignment) Align = GV->getalignment();
309 /// Align = std::max(Align, ForcedAlignBits);
311 void EmitAlignment(unsigned NumBits, const GlobalValue *GV = 0,
312 unsigned ForcedAlignBits = 0,
313 bool UseFillExpr = true) const;
315 /// printLabel - This method prints a local label used by debug and
316 /// exception handling tables.
317 void printLabel(const MachineInstr *MI) const;
318 void printLabel(unsigned Id) const;
320 /// printDeclare - This method prints a local variable declaration used by
322 void printDeclare(const MachineInstr *MI) const;
324 /// EmitComments - Pretty-print comments for instructions
325 void EmitComments(const MachineInstr &MI) const;
326 /// EmitComments - Pretty-print comments for basic blocks
327 void EmitComments(const MachineBasicBlock &MBB) const;
329 /// GetMBBSymbol - Return the MCSymbol corresponding to the specified basic
331 MCSymbol *GetMBBSymbol(unsigned MBBID) const;
333 /// EmitBasicBlockStart - This method prints the label for the specified
334 /// MachineBasicBlock, an alignment (if present) and a comment describing
335 /// it if appropriate.
336 void EmitBasicBlockStart(const MachineBasicBlock *MBB) const;
338 /// EmitZeros - Emit a block of zeros.
340 void EmitZeros(uint64_t NumZeros, unsigned AddrSpace = 0) const;
342 /// EmitString - Emit a zero-byte-terminated string constant.
344 virtual void EmitString(const ConstantArray *CVA) const;
346 /// EmitConstantValueOnly - Print out the specified constant, without a
347 /// storage class. Only constants of first-class type are allowed here.
348 void EmitConstantValueOnly(const Constant *CV);
350 /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
351 void EmitGlobalConstant(const Constant* CV, unsigned AddrSpace = 0);
353 virtual void EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV);
355 /// processDebugLoc - Processes the debug information of each machine
356 /// instruction's DebugLoc.
357 void processDebugLoc(DebugLoc DL);
359 /// printInlineAsm - This method formats and prints the specified machine
360 /// instruction that is an inline asm.
361 void printInlineAsm(const MachineInstr *MI) const;
363 /// printImplicitDef - This method prints the specified machine instruction
364 /// that is an implicit def.
365 virtual void printImplicitDef(const MachineInstr *MI) const;
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 printPICJumpTableSetLabel(unsigned uid, unsigned uid2,
373 const MachineBasicBlock *MBB) const;
374 virtual void printPICJumpTableEntry(const MachineJumpTableInfo *MJTI,
375 const MachineBasicBlock *MBB,
378 /// printDataDirective - This method prints the asm directive for the
380 void printDataDirective(const Type *type, unsigned AddrSpace = 0);
382 /// printVisibility - This prints visibility information about symbol, if
383 /// this is suported by the target.
384 void printVisibility(const std::string& Name, unsigned Visibility) const;
386 /// printOffset - This is just convenient handler for printing offsets.
387 void printOffset(int64_t Offset) const;
390 void EmitLLVMUsedList(Constant *List);
391 void EmitXXStructorList(Constant *List);
392 void EmitGlobalConstantStruct(const ConstantStruct* CVS,
394 void EmitGlobalConstantArray(const ConstantArray* CVA, unsigned AddrSpace);
395 void EmitGlobalConstantVector(const ConstantVector* CP);
396 void EmitGlobalConstantFP(const ConstantFP* CFP, unsigned AddrSpace);
397 void EmitGlobalConstantLargeInt(const ConstantInt* CI, unsigned AddrSpace);
398 GCMetadataPrinter *GetOrCreateGCPrinter(GCStrategy *C);