| <?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>clEnqueueSVMFree</title> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /> |
| <meta name="keywords" content="clEnqueueSVMFree" /> |
| </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="clEnqueueSVMFree"></a> |
| <h1> |
| clEnqueueSVMFree |
| </h1> |
| <p> |
| Enqueues a command to free the shared virtual memory allocated using clSVMAlloc or a shared system memory pointer. |
| </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">clEnqueueSVMFree</strong> |
| (</code> |
| <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_command_queue</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">command_queue</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_svm_pointers</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">*svm_pointers[]</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> (CL_CALLBACK <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*pfn_free_func) |
| (<a class="link" href="abstractDataTypes.html" target="pagedisplay"> cl_command_queue</a> queue, <a class="link" href="scalarDataTypes.html" target="_top"> cl_uint</a> num_svm_pointers, |
| <a class="link" href="scalarDataTypes.html" target="pagedisplay"> void</a> *svm_pointers[]</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">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_uint</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">num_events_in_wait_list</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_event</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*event_wait_list</var>, </td> |
| </tr> |
| <tr valign="top"> |
| <td> </td> |
| <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_event</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*event</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">command_queue</code> |
| </span> |
| </dt> |
| <dd> |
| <p>A valid host command-queue.</p> |
| </dd> |
| <dt> |
| <span class="term"> |
| <code class="varname">svm_pointers and num_svm_pointers</code> |
| </span> |
| </dt> |
| <dd> |
| <p> |
| Specify shared virtual memory pointers to be freed. Each |
| pointer in <code class="varname">svm_pointers</code> that was |
| allocated using |
| <a class="citerefentry" href="clSVMAlloc.html"><span class="citerefentry"><span class="refentrytitle">clSVMAlloc</span></span></a> |
| must have been allocated from the |
| same context from which <code class="varname">command_queue</code> |
| was created. The memory associated with |
| <code class="varname">svm_pointers</code> can be reused or |
| freed after the function returns. |
| </p> |
| </dd> |
| <dt> |
| <span class="term"> |
| <code class="varname">pfn_free_func</code> |
| </span> |
| </dt> |
| <dd> |
| <p> |
| Specifies the callback |
| function to be called to free the SVM pointers. |
| <code class="varname">pfn_free_func</code> takes four arguments: |
| <code class="varname">queue</code> which is the command queue in which |
| <code class="function">clEnqueueSVMFree</code> was enqueued, the |
| count and list of SVM pointers to free and <code class="varname">user_data</code> |
| which is a pointer to user specified data. |
| If <code class="varname">pfn_free_func</code> is NULL, all pointers specified in |
| <code class="varname">svm_pointers</code> must be allocated using |
| <a class="citerefentry" href="clSVMAlloc.html"><span class="citerefentry"><span class="refentrytitle">clSVMAlloc</span></span></a> |
| and the OpenCL implementation will free |
| these SVM pointers. <code class="varname">pfn_free_func</code> must |
| be a valid callback function if any SVM pointer to be |
| freed is a shared system memory pointer i.e. not allocated |
| using <a class="citerefentry" href="clSVMAlloc.html"><span class="citerefentry"><span class="refentrytitle">clSVMAlloc</span></span></a>. |
| If <code class="varname">pfn_free_func</code> |
| is a valid callback function, the OpenCL implementation |
| will call <code class="varname">pfn_free_func</code> to free all the |
| SVM pointers specified in <code class="varname">svm_pointers</code>. |
| </p> |
| </dd> |
| <dt> |
| <span class="term"> |
| <code class="varname">user_data</code> |
| </span> |
| </dt> |
| <dd> |
| <p> |
| Will be passed as the |
| <code class="varname">user_data</code> argument when <code class="varname">pfn_free_func</code> |
| is called. <code class="varname">user_data</code> can be NULL. |
| </p> |
| </dd> |
| <dt> |
| <span class="term"><code class="varname">event_wait_list</code> and <code class="varname">num_events_in_wait_list</code></span> |
| </dt> |
| <dd> |
| <p> |
| Specify events that need to complete before |
| <code class="function">clEnqueueSVMFree</code> can be executed. If |
| <code class="varname">event_wait_list</code> is NULL, then |
| <code class="function">clEnqueueSVMFree</code> |
| does not wait on any event to complete. If |
| <code class="varname">event_wait_list</code> is NULL, |
| <code class="varname">num_events_in_wait_list</code> |
| must be 0. If <code class="varname">event_wait_list</code> is not |
| NULL, the list of events pointed to by |
| <code class="varname">event_wait_list</code> must |
| be valid and <code class="varname">num_events_in_wait_list</code> |
| must be greater than 0. The events specified in |
| <code class="varname">event_wait_list</code> act as synchronization |
| points. The context associated with events in |
| <code class="varname">event_wait_list</code> and |
| <code class="varname">command_queue</code> must be the same. |
| The memory associated with |
| <code class="varname">event_wait_list</code> can be |
| reused or freed after the function returns. |
| </p> |
| </dd> |
| <dt> |
| <span class="term"> |
| <code class="varname">event</code> |
| </span> |
| </dt> |
| <dd> |
| <p> |
| Returns an event object that |
| identifies this particular command and can be used to query or |
| queue a wait for this particular command to complete. |
| <code class="varname">event</code> can be NULL in which case it will |
| not be possible for the application to query the |
| status of this command or queue a wait for this |
| command to complete. If the <code class="varname">event_wait_list</code> |
| and the <code class="varname">event</code> arguments are not NULL, |
| the <code class="varname">event</code> |
| argument should not refer to an element of the |
| <code class="varname">event_wait_list</code> array. |
| </p> |
| </dd> |
| </dl> |
| </div> |
| </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_COMMAND_QUEUE</span> if |
| <code class="varname">command_queue</code> is not a valid host command-queue. |
| </li> |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if |
| <code class="varname">num_svm_pointers</code> is 0 and |
| <code class="varname">svm_pointers</code> is non-NULL, or if <code class="varname">svm_pointers</code> |
| is NULL and <code class="varname">num_svm_pointers</code> is not 0. |
| </li> |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_EVENT_WAIT_LIST</span> if |
| <code class="varname">event_wait_list</code> is NULL and |
| <code class="varname">num_events_in_wait_list</code> > 0, or |
| <code class="varname">event_wait_list</code> is not NULL and |
| <code class="varname">num_events_in_wait_list</code> is 0, or |
| if event objects in <code class="varname">event_wait_list</code> |
| are not valid events. |
| </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=179" target="OpenCL Spec">OpenCL Specification</a> |
| </p> |
| </div> |
| <div class="refsect1"> |
| <a id="seealso"></a> |
| <h2>Also see</h2> |
| <p> |
| <a class="citerefentry" href="sharedVirtualMemory.html"><span class="citerefentry"><span class="refentrytitle">Shared Virtual Memory Functions</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> |
