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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
<refentry>
<refentryinfo>
<keywordset>
<keyword>clEnqueueTask</keyword>
</keywordset>
</refentryinfo>
<refmeta>
<refentrytitle>clEnqueueTask</refentrytitle>
<refmiscinfo>
<copyright>
<year>2007-2011</year>
<holder>The Khronos Group Inc.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and/or associated documentation files (the
"Materials"), to deal in the Materials without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Materials, and to
permit persons to whom the Materials are furnished to do so, subject to
the condition that this copyright notice and permission notice shall be included
in all copies or substantial portions of the Materials.</holder>
</copyright>
</refmiscinfo>
<manvolnum>3</manvolnum>
</refmeta>
<!-- ================================ SYNOPSIS -->
<refnamediv id="clEnqueueTask">
<refname>clEnqueueTask</refname>
<refpurpose>
Enqueues a command to execute a kernel on a device.
</refpurpose>
</refnamediv>
<refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title>
<funcsynopsis>
<funcprototype>
<funcdef>
<link xlink:href="scalarDataTypes.html">cl_int</link>
<function>
clEnqueueTask
</function>
</funcdef>
<paramdef>
<link xlink:href="abstractDataTypes.html">cl_command_queue</link>
<parameter>command_queue</parameter>
</paramdef>
<paramdef>
<link xlink:href="abstractDataTypes.html">cl_kernel</link>
<parameter>kernel</parameter>
</paramdef>
<paramdef>
<link xlink:href="scalarDataTypes.html">cl_uint</link>
<parameter>num_events_in_wait_list</parameter>
</paramdef>
<paramdef>const
<link xlink:href="abstractDataTypes.html">cl_event</link>
<parameter>*event_wait_list</parameter>
</paramdef>
<paramdef>
<link xlink:href="abstractDataTypes.html">cl_event</link>
<parameter>*event</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<!-- ================================ PARAMETERS -->
<refsect1 id="parameters">
<title>Parameters</title>
<variablelist>
<varlistentry>
<term> <varname> command_queue </varname> </term>
<listitem>
<para>
<!-- parameter description --> A valid command-queue. The kernel
will be queued for execution on the device associated with
<varname>command_queue</varname>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term> <varname> kernel </varname> </term>
<listitem>
<para>
<!-- parameter description --> A valid kernel object. The
OpenCL context associated with <varname>kernel</varname> and
<varname>command_queue</varname> must be the same.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term> <varname> <!-- parameter name -->
num_events_in_wait_list
</varname>,
<varname>
event_wait_list
</varname>
</term>
<listitem>
<para>
<!-- parameter description --> Sspecify events that need to
complete before this particular command can be executed. If
<varname>event_wait_list</varname> is NULL, then this particular command does
not wait on any event to complete. If <varname>event_wait_list</varname>
is NULL, <varname>num_events_in_wait_list</varname> must be 0.
If <varname>event_wait_list</varname> is not NULL, the list of
events pointed to by <varname>event_wait_list</varname> must be
valid and <varname>num_events_in_wait_list</varname> must be greater
than 0. The events specified in <varname>event_wait_list</varname>
act as synchronization points. The context associated with events in
<varname>event_wait_list</varname> and <varname>command_queue</varname> must
be the same. The memory associated with <varname>event_wait_list</varname>
can be reused or freed after the function returns.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term> <varname> event </varname> </term>
<listitem>
<para>
<!-- parameter description --> Returns an event object that identifies
this particular kernel execution instance. Event objects are unique and
can be used to identify a particular kernel execution instance later on. If
<varname>event</varname> is NULL, no event will be created for this kernel
execution instance and therefore it will not be possible for the application
to query or queue a wait for this particular kernel execution instance.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<!-- ================================ NOTES -->
<refsect1 id="notes"><title>Notes</title>
<para>
The kernel is executed using a single work-item.
</para>
<para>
<function>clEnqueueTask</function> is equivalent to calling
<citerefentry><refentrytitle>clEnqueueNDRangeKernel</refentrytitle></citerefentry>
with <varname>work_dim</varname> = 1, <varname>global_work_offset</varname>
= NULL, <varname>global_work_size</varname>[0] set to 1, and
<varname>local_work_size</varname>[0] set to 1.
</para>
</refsect1>
<!-- ================================ ERRORS -->
<refsect1 id="errors"><title>Errors</title>
<para>
Returns <errorname>CL_SUCCESS</errorname> if the kernel execution was successfully
queued, or one of the errors below:
</para>
<itemizedlist mark="disc">
<listitem>
<errorname>CL_INVALID_PROGRAM_EXECUTABLE</errorname> if there is no
successfully built program executable available for device associated with
<varname>command_queue</varname>.
</listitem>
<listitem>
<errorname>CL_INVALID_COMMAND_QUEUE</errorname> if <varname>command_queue</varname>
is not a valid command-queue.
</listitem>
<listitem>
<errorname>CL_INVALID_KERNEL</errorname> if <varname>kernel</varname> is not a
valid kernel object.
</listitem>
<listitem>
<errorname>CL_INVALID_CONTEXT</errorname> if context associated with
<varname>command_queue</varname> and <varname>kernel</varname> is not the same
or if the context associated with <varname>command_queue</varname> and events in
<varname>event_wait_list</varname> are not the same.
</listitem>
<listitem>
<errorname>CL_INVALID_KERNEL_ARGS</errorname> if the kernel argument values have
not been specified.
</listitem>
<listitem>
<errorname>CL_INVALID_WORK_GROUP_SIZE</errorname> if a work-group size is
specified for <varname>kernel</varname> using the <constant><citerefentry
href="functionQualifiers"><refentrytitle>__attribute__</refentrytitle></citerefentry>
((reqd_work_group_size(X, Y, Z)))</constant> qualifier in program source and is
not (<constant>1</constant>, <constant>1</constant>, <constant>1</constant>).
</listitem>
<listitem>
<errorname>CL_MISALIGNED_SUB_BUFFER_OFFSET</errorname> if a sub-buffer object
is specified as the value for an argument that is a buffer object and the
<varname>offset</varname> specified when the sub-buffer object is created is not
aligned to <constant>CL_DEVICE_MEM_BASE_ADDR_ALIGN</constant> value for device
associated with <varname>queue</varname>.
</listitem>
<listitem>
<errorname>CL_INVALID_IMAGE_SIZE</errorname> if an image object is specified
as an argument value and the image dimensions (image width, height, specified
or compute row and/or slice pitch) are not supported by device associated with
<varname>queue</varname>.
</listitem>
<listitem>
<errorname>CL_INVALID_IMAGE_FORMAT</errorname> if an image object is specified
as an argument value and the image format (image channel order and data type)
is not supported by device associated with <varname>queue</varname>.
</listitem>
<listitem>
<errorname>CL_OUT_OF_RESOURCES</errorname> if there is a failure to queue the
execution instance of <varname>kernel</varname> on the command-queue because of
insufficient resources needed to execute the kernel.
</listitem>
<listitem>
<errorname>CL_MEM_OBJECT_ALLOCATION_FAILURE</errorname> if there is a failure to
allocate memory for data store associated with image or buffer objects specified
as arguments to <varname>kernel</varname>.
</listitem>
<listitem>
<errorname>CL_INVALID_EVENT_WAIT_LIST</errorname>
if <varname>event_wait_list</varname> is NULL and
<varname>num_events_in_wait_list</varname> > 0,
or <varname>event_wait_list</varname> is not NULL and
<varname>num_events_in_wait_list</varname> is 0, or if event objects in
<varname>event_wait_list</varname> are not valid events.
</listitem>
<listitem>
<errorname>CL_OUT_OF_RESOURCES</errorname> if there is a failure to allocate
resources required by the OpenCL implementation on the device.
</listitem>
<listitem>
<errorname>CL_OUT_OF_HOST_MEMORY</errorname> if there is a failure to allocate
resources required by the OpenCL implementation on the host.
</listitem>
</itemizedlist>
</refsect1>
<!-- ================================ EXAMPLE -->
<!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE -->
<!--
<refsect2 id="example1">
<title>
Example
</title>
<informaltable frame="none">
<tgroup cols="1" align="left" colsep="0" rowsep="0">
<colspec colname="col1" colnum="1" />
<tbody>
<row>
<entry>
Example goes here - it will be set in "code" type with white space preserved.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect2>
-->
<!-- ================================ SPECIFICATION -->
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
-->
<refsect1 id="specification"><title>Specification</title>
<para>
<imageobject>
<imagedata fileref="pdficon_small1.gif" format="gif" />
</imageobject>
<olink uri="clEnqueueTask">OpenCL Specification</olink>
</para>
</refsect1>
<!-- ================================ ALSO SEE -->
<refsect1 id="seealso"><title>Also see</title>
<para>
<citerefentry><refentrytitle>clEnqueueNDRangeKernel</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>clEnqueueNativeKernel</refentrytitle></citerefentry>
</para>
</refsect1>
<!-- ============================== COPYRIGHT -->
<!-- Content included from copyright.inc.xsl -->
<refsect3 id="Copyright"><title></title>
<imageobject>
<imagedata fileref="KhronosLogo.jpg" format="jpg" />
</imageobject>
<para />
</refsect3>
<!-- 20-Oct-2011 -->
</refentry>
|
