1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
/*========================== begin_copyright_notice ============================
Copyright (C) 2021 Intel Corporation
SPDX-License-Identifier: MIT
============================= end_copyright_notice ===========================*/
//
/// implicit_args structure/buffer description and utils.
///
//===----------------------------------------------------------------------===//
#ifndef VC_UTILS_GENX_IMPLICITARGSBUFFER_H
#define VC_UTILS_GENX_IMPLICITARGSBUFFER_H
#include "vc/Utils/General/Types.h"
#include <llvm/ADT/Twine.h>
#include <llvm/IR/IRBuilder.h>
namespace llvm {
class StructType;
class PointerType;
class Value;
class Module;
} // namespace llvm
namespace vc {
// Depending on target architecture payload (kernel arguments) can be passed
// either through memory (pointer to the buffer with arguments is passed in r0.0
// register) or directly through registers (hardware itself initializes special
// registers with the arguments).
enum class ThreadPayloadKind {
InMemory,
OnRegister,
};
// Indirect data heap pointer is provided in r0.0[31:PtrOffsetInR00]
constexpr unsigned PtrOffsetInR00 = 6;
namespace ImplicitArgs {
// An attribute that indicates that for the marked kernel implicit args buffer
// should be generated, e.g. kernel calls external function that uses some
// implicit argument.
inline const char KernelAttr[] = "RequiresImplArgsBuffer";
namespace Buffer {
namespace Indices {
enum Enum {
StructSize,
StructVersion,
NumWorkDim,
SIMDWidth,
LocalSizeX,
LocalSizeY,
LocalSizeZ,
GlobalSizeX,
GlobalSizeY,
GlobalSizeZ,
PrintfBufferPtr,
GlobalOffsetX,
GlobalOffsetY,
GlobalOffsetZ,
LocalIDTablePtr,
GroupCountX,
GroupCountY,
GroupCountZ,
Size
};
} // namespace Indices
// The name of implicit arguments buffer structure.
inline const char TypeName[] = "vc.implicit.args.buf.type";
// Returns implicit arguments buffer type.
// The returned structure has name \p TypeName.
// The function returns existing type or creates a new one if it hasn't been
// created.
llvm::StructType &getType(llvm::Module &M);
// Returns the address space of a pointer to implicit arguments buffer.
AddrSpace::Enum getPtrAddrSpace(ThreadPayloadKind Kind);
// Returns the type of a pointer to implicit arguments buffer.
llvm::PointerType &getPtrType(llvm::Module &M, ThreadPayloadKind Kind);
// Inserts instructions to access a pointer to implicit arguments buffer.
// Returns the pointer value. Instructions are inserted via the provided IR
// builder.
// Different code must be inserted depending on thread payload kind \p Kind.
// Implicit args buffer predefined variable must be available before calling
// this function for payload on registers case.
llvm::Value &getPointer(llvm::IRBuilder<> &IRB, ThreadPayloadKind Kind);
template <ThreadPayloadKind Kind>
llvm::Value &getPointer(llvm::IRBuilder<> &IRB);
template <>
llvm::Value &getPointer<ThreadPayloadKind::InMemory>(llvm::IRBuilder<> &IRB);
template <>
llvm::Value &getPointer<ThreadPayloadKind::OnRegister>(llvm::IRBuilder<> &IRB);
// Inserts instructions that access requested buffer field.
// Arguments:
// \p BufferPtr - a pointer to the whole buffer. Should be obtained via
// vc::ImplicitArgs::Buffer::getPointer interface.
// \p FieldIdx - the index of the requested field.
// \p IRB - IR builder to insert the instructions.
// \p Name - a name of the returned value and a prefix for other constructed
// value names.
llvm::Value &loadField(llvm::Value &BufferPtr, Indices::Enum FieldIdx,
llvm::IRBuilder<> &IRB, const llvm::Twine &Name = "");
} // namespace Buffer
// Local ID structure type description.
// LocalIDTablePtr field of the implicit args buffer points to the array of
// local ID structures or to the first element of this table (which is the
// same).
namespace LocalID {
// Indices of the structure fields.
namespace Indices {
enum Enum { X, Y, Z, Size };
} // namespace Indices
// The name of local ID structure type.
inline const char TypeName[] = "vc.ia.local.id.type";
// Returns local ID structure type.
// The returned structure has name \p TypeName.
// The function returns existing type or creates a new one if it hasn't been
// created.
llvm::StructType &getType(llvm::Module &M);
// Returns the type of a pointer to local ID structure.
llvm::PointerType &getPtrType(llvm::Module &M);
// Inserts instructions that acceess the pointer to local ID table (to the first
// element of this table).
// Arguments:
// \p BufferPtr - a pointer to the implicit args buffer. Should be obtained
// via vc::ImplicitArgs::Buffer::getPointer interface.
// \p IRB - IR builder to insert the instructions.
// \p Name - a name of the returned value and a prefix for other constructed
// value names.
llvm::Value &getBasePtr(llvm::Value &BufferPtr, llvm::IRBuilder<> &IRB,
const llvm::Twine &Name = "ia.local.id.base.ptr");
// Inserts instructions that access the pointer to the local ID structure that
// describes currently executing thread.
// Arguments:
// \p BufferPtr - a pointer to the implicit args buffer. Should be obtained
// via vc::ImplicitArgs::Buffer::getPointer interface.
// It is not used in payload on register case but still must
// be provided to have a uniform interface between different
// payload kinds.
// \p IRB - IR builder to insert the instructions.
// \p Name - a name of the returned value and a prefix for other constructed
// value names.
llvm::Value &getPointer(llvm::Value &BufferPtr, llvm::IRBuilder<> &IRB,
ThreadPayloadKind Kind,
const llvm::Twine &Name = "ia.local.id.ptr");
template <ThreadPayloadKind Kind>
llvm::Value &getPointer(llvm::Value &BufferPtr, llvm::IRBuilder<> &IRB,
const llvm::Twine &Name = "ia.local.id.ptr");
template <>
llvm::Value &getPointer<ThreadPayloadKind::InMemory>(llvm::Value &BufferPtr,
llvm::IRBuilder<> &IRB,
const llvm::Twine &Name);
template <>
llvm::Value &getPointer<ThreadPayloadKind::OnRegister>(llvm::Value &BufferPtr,
llvm::IRBuilder<> &IRB,
const llvm::Twine &Name);
// Inserts instructions that load a field from local ID structure.
// Arguments:
// \p LIDStructPtr - a pointer to a local ID structure. Should be obtained
// via vc::ImplicitArgs::LocalID::getPointer interface.
// \p FieldIdx - the index of the requested field.
// \p IRB - IR builder to insert the instructions.
// \p Name - a name of the returned value and a prefix for other constructed
// value names.
llvm::Value &loadField(llvm::Value &LIDStructPtr, Indices::Enum FieldIdx,
llvm::IRBuilder<> &IRB,
const llvm::Twine &Name = "ia.local.id.field");
} // namespace LocalID
} // namespace ImplicitArgs
} // end namespace vc
#endif // VC_UTILS_GENX_IMPLICITARGSBUFFER_H
|
