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