sdk/2.1/docs/man/xhtml/clSetKernelExecInfo.html - external/github.com/KhronosGroup/OpenCL-Registry - Git at Google

 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
 <!-- saved from url=(0013)about:internet -->
 <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
     <style xmlns="" type="text/css">
     /* This style sets a margin around the entire page */
         html, body {
             margin: 10px;
         }

         p {
             font: normal 16px verdana, sans-serif;
             margin: 0;
             padding-bottom:12px;
         }

         h1 {
             font: bold 25px verdana, sans-serif;
             margin-top: 0;
             margin-bottom: 3px;
             padding-top: 0;
             padding-bottom: 0;
         }

         h2 {
             font: bold 19px verdana, sans-serif;
             margin-top: 28px;
             margin-bottom: 3px;
             padding-top: 0;
             padding-bottom: 0;
         }

         h3 {
             font: bold 19px verdana, sans-serif !important;
             margin-top: 28px;
             margin-bottom: 3px;
             padding-top: 0;
             padding-bottom: 0;
         }

         li {
             font: normal 16px verdana, sans-serif;
             margin-top: 0;
             margin-bottom: 18px;
             padding-top: 0;
             padding-bottom: 0;
         }

         .pdparam {
             font: italic 16px verdana, sans-serif;
         }

                 .term {
                         font: italic 16px verdana, sans-serif;
                         font-weight: normal;
                 }

                 .type {
                         font: normal 16px verdana, sans-serif !important;
                 }

                 .parameter {
                         font-style: italic;
                         }

         a:link, a:visited {
             color: blue;
             text-decoration: none;
             font: normal 16px;
         }

         a:hover {
             background-color: #FFFF99;
             font: normal 16px;
         }

         div.funcsynopsis {
             text-align: left;
             background-color: #e6e6e6;
             font: normal 16px verdana, sans-serif;
                         padding-top: 10px;
                         padding-bottom: 10px;
         }

         div.funcsynopsis table {
             border-collapse: separate;
             font: normal 16px verdana, sans-serif;
         }

         div.funcsynopsis td {
             background-color: #e6e6e6;
             border: 0 solid #000;
             padding: 1px;
             font: normal 16px verdana, sans-serif;
         }

         div.refsect1 {
             font-family: verdana, sans-serif;
             font-size: 16px;
         }

         code.constant {
             font: normal 16px courier new, monospace !important;
         }

                 span.errorname {
             font: normal 16px verdana, sans-serif !important;
         }

         code.function {
             font: bold 16px verdana, sans-serif !important;
         }

         b.fsfunc {
             font: bold 16px verdana, sans-serif !important;
         }

         code.varname {
             font: italic 16px verdana, sans-serif;
         }

         code.replaceable {
             font: italic 16px courier new, monospace;
         }

         code.funcdef {
             font: normal 16px verdana, sans-serif !important;
         }

         .citerefentry {
             font: normal 16px verdana, sans-serif !important;
         }

         .parameter {
             font-style: italic;
         }

         code.fsfunc {
             font: normal 16px verdana, sans-serif !important;
         }

         /* PARAMETER: This style controls spacing between the terms in Parameter section */
         dt {
             margin-top: 15px;
         }

         /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */
         div.refsect1 table {
             width: 100%;
                         margin-top: 10px;
             background-color: #FFF;
                         border-collapse: collapse;
                         border-color: #000;
             border-width: 1px;
                         font: normal 16px verdana, sans-serif;
         }

         div.refsect1 th {
                         border-collapse: collapse;
                         border-color: #000;
             border-width: 1px;
             font: bold 16px verdana, sans-serif;
         }

         div.refsect1 td {
             background-color: #FFF;
             padding: 5px;
             vertical-align: text-top;
                         border-collapse: collapse;
                         border-color: #000;
             border-width: 1px;
             font: normal 16px verdana, sans-serif;
         }

                   div.refsect1 p{
             font: normal 16px verdana, sans-serif;
             margin-top: 8px;
             margin-bottom: 8px;
             padding-top: 0;
             padding-bottom: 0;
         }


         /* EXAMPLE: These styles apply only to the Example section */
         div.refsect2 {
             font: normal 16px courier new, monospace !important;
         }

         div.refsect2 table {
             margin-top: 0;
             background-color: #e6e6e6;
             width: 100%;
             border: 0 solid #000;
             padding: 2px;
             font: normal 16px courier new, monospace !important;
         }

         div.refsect2 td {
             background-color: #e6e6e6;
             font: normal 16px courier new, monospace !important;
                         white-space:pre;
         }

         /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */
         div.refsect3 {
             font: normal 11px verdana, sans-serif;
             margin-top: 50px;
             margin-bottom: 20px;
             padding-top: 0;
             padding-bottom: 0;
         }

 </style>
     <title>clSetKernelExecInfo</title>
     <meta name="generator" content="DocBook XSL Stylesheets V1.79.1" />
     <meta name="keywords" content="clSetKernelExecInfo" />
   </head>
   <body>
     <div class="refentry">
       <a id="id-1"></a>
       <div class="titlepage"></div>
       <div xmlns="" class="refnamediv">
         <a xmlns="http://www.w3.org/1999/xhtml" id="clSetKernelExecInfo"></a>
         <h1>
             clSetKernelExecInfo
         </h1>
         <p>
             Pass additional information other than argument values to a kernel.
         </p>
       </div>
       <div class="refsynopsisdiv">
         <h2></h2>
         <div class="funcsynopsis">
           <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
             <tr valign="bottom">
               <td>
                 <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">
                     <a class="link" href="scalarDataTypes.html" target="pagedisplay">cl_int</a>
                     <strong class="fsfunc">clSetKernelExecInfo</strong>
                 (</code>
                 <td>
                     <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_kernel</a>
                      <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">kernel</var>
                 , </td>
               </td>
             </tr>
             <tr valign="top">
               <td> </td>
               <td>
                     cl_kernel_exec_info
                      <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">param_name</var>
                 , </td>
             </tr>
             <tr valign="top">
               <td> </td>
               <td>
                     <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">size_t</a>
                      <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">param_value_size</var>
                 , </td>
             </tr>
             <tr valign="top">
               <td> </td>
               <td>
                     const <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">void</a>
                      <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*param_value</var>
                 <code>)</code></td>
             </tr>
           </table>
         </div>
       </div>
       <div class="refsect1">
         <a id="parameters"></a>
         <h2>Parameters</h2>
         <div class="variablelist">
           <dl class="variablelist">
             <dt>
               <span class="term"> <code class="varname"> kernel </code> </span>
             </dt>
             <dd>
               <p>
                         Specifies the kernel object being queried.
                     </p>
             </dd>
             <dt>
               <span class="term"> <code class="varname"> param_name </code> </span>
             </dt>
             <dd>
               <p>
                         Specifies the information to be passed to
                         <code class="varname">kernel</code>. The list of supported
                         <code class="varname">param_name</code> types and the corresponding values passed in
                         <code class="varname">param_value</code> is described in the table below.
                     </p>
             </dd>
             <dt>
               <span class="term"> <code class="varname">param_value_size</code> </span>
             </dt>
             <dd>
               <p>
                         Specifies the size in bytes of the memory pointed to by
                         <code class="varname">param_value</code>.
                     </p>
             </dd>
             <dt>
               <span class="term"> <code class="varname"> param_value </code> </span>
             </dt>
             <dd>
               <p>
                         A pointer to memory where the appropriate values
                         determined by <code class="varname">param_name</code> are specified.
                     </p>
               <div class="informaltable">
                 <a id="cl_kernel_info"></a>
                 <table class="informaltable" border="1">
                   <colgroup>
                     <col align="left" class="col1" />
                     <col align="left" class="col2" />
                   </colgroup>
                   <thead>
                     <tr>
                       <th align="left">cl_kernel_exec_info</th>
                       <th align="left">Type and Description</th>
                     </tr>
                   </thead>
                   <tbody>
                     <tr>
                       <td align="left">
                         <code class="constant">CL_KERNEL_EXEC_INFO_SVM_PTRS</code>
                       </td>
                       <td align="left">
                                     <p>Type: void *[]</p>
                                     <p>
                                         SVM pointers used by a kernel which
                                         are not passed as arguments to <code class="varname">kernel</code>.
                                         These addresses may be defined in
                                         SVM buffer(s) that are passed as
                                         arguments to <code class="varname">kernel</code>.
                                     </p>

                                     <p>
                                         These non-argument SVM pointers
                                         must be specified using
                                         <code class="function">clSetKernelExecInfo</code>
                                         for coarse-grain and fine-grain buffer SVM
                                         allocations but not for fine-grain
                                         system SVM allocations.
                                     </p>
                                 </td>
                     </tr>
                     <tr>
                       <td align="left">
                         <code class="constant">CL_KERNEL_EXEC_INFO_SVM_-
 FINE_GRAIN_SYSTEM</code>
                       </td>
                       <td align="left">
                                     <p>Type: cl_bool</p>
                                     <p>
                                         This flag indicates whether the kernel
                                         uses pointers that are fine grain
                                         system SVM allocations. These fine
                                         grain system SVM pointers may be
                                         passed as arguments or defined in
                                         SVM buffers that are passed as
                                         argumentsto <code class="varname">kernel</code>.
                                     </p>
                                 </td>
                     </tr>
                   </tbody>
                 </table>
               </div>
             </dd>
           </dl>
         </div>
       </div>
       <div class="refsect1">
         <a id="notes"></a>
         <h2>Notes</h2>
         <p>
             1. Coarse-grain or fine-grain buffer SVM pointers
             used by a kernel which are not passed as a
             kernel arguments must be specified using
             <code class="function">clSetKernelExecInfo</code> with
             <code class="constant">CL_KERNEL_EXEC_INFO_SVM_PTRS</code>.
             For example, if SVM buffer A contains a pointer to
             another SVM buffer B, and the kernel dereferences
             that pointer, then a pointer to B must either
             be passed as an argument in the call to that
             kernel or it must be made available to the kernel
             using <code class="function">clSetKernelExecInfo</code>.
             For example, we might pass extra SVM pointers as follows:
         </p>
         <p>
 </p>
         <div class="literallayout">
           <p>
             <code class="code"><br />
 clSetKernelExecInfo(kernel,<br />
      CL_KERNEL_EXEC_INFO_SVM_PTRS,<br />
      num_ptrs * sizeof(void *),<br />
      extra_svm_ptr_list);<br />
 </code>
           </p>
         </div>
         <p>
         </p>
         <p>
             Here <code class="code">num_ptrs</code> specifies the number
             of additional SVM pointers while
             <code class="code">extra_svm_ptr_list</code> specifies a
             pointer to memory containing those SVM pointers.
         </p>
         <p>
             When calling <code class="function">clSetKernelExecInfo</code> with
             <code class="constant">CL_KERNEL_EXEC_INFO_SVM_PTRS</code> to specify
             pointers to non-argument SVM buffers as extra arguments
             to a kernel, each of these pointers can
             be the SVM pointer returned by
             <a class="citerefentry" href="clSVMAlloc.html"><span class="citerefentry"><span class="refentrytitle">clSVMAlloc</span></span></a>
             or can be a pointer + offset into the SVM region.
             It is sufficient to provide one pointer for each SVM buffer used.
         </p>
         <p>
             2. <code class="constant">CL_KERNEL_EXEC_INFO_SVM_FINE_GRAIN_SYSTEM</code>
             is used to indicate whether SVM
             pointers used by a kernel will refer to system allocations or not.
         </p>
         <p>
             <code class="constant">CL_KERNEL_EXEC_INFO_SVM_FINE_GRAIN_SYSTEM</code> =
             <code class="constant">CL_FALSE</code> indicates that the
             OpenCL implementation may assume that system pointers
             are not passed as kernel arguments
             and are not stored inside SVM allocations
             passed as kernel arguments.
         </p>
         <p>
             <code class="constant">CL_KERNEL_EXEC_INFO_SVM_FINE_GRAIN_SYSTEM</code> =
             <code class="constant">CL_TRUE</code> indicates that the OpenCL
             implementation must assume that system pointers might
             be passed as kernel arguments and/or
             stored inside SVM allocations passed as kernel arguments.
             In this case, if the device to which
             the kernel is enqueued does not support system SVM pointers,
             <a class="citerefentry" href="clEnqueueNDRangeKernel.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueNDRangeKernel</span></span></a> will
             return a <span class="errorname">CL_INVALID_OPERATION</span> error.
             If none of the devices in the context
             associated with kernel support fine-grain
             system SVM allocations, <code class="function">clSetKernelExecInfo</code>
             will return a <span class="errorname">CL_INVALID_OPERATION</span> error.
         </p>
         <p>
             If <code class="function">clSetKernelExecInfo</code> has not been called
             with a value for
             <code class="constant">CL_KERNEL_EXEC_INFO_SVM_FINE_GRAIN_SYSTEM</code>
             the default value is used for this kernel attribute.
             The defaule value depends on whether the device on which
             the kernel is enqueued supports fine-grain system SVM
             allocations. If so, the default value used is
             <code class="constant">CL_TRUE</code> (system pointers might
             be passed); otherwise, the default is <code class="constant">CL_FALSE</code>.
         </p>
         <p>
             3. A call to <code class="function">clSetKernelExecInfo</code> for a given value of
             <code class="varname">param_name</code> replaces any prior value
             passed for that value of <code class="varname">param_name</code>. Only one
             <code class="varname">param_value</code> will be stored for each value of
             <code class="varname">param_name</code>.
         </p>
         <h4><a id="id-1.6.11"></a>Multiple Host Threads</h4>
         <p>
      An OpenCL API call is considered to be
     <span class="emphasis"><em>thread-safe</em></span> if the internal state as managed by OpenCL remains
     consistent when called simultaneously by multiple <span class="emphasis"><em>host</em></span> threads.
     OpenCL API calls that are <span class="emphasis"><em>thread-safe</em></span> allow an application to
     call these functions in multiple <span class="emphasis"><em>host</em></span> threads without having to
     implement mutual exclusion across these <span class="emphasis"><em>host</em></span> threads i.e. they
     are also re-entrant-safe.
 </p>
         <p>

     All OpenCL API calls are thread-safe except those that modify the state of cl_kernel objects:
     <a class="citerefentry" href="clSetKernelArg.html"><span class="citerefentry"><span class="refentrytitle">clSetKernelArg</span></span></a>,
     <a class="citerefentry" href="clSetKernelArgSVMPointer.html"><span class="citerefentry"><span class="refentrytitle">clSetKernelArgSVMPointer</span></span></a>,
     <a class="citerefentry" href="clSetKernelExecInfo.html"><span class="citerefentry"><span class="refentrytitle">clSetKernelExecInfo</span></span></a> and
     <a class="citerefentry" href="clCloneKernel.html"><span class="citerefentry"><span class="refentrytitle">clCloneKernel</span></span></a>.
 </p>
         <p>
     <a class="citerefentry" href="clSetKernelArg.html"><span class="citerefentry"><span class="refentrytitle">clSetKernelArg</span></span></a> ,
     <a class="citerefentry" href="clSetKernelArgSVMPointer.html"><span class="citerefentry"><span class="refentrytitle">clSetKernelArgSVMPointer</span></span></a>,
     <a class="citerefentry" href="clSetKernelExecInfo.html"><span class="citerefentry"><span class="refentrytitle">clSetKernelExecInfo</span></span></a> and
     <a class="citerefentry" href="clCloneKernel.html"><span class="citerefentry"><span class="refentrytitle">clCloneKernel</span></span></a>
     are safe to call from any host thread, and safe to call re-entrantly so long as concurrent calls to any
     combination of these API calls operate on different cl_kernel objects. The state of the cl_kernel
     object is undefined if
     <a class="citerefentry" href="clSetKernelArg.html"><span class="citerefentry"><span class="refentrytitle">clSetKernelArg</span></span></a>,
     <a class="citerefentry" href="clSetKernelArgSVMPointer.html"><span class="citerefentry"><span class="refentrytitle">clSetKernelArgSVMPointer</span></span></a>,
     <a class="citerefentry" href="clSetKernelExecInfo.html"><span class="citerefentry"><span class="refentrytitle">clSetKernelExecInfo</span></span></a> or
     <a class="citerefentry" href="clCloneKernel.html"><span class="citerefentry"><span class="refentrytitle">clCloneKernel</span></span></a>
     are called from multiple host threads on the same cl_kernel object at the same
     time. Please note that there are additional limitations as to which OpenCL APIs may be called
     from OpenCL callback functions -- please see section 5.11.
 </p>
         <p>
     The behavior of OpenCL APIs called from an interrupt or signal handler is
     implementation-defined.
 </p>
         <p>
      There is an inherent race condition in the
     design of OpenCL that occurs between setting a kernel argument and using the kernel
     with
     <a class="citerefentry" href="clEnqueueNDRangeKernel.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueNDRangeKernel</span></span></a>.
     Another host thread might change the kernel arguments between when a host thread sets the
     kernel arguments and then enqueues the kernel, causing the wrong kernel arguments
     to be enqueued. Rather than attempt to share <span class="type">cl_kernel</span> objects among multiple host
     threads, applications are strongly encouraged to make additional <span class="type">cl_kernel</span> objects
     for kernel functions for each host thread.
 </p>
       </div>
       <div class="refsect1">
         <a id="errors"></a>
         <h2>Errors</h2>
         <p>
             Returns <span class="errorname">CL_SUCCESS</span> if the function
             is executed successfully. Otherwise,
             it returns one of the following errors:
         </p>
         <div class="itemizedlist">
           <ul class="itemizedlist" style="list-style-type: disc; ">
             <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_KERNEL</span> if <code class="varname">kernel</code>
                 is not a valid kernel object.
             </li>
             <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span>
                     if <code class="varname">param_name</code>
                     is not valid, if <code class="varname">param_value</code>
                     is NULL or if the size
                     specified by <code class="varname">param_value_size</code>
                     is not valid.
             </li>
             <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_OPERATION</span>
                     if <code class="varname">param_name</code> =
                     <code class="constant">CL_KERNEL_EXEC_INFO_SVM_FINE_GRAIN_SYSTEM</code>
                     and <code class="varname">param_value</code> = <code class="constant">CL_TRUE</code>
                     but no devices in context
                     associated with <code class="varname">kernel</code> support
                     fine-grain system SVM allocations.
             </li>
             <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_OUT_OF_RESOURCES</span> if there is a failure to allocate
               resources required by the OpenCL implementation on the device.
             </li>
             <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_OUT_OF_HOST_MEMORY</span> if there is a failure to allocate
               resources required by the OpenCL implementation on the host.
             </li>
           </ul>
         </div>
       </div>
       <div class="refsect1">
         <a id="specification"></a>
         <h2>Specification</h2>
         <p>
             <img src="pdficon_small1.gif" />

             <a href="https://www.khronos.org/registry/cl/specs/opencl-2.1.pdf#namedest=clSetKernelExecInfo" target="OpenCL Spec">OpenCL Specification</a>
         </p>
       </div>
       <div class="refsect1">
         <a id="seealso"></a>
         <h2>Also see</h2>
         <p>
             <a class="citerefentry" href="clCreateKernel.html"><span class="citerefentry"><span class="refentrytitle">clCreateKernel</span></span></a>,
             <a class="citerefentry" href="clGetKernelInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetKernelInfo</span></span></a>,
             <a class="citerefentry" href="clGetKernelArgInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetKernelArgInfo</span></span></a>,
             <a class="citerefentry" href="clCreateKernelsInProgram.html"><span class="citerefentry"><span class="refentrytitle">clCreateKernelsInProgram</span></span></a>,
             <a class="citerefentry" href="clSetKernelArg.html"><span class="citerefentry"><span class="refentrytitle">clSetKernelArg</span></span></a>,
             <a class="citerefentry" href="clGetKernelWorkGroupInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetKernelWorkGroupInfo</span></span></a>,
             <a class="citerefentry" href="clEnqueueNDRangeKernel.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueNDRangeKernel</span></span></a>
         </p>
       </div>
       <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p>Copyright © 2007-2015 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.
 </div>
     </div>
   </body>
 </html>
	<?xml version="1.0" encoding="UTF-8"?>
	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
	<!-- saved from url=(0013)about:internet -->
	<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl">
	<head>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
	<style xmlns="" type="text/css">
	/* This style sets a margin around the entire page */
	html, body {
	margin: 10px;
	}

	p {
	font: normal 16px verdana, sans-serif;
	margin: 0;
	padding-bottom:12px;
	}

	h1 {
	font: bold 25px verdana, sans-serif;
	margin-top: 0;
	margin-bottom: 3px;
	padding-top: 0;
	padding-bottom: 0;
	}

	h2 {
	font: bold 19px verdana, sans-serif;
	margin-top: 28px;
	margin-bottom: 3px;
	padding-top: 0;
	padding-bottom: 0;
	}

	h3 {
	font: bold 19px verdana, sans-serif !important;
	margin-top: 28px;
	margin-bottom: 3px;
	padding-top: 0;
	padding-bottom: 0;
	}

	li {
	font: normal 16px verdana, sans-serif;
	margin-top: 0;
	margin-bottom: 18px;
	padding-top: 0;
	padding-bottom: 0;
	}

	.pdparam {
	font: italic 16px verdana, sans-serif;
	}

	.term {
	font: italic 16px verdana, sans-serif;
	font-weight: normal;
	}

	.type {
	font: normal 16px verdana, sans-serif !important;
	}

	.parameter {
	font-style: italic;
	}

	a:link, a:visited {
	color: blue;
	text-decoration: none;
	font: normal 16px;
	}

	a:hover {
	background-color: #FFFF99;
	font: normal 16px;
	}

	div.funcsynopsis {
	text-align: left;
	background-color: #e6e6e6;
	font: normal 16px verdana, sans-serif;
	padding-top: 10px;
	padding-bottom: 10px;
	}

	div.funcsynopsis table {
	border-collapse: separate;
	font: normal 16px verdana, sans-serif;
	}

	div.funcsynopsis td {
	background-color: #e6e6e6;
	border: 0 solid #000;
	padding: 1px;
	font: normal 16px verdana, sans-serif;
	}

	div.refsect1 {
	font-family: verdana, sans-serif;
	font-size: 16px;
	}

	code.constant {
	font: normal 16px courier new, monospace !important;
	}

	span.errorname {
	font: normal 16px verdana, sans-serif !important;
	}

	code.function {
	font: bold 16px verdana, sans-serif !important;
	}

	b.fsfunc {
	font: bold 16px verdana, sans-serif !important;
	}

	code.varname {
	font: italic 16px verdana, sans-serif;
	}

	code.replaceable {
	font: italic 16px courier new, monospace;
	}

	code.funcdef {
	font: normal 16px verdana, sans-serif !important;
	}

	.citerefentry {
	font: normal 16px verdana, sans-serif !important;
	}

	.parameter {
	font-style: italic;
	}

	code.fsfunc {
	font: normal 16px verdana, sans-serif !important;
	}

	/* PARAMETER: This style controls spacing between the terms in Parameter section */
	dt {
	margin-top: 15px;
	}

	/* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */
	div.refsect1 table {
	width: 100%;
	margin-top: 10px;
	background-color: #FFF;
	border-collapse: collapse;
	border-color: #000;
	border-width: 1px;
	font: normal 16px verdana, sans-serif;
	}

	div.refsect1 th {
	border-collapse: collapse;
	border-color: #000;
	border-width: 1px;
	font: bold 16px verdana, sans-serif;
	}

	div.refsect1 td {
	background-color: #FFF;
	padding: 5px;
	vertical-align: text-top;
	border-collapse: collapse;
	border-color: #000;
	border-width: 1px;
	font: normal 16px verdana, sans-serif;
	}

	div.refsect1 p{
	font: normal 16px verdana, sans-serif;
	margin-top: 8px;
	margin-bottom: 8px;
	padding-top: 0;
	padding-bottom: 0;
	}


	/* EXAMPLE: These styles apply only to the Example section */
	div.refsect2 {
	font: normal 16px courier new, monospace !important;
	}

	div.refsect2 table {
	margin-top: 0;
	background-color: #e6e6e6;
	width: 100%;
	border: 0 solid #000;
	padding: 2px;
	font: normal 16px courier new, monospace !important;
	}

	div.refsect2 td {
	background-color: #e6e6e6;
	font: normal 16px courier new, monospace !important;
	white-space:pre;
	}

	/* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */
	div.refsect3 {
	font: normal 11px verdana, sans-serif;
	margin-top: 50px;
	margin-bottom: 20px;
	padding-top: 0;
	padding-bottom: 0;
	}

	</style>
	<title>clSetKernelExecInfo</title>
	<meta name="generator" content="DocBook XSL Stylesheets V1.79.1" />
	<meta name="keywords" content="clSetKernelExecInfo" />
	</head>
	<body>
	<div class="refentry">
	<a id="id-1"></a>
	<div class="titlepage"></div>
	<div xmlns="" class="refnamediv">
	<a xmlns="http://www.w3.org/1999/xhtml" id="clSetKernelExecInfo"></a>
	<h1>
	clSetKernelExecInfo
	</h1>
	<p>
	Pass additional information other than argument values to a kernel.
	</p>
	</div>
	<div class="refsynopsisdiv">
	<h2></h2>
	<div class="funcsynopsis">
	<table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
	<tr valign="bottom">
	<td>
	<code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">
	<a class="link" href="scalarDataTypes.html" target="pagedisplay">cl_int</a>
	<strong class="fsfunc">clSetKernelExecInfo</strong>
	(</code>
	<td>
	<a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_kernel</a>
	<var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">kernel</var>
	, </td>
	</td>
	</tr>
	<tr valign="top">
	<td> </td>
	<td>
	cl_kernel_exec_info
	<var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">param_name</var>
	, </td>
	</tr>
	<tr valign="top">
	<td> </td>
	<td>
	<a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">size_t</a>
	<var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">param_value_size</var>
	, </td>
	</tr>
	<tr valign="top">
	<td> </td>
	<td>
	const <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">void</a>
	<var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*param_value</var>
	<code>)</code></td>
	</tr>
	</table>
	</div>
	</div>
	<div class="refsect1">
	<a id="parameters"></a>
	<h2>Parameters</h2>
	<div class="variablelist">
	<dl class="variablelist">
	<dt>
	<span class="term"> <code class="varname"> kernel </code> </span>
	</dt>
	<dd>
	<p>
	Specifies the kernel object being queried.
	</p>
	</dd>
	<dt>
	<span class="term"> <code class="varname"> param_name </code> </span>
	</dt>
	<dd>
	<p>
	Specifies the information to be passed to
	<code class="varname">kernel</code>. The list of supported
	<code class="varname">param_name</code> types and the corresponding values passed in
	<code class="varname">param_value</code> is described in the table below.
	</p>
	</dd>
	<dt>
	<span class="term"> <code class="varname">param_value_size</code> </span>
	</dt>
	<dd>
	<p>
	Specifies the size in bytes of the memory pointed to by
	<code class="varname">param_value</code>.
	</p>
	</dd>
	<dt>
	<span class="term"> <code class="varname"> param_value </code> </span>
	</dt>
	<dd>
	<p>
	A pointer to memory where the appropriate values
	determined by <code class="varname">param_name</code> are specified.
	</p>
	<div class="informaltable">
	<a id="cl_kernel_info"></a>
	<table class="informaltable" border="1">
	<colgroup>
	<col align="left" class="col1" />
	<col align="left" class="col2" />
	</colgroup>
	<thead>
	<tr>
	<th align="left">cl_kernel_exec_info</th>
	<th align="left">Type and Description</th>
	</tr>
	</thead>
	<tbody>
	<tr>
	<td align="left">
	<code class="constant">CL_KERNEL_EXEC_INFO_SVM_PTRS</code>
	</td>
	<td align="left">
	<p>Type: void *[]</p>
	<p>
	SVM pointers used by a kernel which
	are not passed as arguments to <code class="varname">kernel</code>.
	These addresses may be defined in
	SVM buffer(s) that are passed as
	arguments to <code class="varname">kernel</code>.
	</p>

	<p>
	These non-argument SVM pointers
	must be specified using
	<code class="function">clSetKernelExecInfo</code>
	for coarse-grain and fine-grain buffer SVM
	allocations but not for fine-grain
	system SVM allocations.
	</p>
	</td>
	</tr>
	<tr>
	<td align="left">
	<code class="constant">CL_KERNEL_EXEC_INFO_SVM_-
	FINE_GRAIN_SYSTEM</code>
	</td>
	<td align="left">
	<p>Type: cl_bool</p>
	<p>
	This flag indicates whether the kernel
	uses pointers that are fine grain
	system SVM allocations. These fine
	grain system SVM pointers may be
	passed as arguments or defined in
	SVM buffers that are passed as
	argumentsto <code class="varname">kernel</code>.
	</p>
	</td>
	</tr>
	</tbody>
	</table>
	</div>
	</dd>
	</dl>
	</div>
	</div>
	<div class="refsect1">
	<a id="notes"></a>
	<h2>Notes</h2>
	<p>
	1. Coarse-grain or fine-grain buffer SVM pointers
	used by a kernel which are not passed as a
	kernel arguments must be specified using
	<code class="function">clSetKernelExecInfo</code> with
	<code class="constant">CL_KERNEL_EXEC_INFO_SVM_PTRS</code>.
	For example, if SVM buffer A contains a pointer to
	another SVM buffer B, and the kernel dereferences
	that pointer, then a pointer to B must either
	be passed as an argument in the call to that
	kernel or it must be made available to the kernel
	using <code class="function">clSetKernelExecInfo</code>.
	For example, we might pass extra SVM pointers as follows:
	</p>
	<p>
	</p>
	<div class="literallayout">
	<p>
	<code class="code"><br />
	clSetKernelExecInfo(kernel,<br />
	CL_KERNEL_EXEC_INFO_SVM_PTRS,<br />
	num_ptrs * sizeof(void *),<br />
	extra_svm_ptr_list);<br />
	</code>
	</p>
	</div>
	<p>
	</p>
	<p>
	Here <code class="code">num_ptrs</code> specifies the number
	of additional SVM pointers while
	<code class="code">extra_svm_ptr_list</code> specifies a
	pointer to memory containing those SVM pointers.
	</p>
	<p>
	When calling <code class="function">clSetKernelExecInfo</code> with
	<code class="constant">CL_KERNEL_EXEC_INFO_SVM_PTRS</code> to specify
	pointers to non-argument SVM buffers as extra arguments
	to a kernel, each of these pointers can
	be the SVM pointer returned by
	<a class="citerefentry" href="clSVMAlloc.html"><span class="citerefentry"><span class="refentrytitle">clSVMAlloc</span></span></a>
	or can be a pointer + offset into the SVM region.
	It is sufficient to provide one pointer for each SVM buffer used.
	</p>
	<p>
	2. <code class="constant">CL_KERNEL_EXEC_INFO_SVM_FINE_GRAIN_SYSTEM</code>
	is used to indicate whether SVM
	pointers used by a kernel will refer to system allocations or not.
	</p>
	<p>
	<code class="constant">CL_KERNEL_EXEC_INFO_SVM_FINE_GRAIN_SYSTEM</code> =
	<code class="constant">CL_FALSE</code> indicates that the
	OpenCL implementation may assume that system pointers
	are not passed as kernel arguments
	and are not stored inside SVM allocations
	passed as kernel arguments.
	</p>
	<p>
	<code class="constant">CL_KERNEL_EXEC_INFO_SVM_FINE_GRAIN_SYSTEM</code> =
	<code class="constant">CL_TRUE</code> indicates that the OpenCL
	implementation must assume that system pointers might
	be passed as kernel arguments and/or
	stored inside SVM allocations passed as kernel arguments.
	In this case, if the device to which
	the kernel is enqueued does not support system SVM pointers,
	<a class="citerefentry" href="clEnqueueNDRangeKernel.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueNDRangeKernel</span></span></a> will
	return a <span class="errorname">CL_INVALID_OPERATION</span> error.
	If none of the devices in the context
	associated with kernel support fine-grain
	system SVM allocations, <code class="function">clSetKernelExecInfo</code>
	will return a <span class="errorname">CL_INVALID_OPERATION</span> error.
	</p>
	<p>
	If <code class="function">clSetKernelExecInfo</code> has not been called
	with a value for
	<code class="constant">CL_KERNEL_EXEC_INFO_SVM_FINE_GRAIN_SYSTEM</code>
	the default value is used for this kernel attribute.
	The defaule value depends on whether the device on which
	the kernel is enqueued supports fine-grain system SVM
	allocations. If so, the default value used is
	<code class="constant">CL_TRUE</code> (system pointers might
	be passed); otherwise, the default is <code class="constant">CL_FALSE</code>.
	</p>
	<p>
	3. A call to <code class="function">clSetKernelExecInfo</code> for a given value of
	<code class="varname">param_name</code> replaces any prior value
	passed for that value of <code class="varname">param_name</code>. Only one
	<code class="varname">param_value</code> will be stored for each value of
	<code class="varname">param_name</code>.
	</p>
	<h4><a id="id-1.6.11"></a>Multiple Host Threads</h4>
	<p>
	An OpenCL API call is considered to be
	<span class="emphasis"><em>thread-safe</em></span> if the internal state as managed by OpenCL remains
	consistent when called simultaneously by multiple <span class="emphasis"><em>host</em></span> threads.
	OpenCL API calls that are <span class="emphasis"><em>thread-safe</em></span> allow an application to
	call these functions in multiple <span class="emphasis"><em>host</em></span> threads without having to
	implement mutual exclusion across these <span class="emphasis"><em>host</em></span> threads i.e. they
	are also re-entrant-safe.
	</p>
	<p>

	All OpenCL API calls are thread-safe except those that modify the state of cl_kernel objects:
	<a class="citerefentry" href="clSetKernelArg.html"><span class="citerefentry"><span class="refentrytitle">clSetKernelArg</span></span></a>,
	<a class="citerefentry" href="clSetKernelArgSVMPointer.html"><span class="citerefentry"><span class="refentrytitle">clSetKernelArgSVMPointer</span></span></a>,
	<a class="citerefentry" href="clSetKernelExecInfo.html"><span class="citerefentry"><span class="refentrytitle">clSetKernelExecInfo</span></span></a> and
	<a class="citerefentry" href="clCloneKernel.html"><span class="citerefentry"><span class="refentrytitle">clCloneKernel</span></span></a>.
	</p>
	<p>
	<a class="citerefentry" href="clSetKernelArg.html"><span class="citerefentry"><span class="refentrytitle">clSetKernelArg</span></span></a> ,
	<a class="citerefentry" href="clSetKernelArgSVMPointer.html"><span class="citerefentry"><span class="refentrytitle">clSetKernelArgSVMPointer</span></span></a>,
	<a class="citerefentry" href="clSetKernelExecInfo.html"><span class="citerefentry"><span class="refentrytitle">clSetKernelExecInfo</span></span></a> and
	<a class="citerefentry" href="clCloneKernel.html"><span class="citerefentry"><span class="refentrytitle">clCloneKernel</span></span></a>
	are safe to call from any host thread, and safe to call re-entrantly so long as concurrent calls to any
	combination of these API calls operate on different cl_kernel objects. The state of the cl_kernel
	object is undefined if
	<a class="citerefentry" href="clSetKernelArg.html"><span class="citerefentry"><span class="refentrytitle">clSetKernelArg</span></span></a>,
	<a class="citerefentry" href="clSetKernelArgSVMPointer.html"><span class="citerefentry"><span class="refentrytitle">clSetKernelArgSVMPointer</span></span></a>,
	<a class="citerefentry" href="clSetKernelExecInfo.html"><span class="citerefentry"><span class="refentrytitle">clSetKernelExecInfo</span></span></a> or
	<a class="citerefentry" href="clCloneKernel.html"><span class="citerefentry"><span class="refentrytitle">clCloneKernel</span></span></a>
	are called from multiple host threads on the same cl_kernel object at the same
	time. Please note that there are additional limitations as to which OpenCL APIs may be called
	from OpenCL callback functions -- please see section 5.11.
	</p>
	<p>
	The behavior of OpenCL APIs called from an interrupt or signal handler is
	implementation-defined.
	</p>
	<p>
	There is an inherent race condition in the
	design of OpenCL that occurs between setting a kernel argument and using the kernel
	with
	<a class="citerefentry" href="clEnqueueNDRangeKernel.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueNDRangeKernel</span></span></a>.
	Another host thread might change the kernel arguments between when a host thread sets the
	kernel arguments and then enqueues the kernel, causing the wrong kernel arguments
	to be enqueued. Rather than attempt to share <span class="type">cl_kernel</span> objects among multiple host
	threads, applications are strongly encouraged to make additional <span class="type">cl_kernel</span> objects
	for kernel functions for each host thread.
	</p>
	</div>
	<div class="refsect1">
	<a id="errors"></a>
	<h2>Errors</h2>
	<p>
	Returns <span class="errorname">CL_SUCCESS</span> if the function
	is executed successfully. Otherwise,
	it returns one of the following errors:
	</p>
	<div class="itemizedlist">
	<ul class="itemizedlist" style="list-style-type: disc; ">
	<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_KERNEL</span> if <code class="varname">kernel</code>
	is not a valid kernel object.
	</li>
	<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span>
	if <code class="varname">param_name</code>
	is not valid, if <code class="varname">param_value</code>
	is NULL or if the size
	specified by <code class="varname">param_value_size</code>
	is not valid.
	</li>
	<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_OPERATION</span>
	if <code class="varname">param_name</code> =
	<code class="constant">CL_KERNEL_EXEC_INFO_SVM_FINE_GRAIN_SYSTEM</code>
	and <code class="varname">param_value</code> = <code class="constant">CL_TRUE</code>
	but no devices in context
	associated with <code class="varname">kernel</code> support
	fine-grain system SVM allocations.
	</li>
	<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_OUT_OF_RESOURCES</span> if there is a failure to allocate
	resources required by the OpenCL implementation on the device.
	</li>
	<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_OUT_OF_HOST_MEMORY</span> if there is a failure to allocate
	resources required by the OpenCL implementation on the host.
	</li>
	</ul>
	</div>
	</div>
	<div class="refsect1">
	<a id="specification"></a>
	<h2>Specification</h2>
	<p>
	<img src="pdficon_small1.gif" />

	<a href="https://www.khronos.org/registry/cl/specs/opencl-2.1.pdf#namedest=clSetKernelExecInfo" target="OpenCL Spec">OpenCL Specification</a>
	</p>
	</div>
	<div class="refsect1">
	<a id="seealso"></a>
	<h2>Also see</h2>
	<p>
	<a class="citerefentry" href="clCreateKernel.html"><span class="citerefentry"><span class="refentrytitle">clCreateKernel</span></span></a>,
	<a class="citerefentry" href="clGetKernelInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetKernelInfo</span></span></a>,
	<a class="citerefentry" href="clGetKernelArgInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetKernelArgInfo</span></span></a>,
	<a class="citerefentry" href="clCreateKernelsInProgram.html"><span class="citerefentry"><span class="refentrytitle">clCreateKernelsInProgram</span></span></a>,
	<a class="citerefentry" href="clSetKernelArg.html"><span class="citerefentry"><span class="refentrytitle">clSetKernelArg</span></span></a>,
	<a class="citerefentry" href="clGetKernelWorkGroupInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetKernelWorkGroupInfo</span></span></a>,
	<a class="citerefentry" href="clEnqueueNDRangeKernel.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueNDRangeKernel</span></span></a>
	</p>
	</div>
	<div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p>Copyright © 2007-2015 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.
	</div>
	</div>
	</body>
	</html>