| <?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>clGetKernelSubGroupInfo</keyword> | |
| </keywordset> | |
| </refentryinfo> | |
| <refmeta> | |
| <refentrytitle> | |
| clGetKernelSubGroupInfo | |
| </refentrytitle> | |
| <refmiscinfo> | |
| <copyright> | |
| <year>2007-2013</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="clGetKernelSubGroupInfo"> | |
| <refname> | |
| clGetKernelSubGroupInfo | |
| </refname> | |
| <refpurpose> | |
| Returns information about the kernel 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>clGetKernelSubGroupInfo</function> | |
| </funcdef> | |
| <paramdef> | |
| <link xlink:href="abstractDataTypes.html">cl_kernel</link> | |
| <parameter>kernel</parameter> | |
| </paramdef> | |
| <paramdef> | |
| <link xlink:href="abstractDataTypes.html">cl_device_id</link> | |
| <parameter>device</parameter> | |
| </paramdef> | |
| <paramdef> | |
| <link xlink:href="enums.html#cl_kernel_sub_group_info">cl_kernel_sub_group_info</link> | |
| <parameter>param_name</parameter> | |
| </paramdef> | |
| <paramdef> | |
| <link xlink:href="scalarDataTypes.html">size_t</link> | |
| <parameter>input_value_size</parameter> | |
| </paramdef> | |
| <paramdef> | |
| const <link xlink:href="scalarDataTypes.html">void</link> | |
| <parameter>*input_value</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> | |
| <!-- ================================ PARAMETERS --> | |
| <refsect1 id="parameters"> | |
| <title>Parameters</title> | |
| <variablelist> | |
| <varlistentry> | |
| <term> <varname> kernel </varname> </term> | |
| <listitem> | |
| <para> | |
| Specifies the kernel object being queried. | |
| </para> | |
| </listitem> | |
| </varlistentry> | |
| <varlistentry> | |
| <term> <varname> device </varname> </term> | |
| <listitem> | |
| <para> | |
| Identifies a specific device in the list of devices associated with | |
| <varname>kernel</varname>. The list of devices is the list of devices in | |
| the OpenCL context that is associated with <varname>kernel</varname>. If | |
| the list of devices associated with <varname>kernel</varname> is a single | |
| device, <varname>device</varname> can be a NULL value. | |
| </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>clGetKernelSubGroupInfo</function> is described in the table | |
| below. | |
| </para> | |
| </listitem> | |
| </varlistentry> | |
| <varlistentry> | |
| <term> <varname>input_value_size</varname> </term> | |
| <listitem> | |
| <para> | |
| Specifies the size in bytes of memory pointed to by | |
| <varname>input_value</varname>. This | |
| size must be == size of input type as described in table below. | |
| </para> | |
| </listitem> | |
| </varlistentry> | |
| <varlistentry> | |
| <term> <varname>input_value</varname> </term> | |
| <listitem> | |
| <para> | |
| A pointer to memory where the appropriate parameterization of the query is passed from. | |
| If <varname>input_value</varname> is NULL, it is ignored. | |
| </para> | |
| </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 below. | |
| </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> | |
| <informaltable frame="all"> | |
| <tgroup cols="4" align="left" colsep="1" rowsep="1"> | |
| <colspec colname="col1" colnum="1" /> | |
| <colspec colname="col2" colnum="2" /> | |
| <colspec colname="col3" colnum="3" /> | |
| <colspec colname="col4" colnum="3" /> | |
| <thead> | |
| <row> | |
| <entry>cl_kernel_sub_group_info</entry> | |
| <entry>Input Type</entry> | |
| <entry>Return Type</entry> | |
| <entry>Info. returned in <varname>param_value</varname></entry> | |
| </row> | |
| </thead> | |
| <tbody> | |
| <row> | |
| <entry><constant>CL_KERNEL_MAX_SUB_- | |
| GROUP_SIZE_FOR_NDRANGE</constant></entry> | |
| <entry>size_t *</entry> | |
| <entry>size_t</entry> | |
| <entry> | |
| <para> | |
| Returns the maximum sub-group size | |
| for this kernel. All subgroups must be | |
| the same size, while the last sub-group | |
| in any work-group (i.e. the sub-group | |
| with the maximum index) could be the | |
| same or smaller size. | |
| </para> | |
| <para> | |
| The <varname>input_value</varname> must be an array of | |
| <type>size_t</type> values corresponding to the | |
| local work size parameter of the | |
| intended dispatch. The number of | |
| dimensions in the ND-range will be | |
| inferred from the value specified for | |
| <varname>input_value_size</varname>. | |
| </para> | |
| </entry> | |
| </row> | |
| <row> | |
| <entry><constant>CL_KERNEL_SUB_GROUP_- | |
| COUNT_FOR_NDRANGE</constant></entry> | |
| <entry>size_t *</entry> | |
| <entry>size_t</entry> | |
| <entry> | |
| <para> | |
| Returns the number of sub-groups that | |
| will be present in each work-group for | |
| a given local work size. All workgroups, | |
| apart from the last work-group | |
| in each dimension in the presence of | |
| non-uniform work-group sizes, will | |
| have the same number of subgroups. | |
| </para> | |
| <para> | |
| The <varname>input_value</varname> must be an array of | |
| <type>size_t</type> values corresponding to the | |
| local work size parameter of the | |
| intended dispatch. The number of | |
| dimensions in the ND-range will be | |
| inferred from the value specified for | |
| <varname>input_value_size</varname>. | |
| </para> | |
| </entry> | |
| </row> | |
| <row> | |
| <entry><constant>CL_KERNEL_LOCAL_SIZE_ | |
| FOR_SUB_GROUP_COUNT</constant></entry> | |
| <entry>size_t</entry> | |
| <entry>size_t []</entry> | |
| <entry> | |
| <para> | |
| Returns the local size that will | |
| generate the requested number of sub- | |
| groups for the kernel. The output array | |
| must be an array of <code>size_t</code> values | |
| corresponding to the local size | |
| parameter. Any returned work-group | |
| will have one dimension. Other | |
| dimensions inferred from the value | |
| specified for <varname>param_value_size</varname> | |
| will be filled with the value 1. The | |
| returned value will produce an exact | |
| number of sub-groups and result in no | |
| partial groups for an executing kernel | |
| except in the case where the last work- | |
| group in a dimension has a size | |
| different from that of the other groups. | |
| If no work-group size can | |
| accommodate the requested number of | |
| sub-groups, 0 will be returned in each | |
| element of the return array. | |
| </para> | |
| </entry> | |
| </row> | |
| <row> | |
| <entry><constant>CL_KERNEL_MAX_NUM_SUB_GROUPS</constant></entry> | |
| <entry>ignored</entry> | |
| <entry>size_t</entry> | |
| <entry> | |
| This provides a mechanism for the | |
| application to query the maximum number | |
| of sub-groups that may make up each | |
| work-group to execute a kernel on a | |
| specific device given by device. The | |
| OpenCL implementation uses the resource | |
| requirements of the kernel (register usage | |
| etc.) to determine what this work-group | |
| size should be. The returned value may be | |
| used to compute a work-group size to | |
| enqueue the kernel with to give a round | |
| number of sub-groups for an enqueue. | |
| </entry> | |
| </row> | |
| <row> | |
| <entry><constant>CL_KERNEL_COMPILE_NUM_SUB_GROUPS</constant></entry> | |
| <entry>ignored</entry> | |
| <entry>size_t</entry> | |
| <entry> | |
| Returns the number of sub-groups | |
| specified in the kernel source or IL. If the | |
| sub-group count is not specified using the | |
| above attribute then 0 is returned. | |
| </entry> | |
| </row> | |
| </tbody> | |
| </tgroup> | |
| </informaltable> | |
| </listitem> | |
| </varlistentry> | |
| </variablelist> | |
| </refsect1> | |
| <!-- ================================ NOTES --> | |
| <!--<refsect1 id="notes"><title>Notes</title> | |
| <para> | |
| </para> | |
| </refsect1>--> | |
| <!-- ================================ ERRORS --> | |
| <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_DEVICE</errorname> if <varname>device</varname> is | |
| not in the list of devices associated with <varname>kernel</varname> or if | |
| <varname>device</varname> is NULL but there is more than one device associated | |
| with <varname>kernel</varname>. | |
| </listitem> | |
| <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_VALUE</errorname> if | |
| <varname>param_name</varname> is | |
| <constant>CL_KERNEL_SUB_GROUP_SIZE_FOR_NDRANGE</constant> | |
| and the size in bytes specified by | |
| <varname>input_value_size</varname> is not valid | |
| or if <varname>input_value</varname> is NULL. | |
| </listitem> | |
| <listitem> | |
| <errorname>CL_INVALID_KERNEL</errorname> if <varname>kernel</varname> is a not | |
| a valid kernel object. | |
| </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="clGetKernelSubGroupInfo">OpenCL Specification</olink> | |
| </para> | |
| </refsect1> | |
| <!-- ================================ ALSO SEE --> | |
| <refsect1 id="seealso"><title>Also see</title> | |
| <para> | |
| </para> | |
| </refsect1> | |
| <!-- ================================ COPYRIGHT --> | |
| <!-- Content included from copyright.inc.xsl --> | |
| <refsect3 id="Copyright"><title></title> | |
| <imageobject> | |
| <imagedata fileref="KhronosLogo.jpg" format="jpg" /> | |
| </imageobject> | |
| <para /> | |
| </refsect3> | |
| <!-- 12-Nov-2015, API 2.1 rev 23 --> | |
| </refentry> | |