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 std::optional<uint32_t> NumAGPR, 67 uint32_t TotalNumVGPR, uint32_t NumSGPR, 68 uint64_t ScratchSize, uint64_t CodeSize, 69 const AMDGPUMachineFunction *MFI); 70 void emitResourceUsageRemarks(const MachineFunction &MF, 71 const SIProgramInfo &CurrentProgramInfo, 72 bool isModuleEntryFunction, bool hasMAIInsts); 73 74 uint16_t getAmdhsaKernelCodeProperties( 75 const MachineFunction &MF) const; 76 77 amdhsa::kernel_descriptor_t getAmdhsaKernelDescriptor( 78 const MachineFunction &MF, 79 const SIProgramInfo &PI) const; 80 81 void initTargetStreamer(Module &M); 82 83 public: 84 explicit AMDGPUAsmPrinter(TargetMachine &TM, 85 std::unique_ptr<MCStreamer> Streamer); 86 87 StringRef getPassName() const override; 88 89 const MCSubtargetInfo* getGlobalSTI() const; 90 91 AMDGPUTargetStreamer* getTargetStreamer() const; 92 93 bool doFinalization(Module &M) override; 94 bool runOnMachineFunction(MachineFunction &MF) override; 95 96 /// Wrapper for MCInstLowering.lowerOperand() for the tblgen'erated 97 /// pseudo lowering. 98 bool lowerOperand(const MachineOperand &MO, MCOperand &MCOp) const; 99 100 /// Lower the specified LLVM Constant to an MCExpr. 101 /// The AsmPrinter::lowerConstantof does not know how to lower 102 /// addrspacecast, therefore they should be lowered by this function. 103 const MCExpr *lowerConstant(const Constant *CV) override; 104 105 /// tblgen'erated driver function for lowering simple MI->MC pseudo 106 /// instructions. 107 bool emitPseudoExpansionLowering(MCStreamer &OutStreamer, 108 const MachineInstr *MI); 109 110 /// Implemented in AMDGPUMCInstLower.cpp 111 void emitInstruction(const MachineInstr *MI) override; 112 113 void emitFunctionBodyStart() override; 114 115 void emitFunctionBodyEnd() override; 116 117 void emitFunctionEntryLabel() override; 118 119 void emitBasicBlockStart(const MachineBasicBlock &MBB) override; 120 121 void emitGlobalVariable(const GlobalVariable *GV) override; 122 123 void emitStartOfAsmFile(Module &M) override; 124 125 void emitEndOfAsmFile(Module &M) override; 126 127 bool isBlockOnlyReachableByFallthrough( 128 const MachineBasicBlock *MBB) const override; 129 130 bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo, 131 const char *ExtraCode, raw_ostream &O) override; 132 133 protected: 134 void getAnalysisUsage(AnalysisUsage &AU) const override; 135 136 std::vector<std::string> DisasmLines, HexLines; 137 size_t DisasmLineMaxLen; 138 bool IsTargetStreamerInitialized; 139 }; 140 141 } // end namespace llvm 142 143 #endif // LLVM_LIB_TARGET_AMDGPU_AMDGPUASMPRINTER_H 144