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 MCContext &Ctx, MCStreamer &Streamer,
156 virtual ~AsmPrinter();
158 /// isVerbose - Return true if assembly output should contain comments.
160 bool isVerbose() const { return VerboseAsm; }
162 /// getFunctionNumber - Return a unique ID for the current function.
164 unsigned getFunctionNumber() const;
167 /// getAnalysisUsage - Record analysis usage.
169 void getAnalysisUsage(AnalysisUsage &AU) const;
171 /// doInitialization - Set up the AsmPrinter when we are working on a new
172 /// module. If your pass overrides this, it must make sure to explicitly
173 /// call this implementation.
174 bool doInitialization(Module &M);
176 /// EmitStartOfAsmFile - This virtual method can be overridden by targets
177 /// that want to emit something at the start of their file.
178 virtual void EmitStartOfAsmFile(Module &) {}
180 /// EmitEndOfAsmFile - This virtual method can be overridden by targets that
181 /// want to emit something at the end of their file.
182 virtual void EmitEndOfAsmFile(Module &) {}
184 /// doFinalization - Shut down the asmprinter. If you override this in your
185 /// pass, you must make sure to call it explicitly.
186 bool doFinalization(Module &M);
188 /// PrintSpecial - Print information related to the specified machine instr
189 /// that is independent of the operand, and may be independent of the instr
190 /// itself. This can be useful for portably encoding the comment character
191 /// or other bits of target-specific knowledge into the asmstrings. The
192 /// syntax used is ${:comment}. Targets can override this to add support
193 /// for their own strange codes.
194 virtual void PrintSpecial(const MachineInstr *MI, const char *Code) const;
196 /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
197 /// instruction, using the specified assembler variant. Targets should
198 /// override this to format as appropriate. This method can return true if
199 /// the operand is erroneous.
200 virtual bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
201 unsigned AsmVariant, const char *ExtraCode);
203 /// PrintAsmMemoryOperand - Print the specified operand of MI, an INLINEASM
204 /// instruction, using the specified assembler variant as an address.
205 /// Targets should override this to format as appropriate. This method can
206 /// return true if the operand is erroneous.
207 virtual bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
209 const char *ExtraCode);
211 /// runOnMachineFunction - Emit the specified function out to the
213 virtual bool runOnMachineFunction(MachineFunction &MF) {
214 SetupMachineFunction(MF);
215 EmitFunctionHeader();
220 /// SetupMachineFunction - This should be called when a new MachineFunction
221 /// is being processed from runOnMachineFunction.
222 void SetupMachineFunction(MachineFunction &MF);
224 /// EmitFunctionHeader - This method emits the header for the current
226 void EmitFunctionHeader();
228 /// EmitFunctionBody - This method emits the body and trailer for a
230 void EmitFunctionBody();
232 /// EmitInstruction - Targets should implement this to emit instructions.
233 virtual void EmitInstruction(const MachineInstr *MI) {
234 assert(0 && "EmitInstruction not implemented");
237 /// EmitFunctionBodyStart - Targets can override this to emit stuff before
238 /// the first basic block in the function.
239 virtual void EmitFunctionBodyStart() {}
241 /// EmitFunctionBodyEnd - Targets can override this to emit stuff after
242 /// the last basic block in the function.
243 virtual void EmitFunctionBodyEnd() {}
245 /// EmitConstantPool - Print to the current output stream assembly
246 /// representations of the constants in the constant pool MCP. This is
247 /// used to print out constants which have been "spilled to memory" by
248 /// the code generator.
250 virtual void EmitConstantPool();
252 /// EmitJumpTableInfo - Print assembly representations of the jump tables
253 /// used by the current function to the current output stream.
255 void EmitJumpTableInfo();
257 /// EmitGlobalVariable - Emit the specified global variable to the .s file.
258 virtual void EmitGlobalVariable(const GlobalVariable *GV);
260 /// EmitSpecialLLVMGlobal - Check to see if the specified global is a
261 /// special global used by LLVM. If so, emit it and return true, otherwise
262 /// do nothing and return false.
263 bool EmitSpecialLLVMGlobal(const GlobalVariable *GV);
266 //===------------------------------------------------------------------===//
267 // Emission and print routines
270 /// EmitInt8 - Emit a byte directive and value.
272 void EmitInt8(int Value) const;
274 /// EmitInt16 - Emit a short directive and value.
276 void EmitInt16(int Value) const;
278 /// EmitInt32 - Emit a long directive and value.
280 void EmitInt32(int Value) const;
282 /// EmitInt64 - Emit a long long directive and value.
284 void EmitInt64(uint64_t Value) const;
286 //===------------------------------------------------------------------===//
288 /// EmitAlignment - Emit an alignment directive to the specified power of
289 /// two boundary. For example, if you pass in 3 here, you will get an 8
290 /// byte alignment. If a global value is specified, and if that global has
291 /// an explicit alignment requested, it will unconditionally override the
292 /// alignment request. However, if ForcedAlignBits is specified, this value
293 /// has final say: the ultimate alignment will be the max of ForcedAlignBits
294 /// and the alignment computed with NumBits and the global. If UseFillExpr
295 /// is true, it also emits an optional second value FillValue which the
296 /// assembler uses to fill gaps to match alignment for text sections if the
297 /// has specified a non-zero fill value.
299 /// The algorithm is:
301 /// if (GV && GV->hasalignment) Align = GV->getalignment();
302 /// Align = std::max(Align, ForcedAlignBits);
304 void EmitAlignment(unsigned NumBits, const GlobalValue *GV = 0,
305 unsigned ForcedAlignBits = 0,
306 bool UseFillExpr = true) const;
308 /// printLabel - This method prints a local label used by debug and
309 /// exception handling tables.
310 void printLabel(const MachineInstr *MI) const;
311 void printLabel(unsigned Id) const;
313 /// printDeclare - This method prints a local variable declaration used by
315 void printDeclare(const MachineInstr *MI) const;
317 /// EmitComments - Pretty-print comments for instructions
318 void EmitComments(const MachineInstr &MI) const;
320 /// GetGlobalValueSymbol - Return the MCSymbol for the specified global
322 MCSymbol *GetGlobalValueSymbol(const GlobalValue *GV) const;
324 /// GetSymbolWithGlobalValueBase - Return the MCSymbol for a symbol with
325 /// global value name as its base, with the specified suffix, and where the
326 /// symbol is forced to have private linkage if ForcePrivate is true.
327 MCSymbol *GetSymbolWithGlobalValueBase(const GlobalValue *GV,
329 bool ForcePrivate = true) const;
331 /// GetExternalSymbolSymbol - Return the MCSymbol for the specified
333 MCSymbol *GetExternalSymbolSymbol(StringRef Sym) const;
335 /// GetCPISymbol - Return the symbol for the specified constant pool entry.
336 MCSymbol *GetCPISymbol(unsigned CPID) const;
338 /// GetJTISymbol - Return the symbol for the specified jump table entry.
339 MCSymbol *GetJTISymbol(unsigned JTID, bool isLinkerPrivate = false) const;
341 /// GetJTSetSymbol - Return the symbol for the specified jump table .set
342 /// FIXME: privatize to AsmPrinter.
343 MCSymbol *GetJTSetSymbol(unsigned UID, unsigned MBBID) const;
345 /// GetBlockAddressSymbol - Return the MCSymbol used to satisfy BlockAddress
346 /// uses of the specified basic block.
347 MCSymbol *GetBlockAddressSymbol(const BlockAddress *BA,
348 const char *Suffix = "") const;
349 MCSymbol *GetBlockAddressSymbol(const Function *F,
350 const BasicBlock *BB,
351 const char *Suffix = "") const;
353 /// EmitBasicBlockStart - This method prints the label for the specified
354 /// MachineBasicBlock, an alignment (if present) and a comment describing
355 /// it if appropriate.
356 void EmitBasicBlockStart(const MachineBasicBlock *MBB) const;
361 /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
362 void EmitGlobalConstant(const Constant* CV, unsigned AddrSpace = 0);
365 virtual void EmitFunctionEntryLabel();
367 virtual void EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV);
369 /// processDebugLoc - Processes the debug information of each machine
370 /// instruction's DebugLoc.
371 void processDebugLoc(const MachineInstr *MI, bool BeforePrintingInsn);
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 void printImplicitDef(const MachineInstr *MI) const;
381 /// printKill - This method prints the specified kill machine instruction.
382 void printKill(const MachineInstr *MI) const;
384 /// printOffset - This is just convenient handler for printing offsets.
385 void printOffset(int64_t Offset) const;
388 /// EmitVisibility - This emits visibility information about symbol, if
389 /// this is suported by the target.
390 void EmitVisibility(MCSymbol *Sym, unsigned Visibility) const;
392 void EmitLinkage(unsigned Linkage, MCSymbol *GVSym) const;
394 void EmitJumpTableEntry(const MachineJumpTableInfo *MJTI,
395 const MachineBasicBlock *MBB,
397 void EmitLLVMUsedList(Constant *List);
398 void EmitXXStructorList(Constant *List);
399 GCMetadataPrinter *GetOrCreateGCPrinter(GCStrategy *C);