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/DataTypes.h"
31 class GCMetadataPrinter;
34 class MachineBasicBlock;
35 class MachineFunction;
37 class MachineLocation;
38 class MachineLoopInfo;
40 class MachineConstantPool;
41 class MachineConstantPoolEntry;
42 class MachineConstantPoolValue;
43 class MachineJumpTableInfo;
44 class MachineModuleInfo;
56 class TargetLoweringObjectFile;
62 /// AsmPrinter - This class is intended to be used as a driving class for all
64 class AsmPrinter : public MachineFunctionPass {
66 /// Target machine description.
70 /// Target Asm Printer information.
74 /// OutContext - This is the context for the output file that we are
75 /// streaming. This owns all of the global MC-related objects for the
76 /// generated translation unit.
77 MCContext &OutContext;
79 /// OutStreamer - This is the MCStreamer object for the file we are
80 /// generating. This contains the transient state for the current
81 /// translation unit that we are generating (such as the current section
83 MCStreamer &OutStreamer;
85 /// The current machine function.
86 const MachineFunction *MF;
88 /// MMI - This is a pointer to the current MachineModuleInfo.
89 MachineModuleInfo *MMI;
91 /// Name-mangler for global names.
95 /// The symbol for the current function. This is recalculated at the
96 /// beginning of each call to runOnMachineFunction().
98 MCSymbol *CurrentFnSym;
101 // GCMetadataPrinters - The garbage collection metadata printer table.
102 void *GCMetadataPrinters; // Really a DenseMap.
104 /// VerboseAsm - Emit comments in assembly output if this is true.
109 /// If VerboseAsm is set, a pointer to the loop info for this
113 /// DD - If the target supports dwarf debug info, this pointer is non-null.
116 /// DE - If the target supports dwarf exception info, this pointer is
121 explicit AsmPrinter(TargetMachine &TM, MCStreamer &Streamer);
124 virtual ~AsmPrinter();
126 /// isVerbose - Return true if assembly output should contain comments.
128 bool isVerbose() const { return VerboseAsm; }
130 /// getFunctionNumber - Return a unique ID for the current function.
132 unsigned getFunctionNumber() const;
134 /// getObjFileLowering - Return information about object file lowering.
135 const TargetLoweringObjectFile &getObjFileLowering() const;
137 /// getTargetData - Return information about data layout.
138 const TargetData &getTargetData() const;
140 /// getCurrentSection() - Return the current section we are emitting to.
141 const MCSection *getCurrentSection() const;
144 //===------------------------------------------------------------------===//
145 // MachineFunctionPass Implementation.
146 //===------------------------------------------------------------------===//
148 /// getAnalysisUsage - Record analysis usage.
150 void getAnalysisUsage(AnalysisUsage &AU) const;
152 /// doInitialization - Set up the AsmPrinter when we are working on a new
153 /// module. If your pass overrides this, it must make sure to explicitly
154 /// call this implementation.
155 bool doInitialization(Module &M);
157 /// doFinalization - Shut down the asmprinter. If you override this in your
158 /// pass, you must make sure to call it explicitly.
159 bool doFinalization(Module &M);
161 /// runOnMachineFunction - Emit the specified function out to the
163 virtual bool runOnMachineFunction(MachineFunction &MF) {
164 SetupMachineFunction(MF);
165 EmitFunctionHeader();
170 //===------------------------------------------------------------------===//
171 // Coarse grained IR lowering routines.
172 //===------------------------------------------------------------------===//
174 /// SetupMachineFunction - This should be called when a new MachineFunction
175 /// is being processed from runOnMachineFunction.
176 void SetupMachineFunction(MachineFunction &MF);
178 /// EmitFunctionHeader - This method emits the header for the current
180 void EmitFunctionHeader();
182 /// EmitFunctionBody - This method emits the body and trailer for a
184 void EmitFunctionBody();
186 void emitPrologLabel(const MachineInstr &MI);
193 CFIMoveType needsCFIMoves();
195 bool needsSEHMoves();
197 /// needsRelocationsForDwarfStringPool - Specifies whether the object format
198 /// expects to use relocations to refer to debug entries. Alternatively we
199 /// emit section offsets in bytes from the start of the string pool.
200 bool needsRelocationsForDwarfStringPool() const;
202 /// EmitConstantPool - Print to the current output stream assembly
203 /// representations of the constants in the constant pool MCP. This is
204 /// used to print out constants which have been "spilled to memory" by
205 /// the code generator.
207 virtual void EmitConstantPool();
209 /// EmitJumpTableInfo - Print assembly representations of the jump tables
210 /// used by the current function to the current output stream.
212 void EmitJumpTableInfo();
214 /// EmitGlobalVariable - Emit the specified global variable to the .s file.
215 virtual void EmitGlobalVariable(const GlobalVariable *GV);
217 /// EmitSpecialLLVMGlobal - Check to see if the specified global is a
218 /// special global used by LLVM. If so, emit it and return true, otherwise
219 /// do nothing and return false.
220 bool EmitSpecialLLVMGlobal(const GlobalVariable *GV);
222 /// EmitAlignment - Emit an alignment directive to the specified power of
223 /// two boundary. For example, if you pass in 3 here, you will get an 8
224 /// byte alignment. If a global value is specified, and if that global has
225 /// an explicit alignment requested, it will override the alignment request
226 /// if required for correctness.
228 void EmitAlignment(unsigned NumBits, const GlobalValue *GV = 0) const;
230 /// EmitBasicBlockStart - This method prints the label for the specified
231 /// MachineBasicBlock, an alignment (if present) and a comment describing
232 /// it if appropriate.
233 void EmitBasicBlockStart(const MachineBasicBlock *MBB) const;
235 /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
236 void EmitGlobalConstant(const Constant *CV, unsigned AddrSpace = 0);
239 //===------------------------------------------------------------------===//
241 //===------------------------------------------------------------------===//
243 // Targets can, or in the case of EmitInstruction, must implement these to
246 /// EmitStartOfAsmFile - This virtual method can be overridden by targets
247 /// that want to emit something at the start of their file.
248 virtual void EmitStartOfAsmFile(Module &) {}
250 /// EmitEndOfAsmFile - This virtual method can be overridden by targets that
251 /// want to emit something at the end of their file.
252 virtual void EmitEndOfAsmFile(Module &) {}
254 /// EmitFunctionBodyStart - Targets can override this to emit stuff before
255 /// the first basic block in the function.
256 virtual void EmitFunctionBodyStart() {}
258 /// EmitFunctionBodyEnd - Targets can override this to emit stuff after
259 /// the last basic block in the function.
260 virtual void EmitFunctionBodyEnd() {}
262 /// EmitInstruction - Targets should implement this to emit instructions.
263 virtual void EmitInstruction(const MachineInstr *) {
264 assert(0 && "EmitInstruction not implemented");
267 virtual void EmitFunctionEntryLabel();
269 virtual void EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV);
271 /// isBlockOnlyReachableByFallthough - Return true if the basic block has
272 /// exactly one predecessor and the control transfer mechanism between
273 /// the predecessor and this block is a fall-through.
275 isBlockOnlyReachableByFallthrough(const MachineBasicBlock *MBB) const;
277 //===------------------------------------------------------------------===//
278 // Symbol Lowering Routines.
279 //===------------------------------------------------------------------===//
282 /// GetTempSymbol - Return the MCSymbol corresponding to the assembler
283 /// temporary label with the specified stem and unique ID.
284 MCSymbol *GetTempSymbol(StringRef Name, unsigned ID) const;
286 /// GetTempSymbol - Return an assembler temporary label with the specified
288 MCSymbol *GetTempSymbol(StringRef Name) const;
291 /// GetSymbolWithGlobalValueBase - Return the MCSymbol for a symbol with
292 /// global value name as its base, with the specified suffix, and where the
293 /// symbol is forced to have private linkage if ForcePrivate is true.
294 MCSymbol *GetSymbolWithGlobalValueBase(const GlobalValue *GV,
296 bool ForcePrivate = true) const;
298 /// GetExternalSymbolSymbol - Return the MCSymbol for the specified
300 MCSymbol *GetExternalSymbolSymbol(StringRef Sym) const;
302 /// GetCPISymbol - Return the symbol for the specified constant pool entry.
303 MCSymbol *GetCPISymbol(unsigned CPID) const;
305 /// GetJTISymbol - Return the symbol for the specified jump table entry.
306 MCSymbol *GetJTISymbol(unsigned JTID, bool isLinkerPrivate = false) const;
308 /// GetJTSetSymbol - Return the symbol for the specified jump table .set
309 /// FIXME: privatize to AsmPrinter.
310 MCSymbol *GetJTSetSymbol(unsigned UID, unsigned MBBID) const;
312 /// GetBlockAddressSymbol - Return the MCSymbol used to satisfy BlockAddress
313 /// uses of the specified basic block.
314 MCSymbol *GetBlockAddressSymbol(const BlockAddress *BA) const;
315 MCSymbol *GetBlockAddressSymbol(const BasicBlock *BB) const;
317 //===------------------------------------------------------------------===//
318 // Emission Helper Routines.
319 //===------------------------------------------------------------------===//
321 /// printOffset - This is just convenient handler for printing offsets.
322 void printOffset(int64_t Offset, raw_ostream &OS) const;
324 /// EmitInt8 - Emit a byte directive and value.
326 void EmitInt8(int Value) const;
328 /// EmitInt16 - Emit a short directive and value.
330 void EmitInt16(int Value) const;
332 /// EmitInt32 - Emit a long directive and value.
334 void EmitInt32(int Value) const;
336 /// EmitLabelDifference - Emit something like ".long Hi-Lo" where the size
337 /// in bytes of the directive is specified by Size and Hi/Lo specify the
338 /// labels. This implicitly uses .set if it is available.
339 void EmitLabelDifference(const MCSymbol *Hi, const MCSymbol *Lo,
340 unsigned Size) const;
342 /// EmitLabelOffsetDifference - Emit something like ".long Hi+Offset-Lo"
343 /// where the size in bytes of the directive is specified by Size and Hi/Lo
344 /// specify the labels. This implicitly uses .set if it is available.
345 void EmitLabelOffsetDifference(const MCSymbol *Hi, uint64_t Offset,
346 const MCSymbol *Lo, unsigned Size) const;
348 /// EmitLabelPlusOffset - Emit something like ".long Label+Offset"
349 /// where the size in bytes of the directive is specified by Size and Label
350 /// specifies the label. This implicitly uses .set if it is available.
351 void EmitLabelPlusOffset(const MCSymbol *Label, uint64_t Offset,
352 unsigned Size) const;
354 //===------------------------------------------------------------------===//
355 // Dwarf Emission Helper Routines
356 //===------------------------------------------------------------------===//
358 /// EmitSLEB128 - emit the specified signed leb128 value.
359 void EmitSLEB128(int Value, const char *Desc = 0) const;
361 /// EmitULEB128 - emit the specified unsigned leb128 value.
362 void EmitULEB128(unsigned Value, const char *Desc = 0,
363 unsigned PadTo = 0) const;
365 /// EmitCFAByte - Emit a .byte 42 directive for a DW_CFA_xxx value.
366 void EmitCFAByte(unsigned Val) const;
368 /// EmitEncodingByte - Emit a .byte 42 directive that corresponds to an
369 /// encoding. If verbose assembly output is enabled, we output comments
370 /// describing the encoding. Desc is a string saying what the encoding is
371 /// specifying (e.g. "LSDA").
372 void EmitEncodingByte(unsigned Val, const char *Desc = 0) const;
374 /// GetSizeOfEncodedValue - Return the size of the encoding in bytes.
375 unsigned GetSizeOfEncodedValue(unsigned Encoding) const;
377 /// EmitReference - Emit a reference to a label with a specified encoding.
379 void EmitReference(const MCSymbol *Sym, unsigned Encoding) const;
380 void EmitReference(const GlobalValue *GV, unsigned Encoding) const;
382 /// EmitSectionOffset - Emit the 4-byte offset of Label from the start of
383 /// its section. This can be done with a special directive if the target
384 /// supports it (e.g. cygwin) or by emitting it as an offset from a label at
385 /// the start of the section.
387 /// SectionLabel is a temporary label emitted at the start of the section
388 /// that Label lives in.
389 void EmitSectionOffset(const MCSymbol *Label,
390 const MCSymbol *SectionLabel) const;
392 /// getDebugValueLocation - Get location information encoded by DBG_VALUE
394 virtual MachineLocation getDebugValueLocation(const MachineInstr *MI) const;
396 /// getISAEncoding - Get the value for DW_AT_APPLE_isa. Zero if no isa
397 /// encoding specified.
398 virtual unsigned getISAEncoding() { return 0; }
400 /// EmitDwarfRegOp - Emit dwarf register operation.
401 virtual void EmitDwarfRegOp(const MachineLocation &MLoc) const;
403 //===------------------------------------------------------------------===//
404 // Dwarf Lowering Routines
405 //===------------------------------------------------------------------===//
407 /// EmitCFIFrameMove - Emit frame instruction to describe the layout of the
409 void EmitCFIFrameMove(const MachineMove &Move) const;
411 //===------------------------------------------------------------------===//
412 // Inline Asm Support
413 //===------------------------------------------------------------------===//
415 // These are hooks that targets can override to implement inline asm
416 // support. These should probably be moved out of AsmPrinter someday.
418 /// PrintSpecial - Print information related to the specified machine instr
419 /// that is independent of the operand, and may be independent of the instr
420 /// itself. This can be useful for portably encoding the comment character
421 /// or other bits of target-specific knowledge into the asmstrings. The
422 /// syntax used is ${:comment}. Targets can override this to add support
423 /// for their own strange codes.
424 virtual void PrintSpecial(const MachineInstr *MI, raw_ostream &OS,
425 const char *Code) const;
427 /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
428 /// instruction, using the specified assembler variant. Targets should
429 /// override this to format as appropriate. This method can return true if
430 /// the operand is erroneous.
431 virtual bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
432 unsigned AsmVariant, const char *ExtraCode,
435 /// PrintAsmMemoryOperand - Print the specified operand of MI, an INLINEASM
436 /// instruction, using the specified assembler variant as an address.
437 /// Targets should override this to format as appropriate. This method can
438 /// return true if the operand is erroneous.
439 virtual bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
441 const char *ExtraCode,
445 /// Private state for PrintSpecial()
446 // Assign a unique ID to this machine instruction.
447 mutable const MachineInstr *LastMI;
448 mutable unsigned LastFn;
449 mutable unsigned Counter;
450 mutable unsigned SetCounter;
452 /// EmitInlineAsm - Emit a blob of inline asm to the output streamer.
453 void EmitInlineAsm(StringRef Str, const MDNode *LocMDNode = 0) const;
455 /// EmitInlineAsm - This method formats and emits the specified machine
456 /// instruction that is an inline asm.
457 void EmitInlineAsm(const MachineInstr *MI) const;
459 //===------------------------------------------------------------------===//
460 // Internal Implementation Details
461 //===------------------------------------------------------------------===//
463 /// EmitVisibility - This emits visibility information about symbol, if
464 /// this is suported by the target.
465 void EmitVisibility(MCSymbol *Sym, unsigned Visibility,
466 bool IsDefinition = true) const;
468 void EmitLinkage(unsigned Linkage, MCSymbol *GVSym) const;
470 void EmitJumpTableEntry(const MachineJumpTableInfo *MJTI,
471 const MachineBasicBlock *MBB,
473 void EmitLLVMUsedList(const Constant *List);
474 void EmitXXStructorList(const Constant *List);
475 GCMetadataPrinter *GetOrCreateGCPrinter(GCStrategy *C);