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"
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;
54 class TargetLoweringObjectFile;
57 class formatted_raw_ostream;
59 /// AsmPrinter - This class is intended to be used as a driving class for all
61 class AsmPrinter : public MachineFunctionPass {
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;
69 /// If VerboseAsm is set, a pointer to the loop info for this
75 /// MMI - If available, this is a pointer to the current MachineModuleInfo.
76 MachineModuleInfo *MMI;
79 /// DW - If available, this is a pointer to the current dwarf writer.
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.
91 /// Output stream on which we're printing assembly code.
93 formatted_raw_ostream &O;
95 /// Target machine description.
99 /// getObjFileLowering - Return information about object file lowering.
100 TargetLoweringObjectFile &getObjFileLowering() const;
102 /// Target Asm Printer information.
104 const MCAsmInfo *MAI;
106 /// Target Register Information.
108 const TargetRegisterInfo *TRI;
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;
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
119 MCStreamer &OutStreamer;
121 /// The current machine function.
122 const MachineFunction *MF;
124 /// Name-mangler for global names.
128 /// The symbol for the current function. This is recalculated at the
129 /// beginning of each call to runOnMachineFunction().
131 MCSymbol *CurrentFnSym;
133 /// getCurrentSection() - Return the current section we are emitting to.
134 const MCSection *getCurrentSection() const;
137 /// VerboseAsm - Emit comments in assembly output if this is true.
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 processDebugLoc()
148 mutable const MDNode *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 /// getFunctionNumber - Return a unique ID for the current function.
163 unsigned getFunctionNumber() const;
166 /// getAnalysisUsage - Record analysis usage.
168 void getAnalysisUsage(AnalysisUsage &AU) const;
170 /// doInitialization - Set up the AsmPrinter when we are working on a new
171 /// module. If your pass overrides this, it must make sure to explicitly
172 /// call this implementation.
173 bool doInitialization(Module &M);
175 /// EmitStartOfAsmFile - This virtual method can be overridden by targets
176 /// that want to emit something at the start of their file.
177 virtual void EmitStartOfAsmFile(Module &) {}
179 /// EmitEndOfAsmFile - This virtual method can be overridden by targets that
180 /// want to emit something at the end of their file.
181 virtual void EmitEndOfAsmFile(Module &) {}
183 /// doFinalization - Shut down the asmprinter. If you override this in your
184 /// pass, you must make sure to call it explicitly.
185 bool doFinalization(Module &M);
187 /// PrintSpecial - Print information related to the specified machine instr
188 /// that is independent of the operand, and may be independent of the instr
189 /// itself. This can be useful for portably encoding the comment character
190 /// or other bits of target-specific knowledge into the asmstrings. The
191 /// syntax used is ${:comment}. Targets can override this to add support
192 /// for their own strange codes.
193 virtual void PrintSpecial(const MachineInstr *MI, const char *Code) const;
195 /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
196 /// instruction, using the specified assembler variant. Targets should
197 /// override this to format as appropriate. This method can return true if
198 /// the operand is erroneous.
199 virtual bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
200 unsigned AsmVariant, const char *ExtraCode);
202 /// PrintAsmMemoryOperand - Print the specified operand of MI, an INLINEASM
203 /// instruction, using the specified assembler variant as an address.
204 /// Targets should override this to format as appropriate. This method can
205 /// return true if the operand is erroneous.
206 virtual bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
208 const char *ExtraCode);
210 /// SetupMachineFunction - This should be called when a new MachineFunction
211 /// is being processed from runOnMachineFunction.
212 void SetupMachineFunction(MachineFunction &MF);
214 /// EmitFunctionHeader - This method emits the header for the current
216 void EmitFunctionHeader();
218 /// EmitConstantPool - Print to the current output stream assembly
219 /// representations of the constants in the constant pool MCP. This is
220 /// used to print out constants which have been "spilled to memory" by
221 /// the code generator.
223 void EmitConstantPool(const MachineConstantPool *MCP);
225 /// EmitJumpTableInfo - Print assembly representations of the jump tables
226 /// used by the current function to the current output stream.
228 void EmitJumpTableInfo(MachineFunction &MF);
230 /// EmitGlobalVariable - Emit the specified global variable to the .s file.
231 virtual void EmitGlobalVariable(const GlobalVariable *GV);
233 /// EmitSpecialLLVMGlobal - Check to see if the specified global is a
234 /// special global used by LLVM. If so, emit it and return true, otherwise
235 /// do nothing and return false.
236 bool EmitSpecialLLVMGlobal(const GlobalVariable *GV);
239 //===------------------------------------------------------------------===//
240 // Emission and print routines
243 /// EmitInt8 - Emit a byte directive and value.
245 void EmitInt8(int Value) const;
247 /// EmitInt16 - Emit a short directive and value.
249 void EmitInt16(int Value) const;
251 /// EmitInt32 - Emit a long directive and value.
253 void EmitInt32(int Value) const;
255 /// EmitInt64 - Emit a long long directive and value.
257 void EmitInt64(uint64_t Value) const;
259 //===------------------------------------------------------------------===//
261 /// EmitAlignment - Emit an alignment directive to the specified power of
262 /// two boundary. For example, if you pass in 3 here, you will get an 8
263 /// byte alignment. If a global value is specified, and if that global has
264 /// an explicit alignment requested, it will unconditionally override the
265 /// alignment request. However, if ForcedAlignBits is specified, this value
266 /// has final say: the ultimate alignment will be the max of ForcedAlignBits
267 /// and the alignment computed with NumBits and the global. If UseFillExpr
268 /// is true, it also emits an optional second value FillValue which the
269 /// assembler uses to fill gaps to match alignment for text sections if the
270 /// has specified a non-zero fill value.
272 /// The algorithm is:
274 /// if (GV && GV->hasalignment) Align = GV->getalignment();
275 /// Align = std::max(Align, ForcedAlignBits);
277 void EmitAlignment(unsigned NumBits, const GlobalValue *GV = 0,
278 unsigned ForcedAlignBits = 0,
279 bool UseFillExpr = true) const;
281 /// printLabel - This method prints a local label used by debug and
282 /// exception handling tables.
283 void printLabel(const MachineInstr *MI) const;
284 void printLabel(unsigned Id) const;
286 /// printDeclare - This method prints a local variable declaration used by
288 void printDeclare(const MachineInstr *MI) const;
290 /// EmitComments - Pretty-print comments for instructions
291 void EmitComments(const MachineInstr &MI) const;
293 /// GetGlobalValueSymbol - Return the MCSymbol for the specified global
295 MCSymbol *GetGlobalValueSymbol(const GlobalValue *GV) const;
297 /// GetSymbolWithGlobalValueBase - Return the MCSymbol for a symbol with
298 /// global value name as its base, with the specified suffix, and where the
299 /// symbol is forced to have private linkage if ForcePrivate is true.
300 MCSymbol *GetSymbolWithGlobalValueBase(const GlobalValue *GV,
302 bool ForcePrivate = true) const;
304 /// GetExternalSymbolSymbol - Return the MCSymbol for the specified
306 MCSymbol *GetExternalSymbolSymbol(StringRef Sym) const;
308 /// GetCPISymbol - Return the symbol for the specified constant pool entry.
309 MCSymbol *GetCPISymbol(unsigned CPID) const;
311 /// GetJTISymbol - Return the symbol for the specified jump table entry.
312 MCSymbol *GetJTISymbol(unsigned JTID, bool isLinkerPrivate = false) const;
314 /// GetJTSetSymbol - Return the symbol for the specified jump table .set
315 /// FIXME: privatize to AsmPrinter.
316 MCSymbol *GetJTSetSymbol(unsigned UID, unsigned MBBID) const;
318 /// GetBlockAddressSymbol - Return the MCSymbol used to satisfy BlockAddress
319 /// uses of the specified basic block.
320 MCSymbol *GetBlockAddressSymbol(const BlockAddress *BA,
321 const char *Suffix = "") const;
322 MCSymbol *GetBlockAddressSymbol(const Function *F,
323 const BasicBlock *BB,
324 const char *Suffix = "") const;
326 /// EmitBasicBlockStart - This method prints the label for the specified
327 /// MachineBasicBlock, an alignment (if present) and a comment describing
328 /// it if appropriate.
329 void EmitBasicBlockStart(const MachineBasicBlock *MBB) const;
334 /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
335 void EmitGlobalConstant(const Constant* CV, unsigned AddrSpace = 0);
338 virtual void EmitFunctionEntryLabel();
340 virtual void EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV);
342 /// processDebugLoc - Processes the debug information of each machine
343 /// instruction's DebugLoc.
344 void processDebugLoc(const MachineInstr *MI, bool BeforePrintingInsn);
346 /// printInlineAsm - This method formats and prints the specified machine
347 /// instruction that is an inline asm.
348 void printInlineAsm(const MachineInstr *MI) const;
350 /// printImplicitDef - This method prints the specified machine instruction
351 /// that is an implicit def.
352 void printImplicitDef(const MachineInstr *MI) const;
354 /// printKill - This method prints the specified kill machine instruction.
355 void printKill(const MachineInstr *MI) const;
357 /// printOffset - This is just convenient handler for printing offsets.
358 void printOffset(int64_t Offset) const;
361 /// EmitVisibility - This emits visibility information about symbol, if
362 /// this is suported by the target.
363 void EmitVisibility(MCSymbol *Sym, unsigned Visibility) const;
365 void EmitLinkage(unsigned Linkage, MCSymbol *GVSym) const;
367 void EmitJumpTableEntry(const MachineJumpTableInfo *MJTI,
368 const MachineBasicBlock *MBB,
370 void EmitLLVMUsedList(Constant *List);
371 void EmitXXStructorList(Constant *List);
372 GCMetadataPrinter *GetOrCreateGCPrinter(GCStrategy *C);