Google Git
Sign in
apache / mxnet-site / d5c5a235eef72f64ccaf224b834a20ef3287469b / . / versions / master / api / cpp / docs / api / oneapi_2dnnl_2dnnl__ocl_8h_source.html
blob: 1d52af86554b66955e8998ad9191bd0a6d93f373 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mxnet: /work/mxnet/include/onednn/oneapi/dnnl/dnnl_ocl.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">mxnet
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_8322d03a9084af5057e45682bd115605.html">onednn</a></li><li class="navelem"><a class="el" href="dir_e4ef4ffb25cbd8e1d39a4743c545533c.html">oneapi</a></li><li class="navelem"><a class="el" href="dir_eb872d79ea085d72d8b363abd09d06de.html">dnnl</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">dnnl_ocl.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="oneapi_2dnnl_2dnnl__ocl_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*******************************************************************************</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">* Copyright 2020-2021 Intel Corporation</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">*</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">* Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">* you may not use this file except in compliance with the License.</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">* You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">*</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">* http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">*</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">* Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">* distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">* See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">* limitations under the License.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">*******************************************************************************/</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#ifndef ONEAPI_DNNL_DNNL_OCL_H</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#define ONEAPI_DNNL_DNNL_OCL_H</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="oneapi_2dnnl_2dnnl_8h.html">oneapi/dnnl/dnnl.h</a>&quot;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &quot;oneapi/dnnl/dnnl_ocl_types.h&quot;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment">// Set target version for OpenCL explicitly to suppress a compiler warning.</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#ifndef CL_TARGET_OPENCL_VERSION</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#define CL_TARGET_OPENCL_VERSION 120</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#include &lt;CL/cl.h&gt;</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;<a class="code" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API <a class="code" href="group__dnnl__api__ocl__interop.html#ga5cafdbf17fcfad7154d773994b4390f0">dnnl_ocl_interop_memory_create</a>(<a class="code" href="structdnnl__memory.html">dnnl_memory_t</a> *memory,</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keyword">const</span> <a class="code" href="structdnnl__memory__desc__t.html">dnnl_memory_desc_t</a> *memory_desc, <a class="code" href="structdnnl__engine.html">dnnl_engine_t</a> engine,</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; dnnl_ocl_interop_memory_kind_t memory_kind, <span class="keywordtype">void</span> *handle);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; </div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;<a class="code" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API <a class="code" href="group__dnnl__api__ocl__interop.html#gaa6c00a54ba3ca30d00d9e1c43e9b4bc2">dnnl_ocl_interop_memory_get_memory_kind</a>(</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <a class="code" href="structdnnl__memory.html">const_dnnl_memory_t</a> memory,</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; dnnl_ocl_interop_memory_kind_t *memory_kind);</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;<a class="code" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API <a class="code" href="group__dnnl__api__ocl__interop.html#ga383b09734d764bb45872b2c65f7dad70">dnnl_ocl_interop_memory_get_mem_object</a>(</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <a class="code" href="structdnnl__memory.html">const_dnnl_memory_t</a> memory, cl_mem *mem_object);</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; </div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;<a class="code" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API <a class="code" href="group__dnnl__api__ocl__interop.html#ga493946609c6bae83329241c4950edbce">dnnl_ocl_interop_memory_set_mem_object</a>(</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <a class="code" href="structdnnl__memory.html">dnnl_memory_t</a> memory, cl_mem mem_object);</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; </div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;<a class="code" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API <a class="code" href="group__dnnl__api__ocl__interop.html#ga52edd1810d72a2a08a881b122c7ada70">dnnl_ocl_interop_engine_create</a>(</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <a class="code" href="structdnnl__engine.html">dnnl_engine_t</a> *engine, cl_device_id device, cl_context context);</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; </div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;<a class="code" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API <a class="code" href="group__dnnl__api__ocl__interop.html#ga6be452e1d11ad63d1f20a072258547c8">dnnl_ocl_interop_engine_get_context</a>(</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; <a class="code" href="structdnnl__engine.html">dnnl_engine_t</a> engine, cl_context *context);</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; </div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;<a class="code" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API <a class="code" href="group__dnnl__api__ocl__interop.html#gafd0a653afb5a16d4d1fc71cd0615e44a">dnnl_ocl_interop_get_device</a>(</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; <a class="code" href="structdnnl__engine.html">dnnl_engine_t</a> engine, cl_device_id *device);</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; </div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;<a class="code" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API <a class="code" href="group__dnnl__api__ocl__interop.html#ga9a9007c6661472d701b2bbfb43ddf07c">dnnl_ocl_interop_stream_create</a>(</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; <a class="code" href="structdnnl__stream.html">dnnl_stream_t</a> *stream, <a class="code" href="structdnnl__engine.html">dnnl_engine_t</a> engine, cl_command_queue queue);</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; </div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160;<a class="code" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API <a class="code" href="group__dnnl__api__ocl__interop.html#ga0290e83f9217e83eba910454348c0819">dnnl_ocl_interop_stream_get_command_queue</a>(</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; <a class="code" href="structdnnl__stream.html">dnnl_stream_t</a> stream, cl_command_queue *queue);</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160; </div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; </div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160; </div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; </div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160;}</div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; </div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="agroup__dnnl__api__ocl__interop_html_ga493946609c6bae83329241c4950edbce"><div class="ttname"><a href="group__dnnl__api__ocl__interop.html#ga493946609c6bae83329241c4950edbce">dnnl_ocl_interop_memory_set_mem_object</a></div><div class="ttdeci">dnnl_status_t DNNL_API dnnl_ocl_interop_memory_set_mem_object(dnnl_memory_t memory, cl_mem mem_object)</div></div>
<div class="ttc" id="astructdnnl__memory_html"><div class="ttname"><a href="structdnnl__memory.html">dnnl_memory</a></div></div>
<div class="ttc" id="agroup__dnnl__api__utils_html_gad24f9ded06e34d3ee71e7fc4b408d57a"><div class="ttname"><a href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a></div><div class="ttdeci">dnnl_status_t</div><div class="ttdoc">Status values returned by the library functions.</div><div class="ttdef"><b>Definition:</b> dnnl_types.h:39</div></div>
<div class="ttc" id="astructdnnl__engine_html"><div class="ttname"><a href="structdnnl__engine.html">dnnl_engine</a></div><div class="ttdoc">An opaque structure to describe an engine.</div></div>
<div class="ttc" id="agroup__dnnl__api__ocl__interop_html_ga52edd1810d72a2a08a881b122c7ada70"><div class="ttname"><a href="group__dnnl__api__ocl__interop.html#ga52edd1810d72a2a08a881b122c7ada70">dnnl_ocl_interop_engine_create</a></div><div class="ttdeci">dnnl_status_t DNNL_API dnnl_ocl_interop_engine_create(dnnl_engine_t *engine, cl_device_id device, cl_context context)</div></div>
<div class="ttc" id="agroup__dnnl__api__ocl__interop_html_ga9a9007c6661472d701b2bbfb43ddf07c"><div class="ttname"><a href="group__dnnl__api__ocl__interop.html#ga9a9007c6661472d701b2bbfb43ddf07c">dnnl_ocl_interop_stream_create</a></div><div class="ttdeci">dnnl_status_t DNNL_API dnnl_ocl_interop_stream_create(dnnl_stream_t *stream, dnnl_engine_t engine, cl_command_queue queue)</div></div>
<div class="ttc" id="agroup__dnnl__api__ocl__interop_html_ga383b09734d764bb45872b2c65f7dad70"><div class="ttname"><a href="group__dnnl__api__ocl__interop.html#ga383b09734d764bb45872b2c65f7dad70">dnnl_ocl_interop_memory_get_mem_object</a></div><div class="ttdeci">dnnl_status_t DNNL_API dnnl_ocl_interop_memory_get_mem_object(const_dnnl_memory_t memory, cl_mem *mem_object)</div></div>
<div class="ttc" id="aoneapi_2dnnl_2dnnl_8h_html"><div class="ttname"><a href="oneapi_2dnnl_2dnnl_8h.html">dnnl.h</a></div></div>
<div class="ttc" id="agroup__dnnl__api__ocl__interop_html_ga0290e83f9217e83eba910454348c0819"><div class="ttname"><a href="group__dnnl__api__ocl__interop.html#ga0290e83f9217e83eba910454348c0819">dnnl_ocl_interop_stream_get_command_queue</a></div><div class="ttdeci">dnnl_status_t DNNL_API dnnl_ocl_interop_stream_get_command_queue(dnnl_stream_t stream, cl_command_queue *queue)</div></div>
<div class="ttc" id="agroup__dnnl__api__ocl__interop_html_ga5cafdbf17fcfad7154d773994b4390f0"><div class="ttname"><a href="group__dnnl__api__ocl__interop.html#ga5cafdbf17fcfad7154d773994b4390f0">dnnl_ocl_interop_memory_create</a></div><div class="ttdeci">dnnl_status_t DNNL_API dnnl_ocl_interop_memory_create(dnnl_memory_t *memory, const dnnl_memory_desc_t *memory_desc, dnnl_engine_t engine, dnnl_ocl_interop_memory_kind_t memory_kind, void *handle)</div></div>
<div class="ttc" id="agroup__dnnl__api__ocl__interop_html_ga6be452e1d11ad63d1f20a072258547c8"><div class="ttname"><a href="group__dnnl__api__ocl__interop.html#ga6be452e1d11ad63d1f20a072258547c8">dnnl_ocl_interop_engine_get_context</a></div><div class="ttdeci">dnnl_status_t DNNL_API dnnl_ocl_interop_engine_get_context(dnnl_engine_t engine, cl_context *context)</div></div>
<div class="ttc" id="agroup__dnnl__api__ocl__interop_html_gaa6c00a54ba3ca30d00d9e1c43e9b4bc2"><div class="ttname"><a href="group__dnnl__api__ocl__interop.html#gaa6c00a54ba3ca30d00d9e1c43e9b4bc2">dnnl_ocl_interop_memory_get_memory_kind</a></div><div class="ttdeci">dnnl_status_t DNNL_API dnnl_ocl_interop_memory_get_memory_kind(const_dnnl_memory_t memory, dnnl_ocl_interop_memory_kind_t *memory_kind)</div></div>
<div class="ttc" id="astructdnnl__memory__desc__t_html"><div class="ttname"><a href="structdnnl__memory__desc__t.html">dnnl_memory_desc_t</a></div><div class="ttdef"><b>Definition:</b> dnnl_types.h:1792</div></div>
<div class="ttc" id="astructdnnl__stream_html"><div class="ttname"><a href="structdnnl__stream.html">dnnl_stream</a></div></div>
<div class="ttc" id="agroup__dnnl__api__ocl__interop_html_gafd0a653afb5a16d4d1fc71cd0615e44a"><div class="ttname"><a href="group__dnnl__api__ocl__interop.html#gafd0a653afb5a16d4d1fc71cd0615e44a">dnnl_ocl_interop_get_device</a></div><div class="ttdeci">dnnl_status_t DNNL_API dnnl_ocl_interop_get_device(dnnl_engine_t engine, cl_device_id *device)</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 03:47:40 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>