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 "SIProgramInfo.h"
18 #include "llvm/CodeGen/AsmPrinter.h"
19 
20 struct amd_kernel_code_t;
21 
22 namespace llvm {
23 
24 class AMDGPUMachineFunction;
25 struct AMDGPUResourceUsageAnalysis;
26 class AMDGPUTargetStreamer;
27 class MCCodeEmitter;
28 class MCOperand;
29 class GCNSubtarget;
30 
31 namespace AMDGPU {
32 namespace HSAMD {
33 class MetadataStreamer;
34 }
35 } // namespace AMDGPU
36 
37 namespace amdhsa {
38 struct kernel_descriptor_t;
39 }
40 
41 class AMDGPUAsmPrinter final : public AsmPrinter {
42 private:
43   void initializeTargetID(const Module &M);
44 
45   AMDGPUResourceUsageAnalysis *ResourceUsage;
46 
47   SIProgramInfo CurrentProgramInfo;
48 
49   std::unique_ptr<AMDGPU::HSAMD::MetadataStreamer> HSAMetadataStream;
50 
51   MCCodeEmitter *DumpCodeInstEmitter = nullptr;
52 
53   uint64_t getFunctionCodeSize(const MachineFunction &MF) const;
54 
55   void getSIProgramInfo(SIProgramInfo &Out, const MachineFunction &MF);
56   void getAmdKernelCode(amd_kernel_code_t &Out, const SIProgramInfo &KernelInfo,
57                         const MachineFunction &MF) const;
58   void findNumUsedRegistersSI(const MachineFunction &MF,
59                               unsigned &NumSGPR,
60                               unsigned &NumVGPR) const;
61 
62   /// Emit register usage information so that the GPU driver
63   /// can correctly setup the GPU state.
64   void EmitProgramInfoSI(const MachineFunction &MF,
65                          const SIProgramInfo &KernelInfo);
66   void EmitPALMetadata(const MachineFunction &MF,
67                        const SIProgramInfo &KernelInfo);
68   void emitPALFunctionMetadata(const MachineFunction &MF);
69   void emitCommonFunctionComments(uint32_t NumVGPR,
70                                   Optional<uint32_t> NumAGPR,
71                                   uint32_t TotalNumVGPR,
72                                   uint32_t NumSGPR,
73                                   uint64_t ScratchSize,
74                                   uint64_t CodeSize,
75                                   const AMDGPUMachineFunction* MFI);
76 
77   uint16_t getAmdhsaKernelCodeProperties(
78       const MachineFunction &MF) const;
79 
80   amdhsa::kernel_descriptor_t getAmdhsaKernelDescriptor(
81       const MachineFunction &MF,
82       const SIProgramInfo &PI) const;
83 
84 public:
85   explicit AMDGPUAsmPrinter(TargetMachine &TM,
86                             std::unique_ptr<MCStreamer> Streamer);
87 
88   StringRef getPassName() const override;
89 
90   const MCSubtargetInfo* getGlobalSTI() const;
91 
92   AMDGPUTargetStreamer* getTargetStreamer() const;
93 
94   bool doFinalization(Module &M) override;
95   bool runOnMachineFunction(MachineFunction &MF) override;
96 
97   /// Wrapper for MCInstLowering.lowerOperand() for the tblgen'erated
98   /// pseudo lowering.
99   bool lowerOperand(const MachineOperand &MO, MCOperand &MCOp) const;
100 
101   /// Lower the specified LLVM Constant to an MCExpr.
102   /// The AsmPrinter::lowerConstantof does not know how to lower
103   /// addrspacecast, therefore they should be lowered by this function.
104   const MCExpr *lowerConstant(const Constant *CV) override;
105 
106   /// tblgen'erated driver function for lowering simple MI->MC pseudo
107   /// instructions.
108   bool emitPseudoExpansionLowering(MCStreamer &OutStreamer,
109                                    const MachineInstr *MI);
110 
111   /// Implemented in AMDGPUMCInstLower.cpp
112   void emitInstruction(const MachineInstr *MI) override;
113 
114   void emitFunctionBodyStart() override;
115 
116   void emitFunctionBodyEnd() override;
117 
118   void emitFunctionEntryLabel() override;
119 
120   void emitBasicBlockStart(const MachineBasicBlock &MBB) override;
121 
122   void emitGlobalVariable(const GlobalVariable *GV) override;
123 
124   void emitStartOfAsmFile(Module &M) override;
125 
126   void emitEndOfAsmFile(Module &M) override;
127 
128   bool isBlockOnlyReachableByFallthrough(
129     const MachineBasicBlock *MBB) const override;
130 
131   bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
132                        const char *ExtraCode, raw_ostream &O) override;
133 
134 protected:
135   void getAnalysisUsage(AnalysisUsage &AU) const override;
136 
137   std::vector<std::string> DisasmLines, HexLines;
138   size_t DisasmLineMaxLen;
139 };
140 
141 } // end namespace llvm
142 
143 #endif // LLVM_LIB_TARGET_AMDGPU_AMDGPUASMPRINTER_H
144