AMDGPUAsmPrinter.h revision 360784 
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"
19#include "AMDGPUHSAMetadataStreamer.h"
20#include "SIProgramInfo.h"
21#include "llvm/ADT/StringRef.h"
22#include "llvm/CodeGen/AsmPrinter.h"
23#include "llvm/Support/AMDHSAKernelDescriptor.h"
24#include <cstddef>
25#include <cstdint>
26#include <limits>
27#include <memory>
28#include <string>
29#include <vector>
30
31namespace llvm {
32
33class AMDGPUMachineFunction;
34class AMDGPUTargetStreamer;
35class MCCodeEmitter;
36class MCOperand;
37class GCNSubtarget;
38
39class AMDGPUAsmPrinter final : public AsmPrinter {
40private:
41  // Track resource usage for callee functions.
42  struct SIFunctionResourceInfo {
43    // Track the number of explicitly used VGPRs. Special registers reserved at
44    // the end are tracked separately.
45    int32_t NumVGPR = 0;
46    int32_t NumAGPR = 0;
47    int32_t NumExplicitSGPR = 0;
48    uint64_t PrivateSegmentSize = 0;
49    bool UsesVCC = false;
50    bool UsesFlatScratch = false;
51    bool HasDynamicallySizedStack = false;
52    bool HasRecursion = false;
53
54    int32_t getTotalNumSGPRs(const GCNSubtarget &ST) const;
55    int32_t getTotalNumVGPRs(const GCNSubtarget &ST) const;
56  };
57
58  SIProgramInfo CurrentProgramInfo;
59  DenseMap<const Function *, SIFunctionResourceInfo> CallGraphResourceInfo;
60
61  std::unique_ptr<AMDGPU::HSAMD::MetadataStreamer> HSAMetadataStream;
62
63  MCCodeEmitter *DumpCodeInstEmitter = nullptr;
64
65  uint64_t getFunctionCodeSize(const MachineFunction &MF) const;
66  SIFunctionResourceInfo analyzeResourceUsage(const MachineFunction &MF) const;
67
68  void getSIProgramInfo(SIProgramInfo &Out, const MachineFunction &MF);
69  void getAmdKernelCode(amd_kernel_code_t &Out, const SIProgramInfo &KernelInfo,
70                        const MachineFunction &MF) const;
71  void findNumUsedRegistersSI(const MachineFunction &MF,
72                              unsigned &NumSGPR,
73                              unsigned &NumVGPR) const;
74
75  /// Emit register usage information so that the GPU driver
76  /// can correctly setup the GPU state.
77  void EmitProgramInfoSI(const MachineFunction &MF,
78                         const SIProgramInfo &KernelInfo);
79  void EmitPALMetadata(const MachineFunction &MF,
80                       const SIProgramInfo &KernelInfo);
81  void emitCommonFunctionComments(uint32_t NumVGPR,
82                                  Optional<uint32_t> NumAGPR,
83                                  uint32_t TotalNumVGPR,
84                                  uint32_t NumSGPR,
85                                  uint64_t ScratchSize,
86                                  uint64_t CodeSize,
87                                  const AMDGPUMachineFunction* MFI);
88
89  uint16_t getAmdhsaKernelCodeProperties(
90      const MachineFunction &MF) const;
91
92  amdhsa::kernel_descriptor_t getAmdhsaKernelDescriptor(
93      const MachineFunction &MF,
94      const SIProgramInfo &PI) const;
95
96public:
97  explicit AMDGPUAsmPrinter(TargetMachine &TM,
98                            std::unique_ptr<MCStreamer> Streamer);
99
100  StringRef getPassName() const override;
101
102  const MCSubtargetInfo* getGlobalSTI() const;
103
104  AMDGPUTargetStreamer* getTargetStreamer() const;
105
106  bool doFinalization(Module &M) override;
107  bool runOnMachineFunction(MachineFunction &MF) override;
108
109  /// Wrapper for MCInstLowering.lowerOperand() for the tblgen'erated
110  /// pseudo lowering.
111  bool lowerOperand(const MachineOperand &MO, MCOperand &MCOp) const;
112
113  /// Lower the specified LLVM Constant to an MCExpr.
114  /// The AsmPrinter::lowerConstantof does not know how to lower
115  /// addrspacecast, therefore they should be lowered by this function.
116  const MCExpr *lowerConstant(const Constant *CV) override;
117
118  /// tblgen'erated driver function for lowering simple MI->MC pseudo
119  /// instructions.
120  bool emitPseudoExpansionLowering(MCStreamer &OutStreamer,
121                                   const MachineInstr *MI);
122
123  /// Implemented in AMDGPUMCInstLower.cpp
124  void EmitInstruction(const MachineInstr *MI) override;
125
126  void EmitFunctionBodyStart() override;
127
128  void EmitFunctionBodyEnd() override;
129
130  void EmitFunctionEntryLabel() override;
131
132  void EmitBasicBlockStart(const MachineBasicBlock &MBB) override;
133
134  void EmitGlobalVariable(const GlobalVariable *GV) override;
135
136  void EmitStartOfAsmFile(Module &M) override;
137
138  void EmitEndOfAsmFile(Module &M) override;
139
140  bool isBlockOnlyReachableByFallthrough(
141    const MachineBasicBlock *MBB) const override;
142
143  bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
144                       const char *ExtraCode, raw_ostream &O) override;
145
146protected:
147  std::vector<std::string> DisasmLines, HexLines;
148  size_t DisasmLineMaxLen;
149};
150
151} // end namespace llvm
152
153#endif // LLVM_LIB_TARGET_AMDGPU_AMDGPUASMPRINTER_H
154