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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
|
<?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>clEnqueueNativeKernel</keyword>
</keywordset>
</refentryinfo>
<refmeta>
<refentrytitle>clEnqueueNativeKernel</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="clEnqueueNativeKernel">
<refname>clEnqueueNativeKernel</refname>
<refpurpose>
Enqueues a command to execute a native C/C++ function not compiled using the OpenCL compiler.
</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>
clEnqueueNativeKernel
</function>
</funcdef>
<paramdef><link xlink:href="abstractDataTypes.html">cl_command_queue</link><parameter>command_queue</parameter></paramdef>
<paramdef><link xlink:href="scalarDataTypes.html">void</link><parameter>(*user_func)(void *)</parameter></paramdef>
<paramdef><link xlink:href="scalarDataTypes.html">void</link><parameter>*args</parameter></paramdef>
<paramdef><link xlink:href="scalarDataTypes.html">size_t</link><parameter>cb_args</parameter></paramdef>
<paramdef><link xlink:href="scalarDataTypes.html">cl_uint</link><parameter>num_mem_objects</parameter></paramdef>
<paramdef>const <link xlink:href="abstractDataTypes.html">cl_mem</link><parameter>*mem_list</parameter></paramdef>
<paramdef>const <link xlink:href="scalarDataTypes.html">void</link><parameter>**args_mem_loc</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. A native user
function can only be executed on a command-queue created on a device
that has <constant>CL_EXEC_NATIVE_KERNEL</constant> capability
set in <constant>CL_DEVICE_EXECUTION_CAPABILITIES</constant>
as specified in the table of OpenCL Device Queries for
<citerefentry><refentrytitle>clGetDeviceInfo</refentrytitle></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term> <varname> user_func </varname> </term>
<listitem>
<para> <!-- parameter description -->
A pointer to a host-callable user function.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term> <varname> args </varname> </term>
<listitem>
<para> <!-- parameter description -->
A pointer to the args list that <varname>user_func</varname> should be called with.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term> <varname> cb_args </varname> </term>
<listitem>
<para> <!-- parameter description -->
The size in bytes of the args list that <varname>args</varname> points to.
</para>
<para>
The data pointed to by <varname>args</varname> and <varname>cb_args</varname>
bytes in size will be copied and a pointer to this copied region will be
passed to <varname>user_func</varname>. The copy needs to be done because
the memory objects (<type>cl_mem</type> values) that <varname>args</varname>
may contain need to be modified and replaced by appropriate pointers to
global memory. When <function>clEnqueueNativeKernel</function> returns,
the memory region pointed to by <varname>args</varname> can be reused by
the application.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term> <varname> num_mem_objects </varname> </term>
<listitem>
<para> <!-- parameter description -->
The number of buffer objects that are passed in <varname>args</varname>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term> <varname> mem_list </varname> </term>
<listitem>
<para>
<!-- parameter description --> A list of valid buffer objects,
if <varname>num_mem_objects</varname> > 0. The buffer
object values specified in <varname>mem_list</varname> are
memory object handles (<type>cl_mem</type> values) returned by
<citerefentry><refentrytitle>clCreateBuffer</refentrytitle></citerefentry>
or NULL.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term> <varname> args_mem_loc </varname> </term>
<listitem>
<para>
<!-- parameter description --> A pointer to appropriate locations
that <varname>args</varname> points to where memory object handles
(<type>cl_mem</type> values) are stored. Before the user function is
executed, the memory object handles are replaced by pointers to global
memory.
</para>
</listitem>
</varlistentry>
<!-- ================================ PARAMETER (NO TABLE) -->
<!-- Use this if the parameter information does not require a table. -->
<varlistentry>
<term>
<varname> <!-- parameter name -->
event_wait_list
</varname> and
<varname> <!-- parameter name -->
num_events_in_wait_list
</varname>
</term>
<listitem>
<para>
<!-- parameter description --> Specify 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>
</variablelist>
</refsect1>
<!-- ================================ NOTES -->
<refsect1 id="notes"><title>Notes</title>
<para>
The total number of read-only images specified as arguments to a kernel cannot exceed
<constant>CL_DEVICE_MAX_READ_IMAGE_ARGS</constant>. Each 2D image array argument to
a kernel declared with the <code>read_only</code> qualifier counts as one image.
</para>
<para>
The total number of write-only images specified as arguments to a kernel cannot exceed
<constant>CL_DEVICE_MAX_WRITE_IMAGE_ARGS</constant>. Each 2D image array argument to
a kernel declared with the <code>write-only</code> qualifier counts as one image.
</para>
</refsect1>
<!-- ================================ ERRORS -->
<refsect1 id="errors"><title>Errors</title>
<para>
Returns <errorname>CL_SUCCESS</errorname> if the user function execution instance
was successfully queued, or one of the errors below:
</para>
<itemizedlist mark="disc">
<listitem>
<errorname>CL_INVALID_COMMAND_QUEUE</errorname> if <varname>command_queue</varname>
is not a valid command-queue.
</listitem>
<listitem>
<errorname>CL_INVALID_CONTEXT</errorname> if context associated with
<varname>command_queue</varname> and events in <varname>event-wait_list</varname>
are not the same.
</listitem>
<listitem>
<errorname>CL_INVALID_VALUE</errorname> if <varname>user_func</varname> is NULL.
</listitem>
<listitem>
<errorname>CL_INVALID_VALUE</errorname> if <varname>args</varname> is a NULL
value and <varname>cb_args</varname> > 0, or if <varname>args</varname> is a
NULL value and <varname>num_mem_objects</varname> > 0.
</listitem>
<listitem>
<errorname>CL_INVALID_VALUE</errorname> if <varname>args</varname> is not NULL
and <varname>cb_args</varname> is 0.
</listitem>
<listitem>
<errorname>CL_INVALID_VALUE</errorname> if <varname>num_mem_objects</varname>
> 0 and <varname>mem_list</varname> or <varname>args_mem_loc</varname> are NULL.
</listitem>
<listitem>
<errorname>CL_INVALID_VALUE</errorname> if <varname>num_mem_objects</varname> =
0 and <varname>mem_list</varname> or <varname>args_mem_loc</varname> are not NULL.
</listitem>
<listitem>
<errorname>CL_INVALID_OPERATION</errorname> if the device associated with
<varname>command_queue</varname> cannot execute the native kernel.
</listitem>
<listitem>
<errorname>CL_INVALID_MEM_OBJECT</errorname> if one or more memory objects
specified in <varname>mem_list</varname> are not valid or are not buffer objects.
</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 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="clEnqueueNativeKernel">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>,
<citerefentry><refentrytitle>clCreateCommandQueue</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>clCreateBuffer</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>
|
