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 "AMDGPUMCResourceInfo.h"
18#include "AMDGPUResourceUsageAnalysis.h"
19#include "MCTargetDesc/AMDGPUTargetStreamer.h"
20#include "SIProgramInfo.h"
21#include "llvm/ADT/SetVector.h"
22#include "llvm/CodeGen/AsmPrinter.h"
23
24namespace llvm {
25
26class AMDGPUMachineFunctionInfo;
27class AMDGPUResourceUsageAnalysis;
28class AMDGPUTargetStreamer;
29class MCCodeEmitter;
30class MCOperand;
31class MCResourceInfo;
32
33namespace AMDGPU {
34struct MCKernelDescriptor;
35struct AMDGPUMCKernelCodeT;
36namespace HSAMD {
37class MetadataStreamer;
38}
39} // namespace AMDGPU
40
41class AMDGPUAsmPrinter final : public AsmPrinter {
42public:
43 static char ID;
44
45private:
46 unsigned CodeObjectVersion;
47 void initializeTargetID(const Module &M);
48
49 const AMDGPUResourceUsageAnalysisWrapperPass::FunctionResourceInfo
50 *ResourceUsage;
51
52 MCResourceInfo RI;
53
54 SIProgramInfo CurrentProgramInfo;
55
56 std::unique_ptr<AMDGPU::HSAMD::MetadataStreamer> HSAMetadataStream;
57
58 MCCodeEmitter *DumpCodeInstEmitter = nullptr;
59
60 // When appropriate, add a _dvgpr$ symbol.
61 void emitDVgprSymbol(MachineFunction &MF);
62
63 void getSIProgramInfo(SIProgramInfo &Out, const MachineFunction &MF);
64 void getAmdKernelCode(AMDGPU::AMDGPUMCKernelCodeT &Out,
65 const SIProgramInfo &KernelInfo,
66 const MachineFunction &MF) const;
67
68 /// Emit register usage information so that the GPU driver
69 /// can correctly setup the GPU state.
70 void EmitProgramInfoSI(const MachineFunction &MF,
71 const SIProgramInfo &KernelInfo);
72 void EmitPALMetadata(const MachineFunction &MF,
73 const SIProgramInfo &KernelInfo);
74 void emitPALFunctionMetadata(const MachineFunction &MF);
75 void emitCommonFunctionComments(const MCExpr *NumVGPR, const MCExpr *NumAGPR,
76 const MCExpr *TotalNumVGPR,
77 const MCExpr *NumSGPR,
78 const MCExpr *ScratchSize, uint64_t CodeSize,
79 const AMDGPUMachineFunctionInfo *MFI);
80 void emitResourceUsageRemarks(const MachineFunction &MF,
81 const SIProgramInfo &CurrentProgramInfo,
82 bool isModuleEntryFunction, bool hasMAIInsts);
83
84 const MCExpr *getAmdhsaKernelCodeProperties(const MachineFunction &MF) const;
85
86 AMDGPU::MCKernelDescriptor
87 getAmdhsaKernelDescriptor(const MachineFunction &MF,
88 const SIProgramInfo &PI) const;
89
90 void initTargetStreamer(Module &M);
91
92 void emitAMDGPUInfo(Module &M);
93 void collectCallEdge(const MachineInstr &MI);
94
95 SetVector<std::pair<MCSymbol *, MCSymbol *>> DirectCallEdges;
96
97 SmallVector<AMDGPU::FuncInfo, 8> FunctionInfos;
98
99 SmallString<128> getMCExprStr(const MCExpr *Value);
100
101 /// Attempts to replace the validation that is missed in getSIProgramInfo due
102 /// to MCExpr being unknown. Invoked during doFinalization such that the
103 /// MCResourceInfo symbols are known.
104 void validateMCResourceInfo(Function &F);
105
106public:
107 explicit AMDGPUAsmPrinter(TargetMachine &TM,
108 std::unique_ptr<MCStreamer> Streamer);
109
110 StringRef getPassName() const override;
111
112 const MCSubtargetInfo* getGlobalSTI() const;
113
114 AMDGPUTargetStreamer* getTargetStreamer() const;
115
116 bool doInitialization(Module &M) override;
117 bool doFinalization(Module &M) override;
118 bool runOnMachineFunction(MachineFunction &MF) override;
119
120 /// Wrapper for MCInstLowering.lowerOperand() for the tblgen'erated
121 /// pseudo lowering.
122 bool lowerOperand(const MachineOperand &MO, MCOperand &MCOp) const;
123
124 /// Lower the specified LLVM Constant to an MCExpr.
125 /// The AsmPrinter::lowerConstantof does not know how to lower
126 /// addrspacecast, therefore they should be lowered by this function.
127 const MCExpr *lowerConstant(const Constant *CV, const Constant *BaseCV,
128 uint64_t Offset) override;
129
130 /// tblgen'erated driver function for lowering simple MI->MC pseudo
131 /// instructions.
132 bool lowerPseudoInstExpansion(const MachineInstr *MI, MCInst &Inst);
133
134 /// Implemented in AMDGPUMCInstLower.cpp
135 void emitInstruction(const MachineInstr *MI) override;
136
137 void emitFunctionBodyStart() override;
138
139 void endFunction(const MachineFunction *MF);
140
141 void emitImplicitDef(const MachineInstr *MI) const override;
142
143 void emitFunctionEntryLabel() override;
144
145 void emitBasicBlockStart(const MachineBasicBlock &MBB) override;
146
147 void emitGlobalVariable(const GlobalVariable *GV) override;
148
149 void emitStartOfAsmFile(Module &M) override;
150
151 void emitEndOfAsmFile(Module &M) override;
152
153 bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
154 const char *ExtraCode, raw_ostream &O) override;
155
156protected:
157 void getAnalysisUsage(AnalysisUsage &AU) const override;
158
159 std::vector<std::string> DisasmLines, HexLines;
160 size_t DisasmLineMaxLen;
161 bool IsTargetStreamerInitialized;
162};
163
164} // end namespace llvm
165
166#endif // LLVM_LIB_TARGET_AMDGPU_AMDGPUASMPRINTER_H
167