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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
|
/****************************************************************************
**
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtOpenCL module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qclworksize.h"
#include "qcldevice.h"
QT_BEGIN_NAMESPACE
/*!
\class QCLWorkSize
\brief The QCLWorkSize class defines the size of an item of work for an OpenCL kernel.
\since 4.7
\ingroup opencl
OpenCL work sizes may be single-dimensional, two-dimensional,
or three-dimensional:
\code
QCLWorkSize oned(128);
QCLWorkSize twod(16, 16);
QCLWorkSize threed(32, 32, 16);
...
QCLKernel kernel = ...;
kernel.setGlobalWorkSize(oned);
kernel.setGlobalWorkSize(twod);
kernel.setGlobalWorkSize(threed);
\endcode
For convenience, QCLKernel::setGlobalWorkSize() and
QCLKernel::setLocalWorkSize() can be specified by a QCLWorkSize
object or direct numeric arguments:
\code
QCLKernel kernel = ...;
kernel.setGlobalWorkSize(128);
kernel.setGlobalWorkSize(16, 16);
kernel.setGlobalWorkSize(32, 32, 16);
\endcode
\sa QCLKernel
*/
/*!
\fn QCLWorkSize::QCLWorkSize()
Constructs a default work size consisting of a single dimension
with width() set to 1.
*/
/*!
\fn QCLWorkSize::QCLWorkSize(size_t size)
Constructs a single-dimensional work size with width() set to \a size.
The height() and depth() will be set to 1.
*/
/*!
\fn QCLWorkSize::QCLWorkSize(size_t width, size_t height)
Constructs a two-dimensional work size of \a width x \a height.
The depth() will be set to 1.
*/
/*!
\fn QCLWorkSize::QCLWorkSize(const QSize &size)
Constructs a two-dimensional work size set to \a size.
The depth() will be set to 1.
*/
/*!
\fn QCLWorkSize::QCLWorkSize(size_t width, size_t height, size_t depth)
Constructs a three-dimensional work size of \a width x \a height x
\a depth.
*/
/*!
\fn size_t QCLWorkSize::dimensions() const
Returns the number of dimensions for this work size, 1, 2, or 3.
*/
/*!
\fn size_t QCLWorkSize::width() const
Returns the width of this work size specification.
*/
/*!
\fn size_t QCLWorkSize::height() const
Returns the height of this work size specification.
*/
/*!
\fn size_t QCLWorkSize::depth() const
Returns the depth of this work size specification.
*/
/*!
\fn const size_t *QCLWorkSize::sizes() const
Returns a const pointer to the size array within this object.
*/
/*!
\fn bool QCLWorkSize::operator==(const QCLWorkSize &other) const
Returns true if this work size specification has the same
dimensions as \a other; false otherwise.
\sa operator!=()
*/
/*!
\fn bool QCLWorkSize::operator!=(const QCLWorkSize &other) const
Returns true if this work size specification does not have
the same dimensions as \a other; false otherwise.
\sa operator==()
*/
static size_t qt_gcd_of_size(size_t x, size_t y)
{
size_t remainder;
while ((remainder = x % y) != 0) {
x = y;
y = remainder;
}
return y;
}
/*!
Returns the best-fit local work size that evenly divides this work
size and fits within the maximums defined by \a maxWorkItemSize
and \a maxItemsPerGroup.
This function is typically used to convert an arbitrary global
work size on a QCLKernel into a compatible local work size.
\sa QCLKernel::setLocalWorkSize()
*/
QCLWorkSize QCLWorkSize::toLocalWorkSize
(const QCLWorkSize &maxWorkItemSize, size_t maxItemsPerGroup) const
{
// Adjust for the maximum work item size in each dimension.
size_t width = m_dim >= 1 ? qt_gcd_of_size(m_sizes[0], maxWorkItemSize.width()) : 1;
size_t height = m_dim >= 2 ? qt_gcd_of_size(m_sizes[1], maxWorkItemSize.height()) : 1;
size_t depth = m_dim >= 3 ? qt_gcd_of_size(m_sizes[2], maxWorkItemSize.depth()) : 1;
// Reduce in size by a factor of 2 until underneath the maximum group size.
while (maxItemsPerGroup && (width * height * depth) > maxItemsPerGroup) {
width = (width > 1) ? (width / 2) : 1;
height = (height > 1) ? (height / 2) : 1;
depth = (depth > 1) ? (depth / 2) : 1;
}
// Return the final result.
if (m_dim >= 3)
return QCLWorkSize(width, height, depth);
else if (m_dim >= 2)
return QCLWorkSize(width, height);
else
return QCLWorkSize(width);
}
/*!
Returns the best-fit local work size that evenly divides this
work size and fits within the maximum work group size of \a device.
This function is typically used to convert an arbitrary global
work size on a QCLKernel into a compatible local work size.
\sa QCLKernel::setLocalWorkSize()
*/
QCLWorkSize QCLWorkSize::toLocalWorkSize(const QCLDevice &device) const
{
return toLocalWorkSize(device.maximumWorkItemSize(),
device.maximumWorkItemsPerGroup());
}
/*!
Returns the string form of this work size, with components
separated by 'x'.
\sa fromString()
*/
QString QCLWorkSize::toString() const
{
if (m_dim == 1) {
return QString::number(qulonglong(m_sizes[0]));
} else if (m_dim == 2) {
return QString::number(qulonglong(m_sizes[0])) + QLatin1Char('x') +
QString::number(qulonglong(m_sizes[1]));
} else {
return QString::number(qulonglong(m_sizes[0])) + QLatin1Char('x') +
QString::number(qulonglong(m_sizes[1])) + QLatin1Char('x') +
QString::number(qulonglong(m_sizes[2]));
}
}
/*!
Returns the work size that corresponds to the contents of \a str.
Components are assumed to be separated by 'x'.
\sa toString()
*/
QCLWorkSize QCLWorkSize::fromString(const QString &str)
{
QStringList split = str.split(QLatin1Char('x'));
if (split.size() >= 3) {
return QCLWorkSize(size_t(split[0].toULongLong()),
size_t(split[1].toULongLong()),
size_t(split[2].toULongLong()));
} else if (split.size() == 2) {
return QCLWorkSize(size_t(split[0].toULongLong()),
size_t(split[1].toULongLong()));
} else if (split.size() == 1) {
// An empty string will turn into a single-element list,
// which we want to result in (1, 1, 1), not (0, 1, 1)
// so it matches the default QCLWorkSize().
bool ok;
qulonglong value = split[0].toULongLong(&ok);
if (ok)
return QCLWorkSize(value);
else
return QCLWorkSize();
} else {
return QCLWorkSize();
}
}
QT_END_NAMESPACE
|
