| <?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>clLinkProgram</title> | |
| <meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /> | |
| <meta name="keywords" content="clLinkProgram" /> | |
| </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="clLinkProgram"></a> | |
| <h1> | |
| clLinkProgram | |
| </h1> | |
| <p> | |
| Links a set of compiled program objects and libraries for all the devices or a specific device(s) in | |
| the OpenCL context and creates a library or executable. | |
| </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_program</a> | |
| <strong class="fsfunc">clLinkProgram</strong> | |
| (</code> | |
| <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_context</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">context</var>, </td> | |
| </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">cl_uint</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">num_devices</var>, </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td>const <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_device_id</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*device_list</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">char</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*options</var>, </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">cl_uint</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">num_input_programs</var>, </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td>const <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_program</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*input_programs</var>, </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td><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">(CL_CALLBACK *pfn_notify) | |
| (<a class="link" href="abstractDataTypes.html" target="pagedisplay">cl_program</a> program, <a class="link" href="scalarDataTypes.html" target="_top">void</a> *user_data)</var>, </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td><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">*user_data</var>, </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">cl_int</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*errcode_ret</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"> | |
| context | |
| </code> | |
| </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| Must be a valid OpenCL context. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> | |
| <code class="varname"> | |
| device_list | |
| </code> | |
| </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| A pointer to a list of devices that are in <code class="varname">context</code>. | |
| If <code class="varname">device_list</code> is a NULL value, the link is performed | |
| for all devices associated with <code class="varname">context</code> for which a | |
| compiled object is available. If <code class="varname">device_list</code> is a | |
| non-NULL value, the compile is performed for devices specified in this | |
| list for which a compiled object is available. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> | |
| <code class="varname"> | |
| num_devices | |
| </code> | |
| </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| The number of devices listed in <code class="varname">device_list</code>. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> | |
| <code class="varname"> | |
| options | |
| </code> | |
| </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| A pointer to a null-terminated string of characters that describes | |
| the link options to be used for building the program executable. See | |
| <a class="citerefentry" href="clBuildProgram.html"><span class="citerefentry"><span class="refentrytitle">clBuildProgram</span></span></a> | |
| for a list of supported compiler and linker options. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> | |
| <code class="varname"> | |
| num_input_programs | |
| </code> | |
| </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| Specifies the number of programs in array referenced by <code class="varname">input_programs</code>. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> | |
| <code class="varname"> | |
| input_programs | |
| </code> | |
| </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| An array of program objects that are compiled binaries or libraries | |
| that are to be linked to create the program executable. For each device | |
| in <code class="varname">device_list</code> or if <code class="varname">device_list</code> | |
| is NULL the list of devices associated with <code class="varname">context</code>, | |
| the following cases occur: | |
| </p> | |
| <div class="itemizedlist"> | |
| <ul class="itemizedlist" style="list-style-type: disc; "> | |
| <li class="listitem" style="list-style-type: disc"> | |
| <p> | |
| All programs specified by <code class="varname">input_programs</code> | |
| contain a compiled binary or library for the device. In this case, | |
| a link is performed to generate a program executable for this device. | |
| </p> | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"> | |
| <p> | |
| None of the programs contain a compiled binary or library for | |
| that device. In this case, no link is performed and there will | |
| be no program executable generated for this device. | |
| </p> | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"> | |
| <p> | |
| All other cases will return a | |
| <code class="constant">CL_INVALID_OPERATION</code> error. | |
| </p> | |
| </li> | |
| </ul> | |
| </div> | |
| </dd> | |
| <dt> | |
| <span class="term"> | |
| <code class="varname"> | |
| pfn_notify | |
| </code> | |
| </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| A function pointer to a notification routine. The notification routine is a | |
| callback function that an application can register and which will be called | |
| when the program executable has been built (successfully or unsuccessfully). | |
| </p> | |
| <p> | |
| If <code class="varname">pfn_notify</code> is not NULL, | |
| <code class="function">clLinkProgram</code> does not need to wait for the linker | |
| to complete and can return immediately once the linking operation can | |
| begin. Once the linker has completed, the <code class="varname">pfn_notify</code> | |
| callback function is called which returns the program object returned | |
| by <code class="function">clLinkProgram</code>. The application can query the link | |
| status and log for this program object. This callback function may be called | |
| asynchronously by the OpenCL implementation. It is the application’s | |
| responsibility to ensure that the callback function is thread-safe. | |
| </p> | |
| <p> | |
| If <code class="varname">pfn_notify</code> is NULL, <code class="function">clLinkProgram</code> | |
| does not return until the linker has completed. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> | |
| <code class="varname"> | |
| user_data | |
| </code> | |
| </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| Will be passed as an argument when <code class="varname">pfn_notify</code> is called. | |
| <code class="varname">user_data</code> can be NULL. | |
| </p> | |
| </dd> | |
| </dl> | |
| </div> | |
| </div> | |
| <div class="refsect1"> | |
| <a id="notes"></a> | |
| <h2>Notes</h2> | |
| <p> | |
| <code class="function">clLinkProgram</code> creates a new program object which | |
| contains the library or executable. | |
| <a class="citerefentry" href="clLinkProgram.html"><span class="citerefentry"><span class="refentrytitle">clLinkProgram</span></span></a> | |
| creates a new program object which contains the library or executable. | |
| The library or executable binary can be queried using | |
| <a class="citerefentry" href="clGetProgramInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetProgramInfo</span></span></a>(<code class="varname">program</code>, | |
| <code class="constant">CL_PROGRAM_BINARIES</code>, ...) and can be specified to | |
| <a class="citerefentry" href="clCreateProgramWithBinary.html"><span class="citerefentry"><span class="refentrytitle">clCreateProgramWithBinary</span></span></a> | |
| to create a new program object. | |
| </p> | |
| <p> | |
| The devices associated with the returned program object will be the list of devices | |
| specified by <code class="varname">device_list</code> or if <code class="varname">device_list</code> | |
| is NULL it will be the list of devices associated with <code class="varname">context</code>. | |
| </p> | |
| <p> | |
| The linking operation can begin if the context, list of devices, input programs and | |
| linker options specified are all valid and appropriate host and device resources | |
| needed to perform the link are available. If the linking operation can begin, | |
| <code class="function">clLinkProgram</code> returns a valid non-zero program object. | |
| </p> | |
| </div> | |
| <div class="refsect1"> | |
| <a id="errors"></a> | |
| <h2>Errors</h2> | |
| <p> | |
| If <code class="varname">pfn_notify</code> is NULL, the <code class="varname">errcode_ret</code> will | |
| be set to <code class="constant">CL_SUCCESS</code> if the link operation was successful and | |
| <code class="constant">CL_LINK_FAILURE</code> if there is a failure to link the compiled | |
| binaries and/or libraries. | |
| </p> | |
| <p> | |
| If <code class="varname">pfn_notify</code> is not NULL, <code class="function">clLinkProgram</code> | |
| does not have to wait until the linker to complete and can return | |
| <code class="constant">CL_SUCCESS</code> in <code class="varname">errcode_ret</code> if the linking | |
| operation can begin. The <code class="varname">pfn_notify</code> callback function will | |
| return a <code class="constant">CL_SUCCESS</code> or <code class="constant">CL_LINK_FAILURE</code> | |
| if the linking operation was successful or not. | |
| </p> | |
| <p> | |
| Otherwise <code class="function">clLinkProgram</code> returns a NULL program object with an | |
| appropriate error in <code class="varname">errcode_ret</code>. The application should query | |
| the linker status of this program object to check if the link was successful or not. | |
| The list of errors that can be returned are: | |
| </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_CONTEXT</span> if <code class="varname">context</code> is not a valid context. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if <code class="varname">device_list</code> | |
| is NULL and <code class="varname">num_devices</code> is greater than zero, or if | |
| <code class="varname">device_list</code> is not NULL and <code class="varname">num_devices</code> | |
| is zero. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if <code class="varname">num_input_programs</code> | |
| is zero and <code class="varname">input_programs</code> is NULL or if | |
| <code class="varname">num_input_programs</code> is zero and <code class="varname">input_programs</code> | |
| is not NULL or if <code class="varname">num_input_programs</code> is not zero and | |
| <code class="varname">input_programs</code> is NULL. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_PROGRAM</span> if programs specified in | |
| <code class="varname">input_programs</code> are not valid program objects. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if <code class="varname">pfn_notify</code> is | |
| NULL but <code class="varname">user_data</code> is not NULL. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_DEVICE</span> if OpenCL devices listed in | |
| <code class="varname">device_list</code> are not in the list of devices associated with | |
| <code class="varname">context</code>. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_LINKER_OPTIONS</span> if the linker options specified by | |
| <code class="varname">options</code> are invalid | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_OPERATION</span> if the compilation | |
| or build of a program executable for any of the devices | |
| listed in <code class="varname">device_list</code> by a previous call to | |
| <a class="citerefentry" href="clCompileProgram.html"><span class="citerefentry"><span class="refentrytitle">clCompileProgram</span></span></a> | |
| or <a class="citerefentry" href="clBuildProgram.html"><span class="citerefentry"><span class="refentrytitle">clBuildProgram</span></span></a> | |
| for <code class="varname">program</code> has not completed. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_OPERATION</span> if the rules for devices containing | |
| compiled binaries or libraries as described in <code class="varname">input_programs</code> | |
| argument above are not followed. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_OPERATION</span> if the one or more of the programs specified in | |
| <code class="varname">input_programs</code> requires independent forward progress of | |
| sub-groups but one or more of | |
| the devices listed in | |
| <code class="varname">device_list</code> does not return | |
| <code class="constant">CL_TRUE</code> for the | |
| <code class="constant">CL_DEVICE_SUBGROUP_INDEPENDENT_FORWARD_PROGRESS</code> query. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_LINKER_NOT_AVAILABLE</span> if a linker is not | |
| available i.e. <code class="constant">CL_DEVICE_LINKER_AVAILABLE</code> specified | |
| in the table of allowed values for <code class="varname">param_name</code> for | |
| <a class="citerefentry" href="clGetDeviceInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetDeviceInfo</span></span></a> | |
| is set to <code class="constant">CL_FALSE</code>. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_LINK_PROGRAM_FAILURE</span> if there is a failure to link the | |
| compiled binaries and/or libraries. | |
| </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#page=205" target="OpenCL Spec">OpenCL Specification</a> | |
| </p> | |
| </div> | |
| <div class="refsect1"> | |
| <a id="seealso"></a> | |
| <h2>Also see</h2> | |
| <p> | |
| <a class="citerefentry" href="clGetDeviceInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetDeviceInfo</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> |