1//==- AMDGPUArgumentrUsageInfo.h - Function Arg Usage Info -------*- 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#ifndef LLVM_LIB_TARGET_AMDGPU_AMDGPUARGUMENTUSAGEINFO_H
10#define LLVM_LIB_TARGET_AMDGPU_AMDGPUARGUMENTUSAGEINFO_H
11
12#include "MCTargetDesc/AMDGPUMCTargetDesc.h"
13#include "llvm/CodeGen/Register.h"
14#include "llvm/IR/CallingConv.h"
15#include <variant>
16
17namespace llvm {
18
19class LLT;
20class raw_ostream;
21class MCRegisterClass;
22using TargetRegisterClass = MCRegisterClass;
23class TargetRegisterInfo;
24
25struct ArgDescriptor {
26private:
27 friend struct AMDGPUFunctionArgInfo;
28
29 std::variant<std::monostate, MCRegister, unsigned> Val;
30
31 // Bitmask to locate argument within the register.
32 unsigned Mask;
33
34public:
35 ArgDescriptor(unsigned Mask = ~0u) : Mask(Mask) {}
36
37 static ArgDescriptor createRegister(Register Reg, unsigned Mask = ~0u) {
38 ArgDescriptor Ret(Mask);
39 Ret.Val = Reg.asMCReg();
40 return Ret;
41 }
42
43 static ArgDescriptor createStack(unsigned Offset, unsigned Mask = ~0u) {
44 ArgDescriptor Ret(Mask);
45 Ret.Val = Offset;
46 return Ret;
47 }
48
49 static ArgDescriptor createArg(const ArgDescriptor &Arg, unsigned Mask) {
50 // Copy the descriptor, then change the mask.
51 ArgDescriptor Ret(Arg);
52 Ret.Mask = Mask;
53 return Ret;
54 }
55
56 bool isSet() const { return !std::holds_alternative<std::monostate>(v: Val); }
57
58 explicit operator bool() const {
59 return isSet();
60 }
61
62 bool isRegister() const { return std::holds_alternative<MCRegister>(v: Val); }
63
64 MCRegister getRegister() const { return std::get<MCRegister>(v: Val); }
65
66 unsigned getStackOffset() const { return std::get<unsigned>(v: Val); }
67
68 unsigned getMask() const {
69 // None of the target SGPRs or VGPRs are expected to have a 'zero' mask.
70 assert(Mask && "Invalid mask.");
71 return Mask;
72 }
73
74 bool isMasked() const {
75 return Mask != ~0u;
76 }
77
78 void print(raw_ostream &OS, const TargetRegisterInfo *TRI = nullptr) const;
79};
80
81inline raw_ostream &operator<<(raw_ostream &OS, const ArgDescriptor &Arg) {
82 Arg.print(OS);
83 return OS;
84}
85
86struct KernArgPreloadDescriptor : public ArgDescriptor {
87 KernArgPreloadDescriptor() = default;
88 SmallVector<MCRegister> Regs;
89};
90
91struct AMDGPUFunctionArgInfo {
92 // clang-format off
93 enum PreloadedValue {
94 // SGPRS:
95 PRIVATE_SEGMENT_BUFFER = 0,
96 DISPATCH_PTR = 1,
97 QUEUE_PTR = 2,
98 KERNARG_SEGMENT_PTR = 3,
99 DISPATCH_ID = 4,
100 FLAT_SCRATCH_INIT = 5,
101 LDS_KERNEL_ID = 6, // LLVM internal, not part of the ABI
102 WORKGROUP_ID_X = 10, // Also used for cluster ID X.
103 WORKGROUP_ID_Y = 11, // Also used for cluster ID Y.
104 WORKGROUP_ID_Z = 12, // Also used for cluster ID Z.
105 PRIVATE_SEGMENT_WAVE_BYTE_OFFSET = 14,
106 IMPLICIT_BUFFER_PTR = 15,
107 IMPLICIT_ARG_PTR = 16,
108 PRIVATE_SEGMENT_SIZE = 17,
109 CLUSTER_WORKGROUP_ID_X = 21,
110 CLUSTER_WORKGROUP_ID_Y = 22,
111 CLUSTER_WORKGROUP_ID_Z = 23,
112 CLUSTER_WORKGROUP_MAX_ID_X = 24,
113 CLUSTER_WORKGROUP_MAX_ID_Y = 25,
114 CLUSTER_WORKGROUP_MAX_ID_Z = 26,
115 CLUSTER_WORKGROUP_MAX_FLAT_ID = 27,
116
117 // VGPRS:
118 WORKITEM_ID_X = 28,
119 WORKITEM_ID_Y = 29,
120 WORKITEM_ID_Z = 30,
121 FIRST_VGPR_VALUE = WORKITEM_ID_X
122 };
123 // clang-format on
124
125 // Kernel input registers setup for the HSA ABI in allocation order.
126
127 // User SGPRs in kernels
128 // XXX - Can these require argument spills?
129 ArgDescriptor PrivateSegmentBuffer;
130 ArgDescriptor DispatchPtr;
131 ArgDescriptor QueuePtr;
132 ArgDescriptor KernargSegmentPtr;
133 ArgDescriptor DispatchID;
134 ArgDescriptor FlatScratchInit;
135 ArgDescriptor PrivateSegmentSize;
136 ArgDescriptor LDSKernelId;
137
138 // System SGPRs in kernels.
139 ArgDescriptor WorkGroupIDX;
140 ArgDescriptor WorkGroupIDY;
141 ArgDescriptor WorkGroupIDZ;
142 ArgDescriptor WorkGroupInfo;
143 ArgDescriptor PrivateSegmentWaveByteOffset;
144
145 // Pointer with offset from kernargsegmentptr to where special ABI arguments
146 // are passed to callable functions.
147 ArgDescriptor ImplicitArgPtr;
148
149 // Input registers for non-HSA ABI
150 ArgDescriptor ImplicitBufferPtr;
151
152 // VGPRs inputs. For entry functions these are either v0, v1 and v2 or packed
153 // into v0, 10 bits per dimension if packed-tid is set.
154 ArgDescriptor WorkItemIDX;
155 ArgDescriptor WorkItemIDY;
156 ArgDescriptor WorkItemIDZ;
157
158 // Map the index of preloaded kernel arguments to its descriptor.
159 SmallDenseMap<int, KernArgPreloadDescriptor> PreloadKernArgs{};
160 // The first user SGPR allocated for kernarg preloading.
161 Register FirstKernArgPreloadReg;
162
163 std::tuple<const ArgDescriptor *, const TargetRegisterClass *, LLT>
164 getPreloadedValue(PreloadedValue Value) const;
165
166 /// Returns the register a non-entry function with calling convention \p CC
167 /// expects the private segment buffer in.
168 static MCRegister getPrivateSegmentBufferReg(CallingConv::ID CC);
169
170 static AMDGPUFunctionArgInfo fixedABILayout();
171 static const AMDGPUFunctionArgInfo FixedABIFunctionInfo;
172};
173
174} // end namespace llvm
175
176#endif
177