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/ADT/MapVector.h"
20 #include "llvm/ADT/Twine.h"
21 #include "llvm/CodeGen/MachineFunctionPass.h"
22 #include "llvm/CodeGen/DwarfStringPoolEntry.h"
23 #include "llvm/IR/InlineAsm.h"
24 #include "llvm/Support/DataTypes.h"
25 #include "llvm/Support/ErrorHandling.h"
28 class AsmPrinterHandler;
36 class GCMetadataPrinter;
39 class MachineBasicBlock;
40 class MachineFunction;
42 class MachineLocation;
43 class MachineLoopInfo;
45 class MachineConstantPoolValue;
46 class MachineJumpTableInfo;
47 class MachineModuleInfo;
49 class MCCFIInstruction;
55 class MCSubtargetInfo;
57 class MCTargetOptions;
61 class TargetLoweringObjectFile;
65 /// This class is intended to be used as a driving class for all asm writers.
66 class AsmPrinter : public MachineFunctionPass {
68 /// Target machine description.
72 /// Target Asm Printer information.
76 /// This is the context for the output file that we are streaming. This owns
77 /// all of the global MC-related objects for the generated translation unit.
78 MCContext &OutContext;
80 /// This is the MCStreamer object for the file we are generating. This
81 /// contains the transient state for the current translation unit that we are
82 /// generating (such as the current section etc).
83 std::unique_ptr<MCStreamer> OutStreamer;
85 /// The current machine function.
86 const MachineFunction *MF;
88 /// 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 beginning
96 /// of each call to runOnMachineFunction().
98 MCSymbol *CurrentFnSym;
100 /// The symbol used to represent the start of the current function for the
101 /// purpose of calculating its size (e.g. using the .size directive). By
102 /// default, this is equal to CurrentFnSym.
103 MCSymbol *CurrentFnSymForSize;
105 /// Map global GOT equivalent MCSymbols to GlobalVariables and keep track of
106 /// its number of uses by other globals.
107 typedef std::pair<const GlobalVariable *, unsigned> GOTEquivUsePair;
108 MapVector<const MCSymbol *, GOTEquivUsePair> GlobalGOTEquivs;
111 MCSymbol *CurrentFnBegin;
112 MCSymbol *CurrentFnEnd;
113 MCSymbol *CurExceptionSym;
115 // The garbage collection metadata printer table.
116 void *GCMetadataPrinters; // Really a DenseMap.
118 /// Emit comments in assembly output if this is true.
123 /// If VerboseAsm is set, a pointer to the loop info for this function.
127 AsmPrinterHandler *Handler;
128 const char *TimerName, *TimerGroupName;
129 HandlerInfo(AsmPrinterHandler *Handler, const char *TimerName,
130 const char *TimerGroupName)
131 : Handler(Handler), TimerName(TimerName),
132 TimerGroupName(TimerGroupName) {}
134 /// A vector of all debug/EH info emitters we should use. This vector
135 /// maintains ownership of the emitters.
136 SmallVector<HandlerInfo, 1> Handlers;
138 /// If the target supports dwarf debug info, this pointer is non-null.
142 explicit AsmPrinter(TargetMachine &TM, std::unique_ptr<MCStreamer> Streamer);
145 ~AsmPrinter() override;
147 DwarfDebug *getDwarfDebug() { return DD; }
148 DwarfDebug *getDwarfDebug() const { return DD; }
150 /// Return true if assembly output should contain comments.
152 bool isVerbose() const { return VerboseAsm; }
154 /// Return a unique ID for the current function.
156 unsigned getFunctionNumber() const;
158 MCSymbol *getFunctionBegin() const { return CurrentFnBegin; }
159 MCSymbol *getFunctionEnd() const { return CurrentFnEnd; }
160 MCSymbol *getCurExceptionSym();
162 /// Return information about object file lowering.
163 const TargetLoweringObjectFile &getObjFileLowering() const;
165 /// Return information about data layout.
166 const DataLayout &getDataLayout() const;
168 /// Return the pointer size from the TargetMachine
169 unsigned getPointerSize() const;
171 /// Return information about subtarget.
172 const MCSubtargetInfo &getSubtargetInfo() const;
174 void EmitToStreamer(MCStreamer &S, const MCInst &Inst);
176 /// Return the target triple string.
177 StringRef getTargetTriple() const;
179 /// Return the current section we are emitting to.
180 const MCSection *getCurrentSection() const;
182 void getNameWithPrefix(SmallVectorImpl<char> &Name,
183 const GlobalValue *GV) const;
185 MCSymbol *getSymbol(const GlobalValue *GV) const;
187 //===------------------------------------------------------------------===//
188 // MachineFunctionPass Implementation.
189 //===------------------------------------------------------------------===//
191 /// Record analysis usage.
193 void getAnalysisUsage(AnalysisUsage &AU) const override;
195 /// Set up the AsmPrinter when we are working on a new module. If your pass
196 /// overrides this, it must make sure to explicitly call this implementation.
197 bool doInitialization(Module &M) override;
199 /// Shut down the asmprinter. If you override this in your pass, you must make
200 /// sure to call it explicitly.
201 bool doFinalization(Module &M) override;
203 /// Emit the specified function out to the OutStreamer.
204 bool runOnMachineFunction(MachineFunction &MF) override {
205 SetupMachineFunction(MF);
210 //===------------------------------------------------------------------===//
211 // Coarse grained IR lowering routines.
212 //===------------------------------------------------------------------===//
214 /// This should be called when a new MachineFunction is being processed from
215 /// runOnMachineFunction.
216 void SetupMachineFunction(MachineFunction &MF);
218 /// This method emits the body and trailer for a function.
219 void EmitFunctionBody();
221 void emitCFIInstruction(const MachineInstr &MI);
223 void emitFrameAlloc(const MachineInstr &MI);
225 enum CFIMoveType { CFI_M_None, CFI_M_EH, CFI_M_Debug };
226 CFIMoveType needsCFIMoves();
228 bool needsSEHMoves();
230 /// Print to the current output stream assembly representations of the
231 /// constants in the constant pool MCP. This is used to print out constants
232 /// which have been "spilled to memory" by the code generator.
234 virtual void EmitConstantPool();
236 /// Print assembly representations of the jump tables used by the current
237 /// function to the current output stream.
239 virtual void EmitJumpTableInfo();
241 /// Emit the control variable for an emulated TLS variable.
242 virtual void EmitEmulatedTLSControlVariable(const GlobalVariable *GV,
243 MCSymbol *EmittedSym,
244 bool AllZeroInitValue);
246 /// Emit the specified global variable to the .s file.
247 virtual void EmitGlobalVariable(const GlobalVariable *GV);
249 /// Check to see if the specified global is a special global used by LLVM. If
250 /// so, emit it and return true, otherwise do nothing and return false.
251 bool EmitSpecialLLVMGlobal(const GlobalVariable *GV);
253 /// Emit an alignment directive to the specified power of two boundary. For
254 /// example, if you pass in 3 here, you will get an 8 byte alignment. If a
255 /// global value is specified, and if that global has an explicit alignment
256 /// requested, it will override the alignment request if required for
259 void EmitAlignment(unsigned NumBits, const GlobalObject *GO = nullptr) const;
261 /// Lower the specified LLVM Constant to an MCExpr.
262 const MCExpr *lowerConstant(const Constant *CV);
264 /// \brief Print a general LLVM constant to the .s file.
265 void EmitGlobalConstant(const DataLayout &DL, const Constant *CV);
267 /// \brief Unnamed constant global variables solely contaning a pointer to
268 /// another globals variable act like a global variable "proxy", or GOT
269 /// equivalents, i.e., it's only used to hold the address of the latter. One
270 /// optimization is to replace accesses to these proxies by using the GOT
271 /// entry for the final global instead. Hence, we select GOT equivalent
272 /// candidates among all the module global variables, avoid emitting them
273 /// unnecessarily and finally replace references to them by pc relative
274 /// accesses to GOT entries.
275 void computeGlobalGOTEquivs(Module &M);
277 /// \brief Constant expressions using GOT equivalent globals may not be
278 /// eligible for PC relative GOT entry conversion, in such cases we need to
279 /// emit the proxies we previously omitted in EmitGlobalVariable.
280 void emitGlobalGOTEquivs();
282 //===------------------------------------------------------------------===//
284 //===------------------------------------------------------------------===//
286 // Targets can, or in the case of EmitInstruction, must implement these to
289 /// This virtual method can be overridden by targets that want to emit
290 /// something at the start of their file.
291 virtual void EmitStartOfAsmFile(Module &) {}
293 /// This virtual method can be overridden by targets that want to emit
294 /// something at the end of their file.
295 virtual void EmitEndOfAsmFile(Module &) {}
297 /// Targets can override this to emit stuff before the first basic block in
299 virtual void EmitFunctionBodyStart() {}
301 /// Targets can override this to emit stuff after the last basic block in the
303 virtual void EmitFunctionBodyEnd() {}
305 /// Targets can override this to emit stuff at the start of a basic block.
306 /// By default, this method prints the label for the specified
307 /// MachineBasicBlock, an alignment (if present) and a comment describing it
309 virtual void EmitBasicBlockStart(const MachineBasicBlock &MBB) const;
311 /// Targets can override this to emit stuff at the end of a basic block.
312 virtual void EmitBasicBlockEnd(const MachineBasicBlock &MBB) {}
314 /// Targets should implement this to emit instructions.
315 virtual void EmitInstruction(const MachineInstr *) {
316 llvm_unreachable("EmitInstruction not implemented");
319 /// Return the symbol for the specified constant pool entry.
320 virtual MCSymbol *GetCPISymbol(unsigned CPID) const;
322 virtual void EmitFunctionEntryLabel();
324 virtual void EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV);
326 /// Targets can override this to change how global constants that are part of
327 /// a C++ static/global constructor list are emitted.
328 virtual void EmitXXStructor(const DataLayout &DL, const Constant *CV) {
329 EmitGlobalConstant(DL, CV);
332 /// Return true if the basic block has exactly one predecessor and the control
333 /// transfer mechanism between the predecessor and this block is a
336 isBlockOnlyReachableByFallthrough(const MachineBasicBlock *MBB) const;
338 /// Targets can override this to customize the output of IMPLICIT_DEF
339 /// instructions in verbose mode.
340 virtual void emitImplicitDef(const MachineInstr *MI) const;
342 //===------------------------------------------------------------------===//
343 // Symbol Lowering Routines.
344 //===------------------------------------------------------------------===//
346 MCSymbol *createTempSymbol(const Twine &Name) const;
348 /// Return the MCSymbol for a private symbol with global value name as its
349 /// base, with the specified suffix.
350 MCSymbol *getSymbolWithGlobalValueBase(const GlobalValue *GV,
351 StringRef Suffix) const;
353 /// Return the MCSymbol for the specified ExternalSymbol.
354 MCSymbol *GetExternalSymbolSymbol(StringRef Sym) const;
356 /// Return the symbol for the specified jump table entry.
357 MCSymbol *GetJTISymbol(unsigned JTID, bool isLinkerPrivate = false) const;
359 /// Return the symbol for the specified jump table .set
360 /// FIXME: privatize to AsmPrinter.
361 MCSymbol *GetJTSetSymbol(unsigned UID, unsigned MBBID) const;
363 /// Return the MCSymbol used to satisfy BlockAddress uses of the specified
365 MCSymbol *GetBlockAddressSymbol(const BlockAddress *BA) const;
366 MCSymbol *GetBlockAddressSymbol(const BasicBlock *BB) const;
368 //===------------------------------------------------------------------===//
369 // Emission Helper Routines.
370 //===------------------------------------------------------------------===//
372 /// This is just convenient handler for printing offsets.
373 void printOffset(int64_t Offset, raw_ostream &OS) const;
375 /// Emit a byte directive and value.
377 void EmitInt8(int Value) const;
379 /// Emit a short directive and value.
381 void EmitInt16(int Value) const;
383 /// Emit a long directive and value.
385 void EmitInt32(int Value) const;
387 /// Emit something like ".long Hi-Lo" where the size in bytes of the directive
388 /// is specified by Size and Hi/Lo specify the labels. This implicitly uses
389 /// .set if it is available.
390 void EmitLabelDifference(const MCSymbol *Hi, const MCSymbol *Lo,
391 unsigned Size) const;
393 /// Emit something like ".long Label+Offset" where the size in bytes of the
394 /// directive is specified by Size and Label specifies the label. This
395 /// implicitly uses .set if it is available.
396 void EmitLabelPlusOffset(const MCSymbol *Label, uint64_t Offset,
397 unsigned Size, bool IsSectionRelative = false) const;
399 /// Emit something like ".long Label" where the size in bytes of the directive
400 /// is specified by Size and Label specifies the label.
401 void EmitLabelReference(const MCSymbol *Label, unsigned Size,
402 bool IsSectionRelative = false) const {
403 EmitLabelPlusOffset(Label, 0, Size, IsSectionRelative);
406 //===------------------------------------------------------------------===//
407 // Dwarf Emission Helper Routines
408 //===------------------------------------------------------------------===//
410 /// Emit the specified signed leb128 value.
411 void EmitSLEB128(int64_t Value, const char *Desc = nullptr) const;
413 /// Emit the specified unsigned leb128 value.
414 void EmitULEB128(uint64_t Value, const char *Desc = nullptr,
415 unsigned PadTo = 0) const;
417 /// Emit a .byte 42 directive that corresponds to an encoding. If verbose
418 /// assembly output is enabled, we output comments describing the encoding.
419 /// Desc is a string saying what the encoding is specifying (e.g. "LSDA").
420 void EmitEncodingByte(unsigned Val, const char *Desc = nullptr) const;
422 /// Return the size of the encoding in bytes.
423 unsigned GetSizeOfEncodedValue(unsigned Encoding) const;
425 /// Emit reference to a ttype global with a specified encoding.
426 void EmitTTypeReference(const GlobalValue *GV, unsigned Encoding) const;
428 /// Emit a reference to a symbol for use in dwarf. Different object formats
429 /// represent this in different ways. Some use a relocation others encode
430 /// the label offset in its section.
431 void emitDwarfSymbolReference(const MCSymbol *Label,
432 bool ForceOffset = false) const;
434 /// Emit the 4-byte offset of a string from the start of its section.
436 /// When possible, emit a DwarfStringPool section offset without any
437 /// relocations, and without using the symbol. Otherwise, defers to \a
438 /// emitDwarfSymbolReference().
439 void emitDwarfStringOffset(DwarfStringPoolEntryRef S) const;
441 /// Get the value for DW_AT_APPLE_isa. Zero if no isa encoding specified.
442 virtual unsigned getISAEncoding() { return 0; }
444 /// EmitDwarfRegOp - Emit a dwarf register operation.
445 virtual void EmitDwarfRegOp(ByteStreamer &BS,
446 const MachineLocation &MLoc) const;
448 //===------------------------------------------------------------------===//
449 // Dwarf Lowering Routines
450 //===------------------------------------------------------------------===//
452 /// \brief Emit frame instruction to describe the layout of the frame.
453 void emitCFIInstruction(const MCCFIInstruction &Inst) const;
455 /// \brief Emit Dwarf abbreviation table.
456 template <typename T> void emitDwarfAbbrevs(const T &Abbrevs) const {
457 // For each abbreviation.
458 for (const auto &Abbrev : Abbrevs)
459 emitDwarfAbbrev(*Abbrev);
461 // Mark end of abbreviations.
462 EmitULEB128(0, "EOM(3)");
465 void emitDwarfAbbrev(const DIEAbbrev &Abbrev) const;
467 /// \brief Recursively emit Dwarf DIE tree.
468 void emitDwarfDIE(const DIE &Die) const;
470 //===------------------------------------------------------------------===//
471 // Inline Asm Support
472 //===------------------------------------------------------------------===//
474 // These are hooks that targets can override to implement inline asm
475 // support. These should probably be moved out of AsmPrinter someday.
477 /// Print information related to the specified machine instr that is
478 /// independent of the operand, and may be independent of the instr itself.
479 /// This can be useful for portably encoding the comment character or other
480 /// bits of target-specific knowledge into the asmstrings. The syntax used is
481 /// ${:comment}. Targets can override this to add support for their own
483 virtual void PrintSpecial(const MachineInstr *MI, raw_ostream &OS,
484 const char *Code) const;
486 /// Print the specified operand of MI, an INLINEASM instruction, using the
487 /// specified assembler variant. Targets should override this to format as
488 /// appropriate. This method can return true if the operand is erroneous.
489 virtual bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
490 unsigned AsmVariant, const char *ExtraCode,
493 /// Print the specified operand of MI, an INLINEASM instruction, using the
494 /// specified assembler variant as an address. Targets should override this to
495 /// format as appropriate. This method can return true if the operand is
497 virtual bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
498 unsigned AsmVariant, const char *ExtraCode,
501 /// Let the target do anything it needs to do before emitting inlineasm.
502 /// \p StartInfo - the subtarget info before parsing inline asm
503 virtual void emitInlineAsmStart() const;
505 /// Let the target do anything it needs to do after emitting inlineasm.
506 /// This callback can be used restore the original mode in case the
507 /// inlineasm contains directives to switch modes.
508 /// \p StartInfo - the original subtarget info before inline asm
509 /// \p EndInfo - the final subtarget info after parsing the inline asm,
510 /// or NULL if the value is unknown.
511 virtual void emitInlineAsmEnd(const MCSubtargetInfo &StartInfo,
512 const MCSubtargetInfo *EndInfo) const;
515 /// Private state for PrintSpecial()
516 // Assign a unique ID to this machine instruction.
517 mutable const MachineInstr *LastMI;
518 mutable unsigned LastFn;
519 mutable unsigned Counter;
521 /// This method emits the header for the current function.
522 virtual void EmitFunctionHeader();
524 /// Emit a blob of inline asm to the output streamer.
526 EmitInlineAsm(StringRef Str, const MCSubtargetInfo &STI,
527 const MCTargetOptions &MCOptions,
528 const MDNode *LocMDNode = nullptr,
529 InlineAsm::AsmDialect AsmDialect = InlineAsm::AD_ATT) const;
531 /// This method formats and emits the specified machine instruction that is an
533 void EmitInlineAsm(const MachineInstr *MI) const;
535 //===------------------------------------------------------------------===//
536 // Internal Implementation Details
537 //===------------------------------------------------------------------===//
539 /// This emits visibility information about symbol, if this is suported by the
541 void EmitVisibility(MCSymbol *Sym, unsigned Visibility,
542 bool IsDefinition = true) const;
544 void EmitLinkage(const GlobalValue *GV, MCSymbol *GVSym) const;
546 void EmitJumpTableEntry(const MachineJumpTableInfo *MJTI,
547 const MachineBasicBlock *MBB, unsigned uid) const;
548 void EmitLLVMUsedList(const ConstantArray *InitList);
549 /// Emit llvm.ident metadata in an '.ident' directive.
550 void EmitModuleIdents(Module &M);
551 void EmitXXStructorList(const DataLayout &DL, const Constant *List,
553 GCMetadataPrinter *GetOrCreateGCPrinter(GCStrategy &C);