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
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
|
<?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>
clGetProgramInfo
</keyword>
</keywordset>
</refentryinfo>
<refmeta>
<refentrytitle>
clGetProgramInfo
</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>
<refnamediv id="clGetProgramInfo">
<refname>
clGetProgramInfo
</refname>
<refpurpose>
Returns information about the program object.
</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>clGetProgramInfo</function>
</funcdef>
<paramdef><link xlink:href="abstractDataTypes.html">cl_program</link><parameter>program</parameter></paramdef>
<paramdef><link xlink:href="#cl_program_info">cl_program_info</link><parameter>param_name</parameter></paramdef>
<paramdef><link xlink:href="scalarDataTypes.html">size_t</link><parameter>param_value_size</parameter></paramdef>
<paramdef><link xlink:href="scalarDataTypes.html">void</link><parameter>*param_value</parameter></paramdef>
<paramdef><link xlink:href="scalarDataTypes.html">size_t</link><parameter>*param_value_size_ret</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="parameters">
<title>Parameters</title>
<variablelist>
<varlistentry>
<term> <varname> program </varname> </term>
<listitem>
<para>
Specifies the program object being queried.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term> <varname> param_name </varname> </term>
<listitem>
<para>
Specifies the information to query. The list of supported
<varname>param_name</varname> types and the information returned in
<varname>param_value</varname> by <function>clGetProgramInfo</function>
is described in the table below.
</para>
<informaltable frame="all"><anchor id="cl_program_info"/>
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colname="col1" colnum="1" />
<colspec colname="col2" colnum="2" />
<thead>
<row>
<entry>cl_program_info</entry>
<entry>Return Type and Info. returned in <varname>param_value</varname></entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>CL_PROGRAM_REFERENCE_COUNT</constant></entry>
<entry>
Return type: cl_uint
<para>Return the <varname>program</varname> reference count.</para>
<para>The reference count returned should be considered immediately stale. It is
unsuitable for general use in applications. This feature is provided
for identifying memory leaks.</para>
</entry>
</row>
<row>
<entry><constant>CL_PROGRAM_CONTEXT</constant></entry>
<entry>
Return type: cl_context
<para>
Return the context specified when the program object is created
</para>
</entry>
</row>
<row>
<entry><constant>CL_PROGRAM_NUM_DEVICES</constant></entry>
<entry>
Return type: cl_uint
<para>
Return the number of devices associated with <varname>program</varname>.
</para>
</entry>
</row>
<row>
<entry><constant>CL_PROGRAM_DEVICES</constant></entry>
<entry>
Return type: cl_device_id[]
<para>
Return the list of devices associated with the program object. This can be
the devices associated with context on which the program object has been
created or can be a subset of devices that are specified when a progam object
is created using
<citerefentry><refentrytitle>clCreateProgramWithBinary</refentrytitle></citerefentry>.
</para>
</entry>
</row>
<row>
<entry><constant>CL_PROGRAM_SOURCE</constant></entry>
<entry>
Return type: char[]
<para>
Return the program source code specified by
<citerefentry><refentrytitle>clCreateProgramWithSource</refentrytitle></citerefentry>.
The source string returned is a
concatenation of all source strings specified to
<citerefentry><refentrytitle>clCreateProgramWithSource</refentrytitle></citerefentry>
with a null terminator. The concatenation strips any
nulls in the original source strings.
</para>
<para>
If <varname>program</varname> is created using
<citerefentry><refentrytitle>clCreateProgramWithBinary</refentrytitle></citerefentry>
or
<citerefentry><refentrytitle>clCreateProgramWithBuiltInKernels</refentrytitle></citerefentry>,
a null string or the appropriate program source code is
returned depending on whether or not the program source
code is stored in the binary.
</para>
<para>
The actual number of characters that represents the
program source code including the null terminator is
returned in <varname>param_value_size_ret</varname>.
</para>
</entry>
</row>
<row>
<entry><constant>CL_PROGRAM_BINARY_SIZES</constant></entry>
<entry>
Return type: size_t[]
<para>
Returns an array that contains the size in bytes of
the program binary (could be an executable binary,
compiled binary or library binary) for each device
associated with <varname>program</varname>. The size
of the array is the number of devices associated with
<varname>program</varname>. If a binary is not available
for a device(s), a size of zero is returned.
</para>
<para>
If <varname>program</varname> is created using
<citerefentry><refentrytitle>clCreateProgramWithBuiltInKernels</refentrytitle></citerefentry>,
the implementation may return zero in any entries of the
returned array.
</para>
</entry>
</row>
<row>
<entry><constant>CL_PROGRAM_BINARIES</constant></entry>
<entry>
Return type: unsigned char *[]
<para>
Return the program binaries (could be an executable
binary, compiled binary or library binary) for all
devices associated with <varname>program</varname>. For
each device in <varname>program</varname>, the
binary returned can be the binary specified for
the device when <varname>program</varname> is created with
<citerefentry><refentrytitle>clCreateProgramWithBinary</refentrytitle></citerefentry>
or it can be the executable binary generated by
<citerefentry><refentrytitle>clBuildProgram</refentrytitle></citerefentry>
or
<citerefentry><refentrytitle>clLinkProgram</refentrytitle></citerefentry>.
If program is created with
<citerefentry><refentrytitle>clCreateProgramWithSource</refentrytitle></citerefentry>,
the binary returned is the binary generated by
<citerefentry><refentrytitle>clBuildProgram</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>clCompileProgram</refentrytitle></citerefentry>,
or
<citerefentry><refentrytitle>clLinkProgram</refentrytitle></citerefentry>.
The bits returned can be an implementation-specific
intermediate representation (a.k.a. IR) or device specific
executable bits or both. The decision on which information
is returned in the binary is up to the OpenCL implementation.
</para>
<para>
<varname>param_value</varname> points to an array of
<code>n</code> pointers allocated by the caller, where
<code>n</code> is the number of devices associated with
program. The buffer sizes needed to allocate the memory
that these <code>n</code> pointers refer to can be queried
using the <constant>CL_PROGRAM_BINARY_SIZES</constant>
query as described in this table.
</para>
<para>
Each entry in this array is used by the implementation as
the location in memory where to copy the program binary for
a specific device, if there is a binary available. To find
out which device the program binary in the array refers to,
use the <constant>CL_PROGRAM_DEVICES</constant> query to get
the list of devices. There is a one-to-one correspondence
between the array of <code>n</code> pointers returned
by <constant>CL_PROGRAM_BINARIES</constant> and array of
devices returned by <constant>CL_PROGRAM_DEVICES.</constant>
</para>
<para>
If an entry value in the array is NULL, the implementation
skips copying the program binary for the specific device
identified by the array index.
</para>
</entry>
</row>
<row>
<entry><constant>CL_PROGRAM_NUM_KERNELS</constant></entry>
<entry>
Return type: size_t
<para>
Returns the number of kernels declared in
<varname>program</varname> that can be created with
<citerefentry><refentrytitle>clCreateKernel</refentrytitle></citerefentry>.
This information is only available after a successful program
executable has been built for at least one device in the
list of devices associated with <varname>program</varname>.
</para>
</entry>
</row>
<row>
<entry><constant>CL_PROGRAM_KERNEL_NAMES</constant></entry>
<entry>
Return type: char[]
<para>
Returns a semi-colon separated list of kernel names
in <varname>program</varname> that can be created with
<citerefentry><refentrytitle>clCreateKernel</refentrytitle></citerefentry>.
This information is only available after a successful program
executable has been built for at least one device in the
list of devices associated with <varname>program</varname>.
</para>
</entry>
</row>
</tbody>
</tgroup> </informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term> <varname> param_value </varname> </term>
<listitem>
<para>
A pointer to memory where the appropriate result being queried is returned.
If <varname>param_value</varname> is NULL, it is ignored.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term> <varname> param_value_size </varname> </term>
<listitem>
<para>
Used to specify the size in bytes of memory pointed to by
<varname>param_value</varname>. This size must be ≥ size of return
type as described in the table above.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term> <varname> param_value_size_ret </varname> </term>
<listitem>
<para>
Returns the actual size in bytes of data copied to <varname>param_value</varname>.
If <varname>param_value_size_ret</varname> is NULL, it is ignored.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="errors"><title>Errors</title>
<para>
Returns <errorname>CL_SUCCESS</errorname> if the function is executed successfully.
Otherwise, it returns one of the following errors:
</para>
<itemizedlist mark="disc">
<listitem>
<errorname>CL_INVALID_VALUE</errorname> if <varname>param_name</varname> is not
valid, or if size in bytes specified by <varname>param_value_size</varname>
is < size of return type as described in the table above and
<varname>param_value</varname> is not NULL.
</listitem>
<listitem>
<errorname>CL_INVALID_PROGRAM</errorname> if <varname>program</varname> is not
a valid program object.
</listitem>
<listitem>
<errorname>CL_INVALID_PROGRAM_EXECUTABLE</errorname> if
<varname>param_name</varname> is <constant>CL_PROGRAM_NUM_KERNELS</constant> or
<constant>CL_PROGRAM_KERNEL_NAMES</constant> and a successful program executable
has not been built for at least one device in the list of devices associated
with <varname>program</varname>.
</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>
<refsect1 id="specification"><title>Specification</title>
<para>
<imageobject>
<imagedata fileref="pdficon_small1.gif" format="gif" />
</imageobject>
<olink uri="clGetProgramInfo">OpenCL Specification</olink>
</para>
</refsect1>
<refsect1 id="seealso"><title>Also see</title>
<para>
<citerefentry><refentrytitle>clGetProgramBuildInfo</refentrytitle></citerefentry>
</para>
</refsect1>
<refsect3 id="Copyright"><title></title>
<imageobject>
<imagedata fileref="KhronosLogo.jpg" format="jpg" />
</imageobject>
<para />
</refsect3>
</refentry>
|
