LLVM  9.0.0svn
AMDGPUAsmPrinter.h
Go to the documentation of this file.
1 //===-- AMDGPUAsmPrinter.h - Print AMDGPU assembly code ---------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 /// \file
10 /// AMDGPU Assembly printer class.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_LIB_TARGET_AMDGPU_AMDGPUASMPRINTER_H
15 #define LLVM_LIB_TARGET_AMDGPU_AMDGPUASMPRINTER_H
16 
17 #include "AMDGPU.h"
18 #include "AMDKernelCodeT.h"
20 #include "SIProgramInfo.h"
21 #include "llvm/ADT/StringRef.h"
24 #include <cstddef>
25 #include <cstdint>
26 #include <limits>
27 #include <memory>
28 #include <string>
29 #include <vector>
30 
31 namespace llvm {
32 
33 class AMDGPUMachineFunction;
34 class AMDGPUTargetStreamer;
35 class MCOperand;
36 class GCNSubtarget;
37 
38 class AMDGPUAsmPrinter final : public AsmPrinter {
39 private:
40  // Track resource usage for callee functions.
41  struct SIFunctionResourceInfo {
42  // Track the number of explicitly used VGPRs. Special registers reserved at
43  // the end are tracked separately.
44  int32_t NumVGPR = 0;
45  int32_t NumExplicitSGPR = 0;
46  uint64_t PrivateSegmentSize = 0;
47  bool UsesVCC = false;
48  bool UsesFlatScratch = false;
49  bool HasDynamicallySizedStack = false;
50  bool HasRecursion = false;
51 
52  int32_t getTotalNumSGPRs(const GCNSubtarget &ST) const;
53  };
54 
55  SIProgramInfo CurrentProgramInfo;
57 
58  std::unique_ptr<AMDGPU::HSAMD::MetadataStreamer> HSAMetadataStream;
59  std::map<uint32_t, uint32_t> PALMetadataMap;
60 
61  uint64_t getFunctionCodeSize(const MachineFunction &MF) const;
62  SIFunctionResourceInfo analyzeResourceUsage(const MachineFunction &MF) const;
63 
64  void readPALMetadata(Module &M);
65  void getSIProgramInfo(SIProgramInfo &Out, const MachineFunction &MF);
66  void getAmdKernelCode(amd_kernel_code_t &Out, const SIProgramInfo &KernelInfo,
67  const MachineFunction &MF) const;
68  void findNumUsedRegistersSI(const MachineFunction &MF,
69  unsigned &NumSGPR,
70  unsigned &NumVGPR) const;
71 
72  /// Emit register usage information so that the GPU driver
73  /// can correctly setup the GPU state.
74  void EmitProgramInfoSI(const MachineFunction &MF,
75  const SIProgramInfo &KernelInfo);
76  void EmitPALMetadata(const MachineFunction &MF,
77  const SIProgramInfo &KernelInfo);
78  void emitCommonFunctionComments(uint32_t NumVGPR,
79  uint32_t NumSGPR,
80  uint64_t ScratchSize,
81  uint64_t CodeSize,
82  const AMDGPUMachineFunction* MFI);
83 
84  uint16_t getAmdhsaKernelCodeProperties(
85  const MachineFunction &MF) const;
86 
87  amdhsa::kernel_descriptor_t getAmdhsaKernelDescriptor(
88  const MachineFunction &MF,
89  const SIProgramInfo &PI) const;
90 
91 public:
93  std::unique_ptr<MCStreamer> Streamer);
94 
95  StringRef getPassName() const override;
96 
97  const MCSubtargetInfo* getGlobalSTI() const;
98 
100 
101  bool doFinalization(Module &M) override;
102  bool runOnMachineFunction(MachineFunction &MF) override;
103 
104  /// Wrapper for MCInstLowering.lowerOperand() for the tblgen'erated
105  /// pseudo lowering.
106  bool lowerOperand(const MachineOperand &MO, MCOperand &MCOp) const;
107 
108  /// Lower the specified LLVM Constant to an MCExpr.
109  /// The AsmPrinter::lowerConstantof does not know how to lower
110  /// addrspacecast, therefore they should be lowered by this function.
111  const MCExpr *lowerConstant(const Constant *CV) override;
112 
113  /// tblgen'erated driver function for lowering simple MI->MC pseudo
114  /// instructions.
116  const MachineInstr *MI);
117 
118  /// Implemented in AMDGPUMCInstLower.cpp
119  void EmitInstruction(const MachineInstr *MI) override;
120 
121  void EmitFunctionBodyStart() override;
122 
123  void EmitFunctionBodyEnd() override;
124 
125  void EmitFunctionEntryLabel() override;
126 
127  void EmitBasicBlockStart(const MachineBasicBlock &MBB) const override;
128 
129  void EmitGlobalVariable(const GlobalVariable *GV) override;
130 
131  void EmitStartOfAsmFile(Module &M) override;
132 
133  void EmitEndOfAsmFile(Module &M) override;
134 
136  const MachineBasicBlock *MBB) const override;
137 
138  bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
139  unsigned AsmVariant, const char *ExtraCode,
140  raw_ostream &O) override;
141 
142 protected:
143  mutable std::vector<std::string> DisasmLines, HexLines;
144  mutable size_t DisasmLineMaxLen;
145 };
146 
147 } // end namespace llvm
148 
149 #endif // LLVM_LIB_TARGET_AMDGPU_AMDGPUASMPRINTER_H
void EmitGlobalVariable(const GlobalVariable *GV) override
Emit the specified global variable to the .s file.
const MCExpr * lowerConstant(const Constant *CV) override
Lower the specified LLVM Constant to an MCExpr.
std::unique_ptr< MCStreamer > OutStreamer
This is the MCStreamer object for the file we are generating.
Definition: AsmPrinter.h:93
This class represents lattice values for constants.
Definition: AllocatorList.h:23
const MCSubtargetInfo * getGlobalSTI() const
A Module instance is used to store all the information related to an LLVM module. ...
Definition: Module.h:64
void EmitFunctionBodyEnd() override
Targets can override this to emit stuff after the last basic block in the function.
bool emitPseudoExpansionLowering(MCStreamer &OutStreamer, const MachineInstr *MI)
tblgen&#39;erated driver function for lowering simple MI->MC pseudo instructions.
MachineFunction * MF
The current machine function.
Definition: AsmPrinter.h:96
Track resource usage for kernels / entry functions.
Definition: SIProgramInfo.h:21
AMD Kernel Code Object (amd_kernel_code_t).
Defines struct to track resource usage for kernels and entry functions.
Base class for the full range of assembler expressions which are needed for parsing.
Definition: MCExpr.h:35
AMDGPUAsmPrinter(TargetMachine &TM, std::unique_ptr< MCStreamer > Streamer)
void EmitInstruction(const MachineInstr *MI) override
Implemented in AMDGPUMCInstLower.cpp.
AMDGPU HSA Metadata Streamer.
bool isBlockOnlyReachableByFallthrough(const MachineBasicBlock *MBB) const override
Return true if the basic block has exactly one predecessor and the control transfer mechanism between...
Streaming machine code generation interface.
Definition: MCStreamer.h:188
This is an important base class in LLVM.
Definition: Constant.h:41
bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo, unsigned AsmVariant, const char *ExtraCode, raw_ostream &O) override
Print the specified operand of MI, an INLINEASM instruction, using the specified assembler variant...
TargetMachine & TM
Target machine description.
Definition: AsmPrinter.h:81
This class is intended to be used as a driving class for all asm writers.
Definition: AsmPrinter.h:78
void EmitEndOfAsmFile(Module &M) override
This virtual method can be overridden by targets that want to emit something at the end of their file...
void EmitBasicBlockStart(const MachineBasicBlock &MBB) const override
Targets can override this to emit stuff at the start of a basic block.
AMDGPUTargetStreamer * getTargetStreamer() const
AMDHSA kernel descriptor definitions.
std::vector< std::string > HexLines
unsigned getTotalNumSGPRs(const MCSubtargetInfo *STI)
MachineOperand class - Representation of each machine instruction operand.
bool runOnMachineFunction(MachineFunction &MF) override
Emit the specified function out to the OutStreamer.
std::vector< std::string > DisasmLines
void EmitFunctionEntryLabel() override
EmitFunctionEntryLabel - Emit the label that is the entrypoint for the function.
Representation of each machine instruction.
Definition: MachineInstr.h:63
void EmitFunctionBodyStart() override
Targets can override this to emit stuff before the first basic block in the function.
bool doFinalization(Module &M) override
Shut down the asmprinter.
Generic base class for all target subtargets.
StringRef getPassName() const override
getPassName - Return a nice clean name for a pass.
void EmitStartOfAsmFile(Module &M) override
This virtual method can be overridden by targets that want to emit something at the start of their fi...
This class implements an extremely fast bulk output stream that can only output to a stream...
Definition: raw_ostream.h:45
Primary interface to the complete machine description for the target machine.
Definition: TargetMachine.h:58
IRTranslator LLVM IR MI
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:48
bool lowerOperand(const MachineOperand &MO, MCOperand &MCOp) const
Wrapper for MCInstLowering.lowerOperand() for the tblgen&#39;erated pseudo lowering.
Instances of this class represent operands of the MCInst class.
Definition: MCInst.h:34