blob: 411514254e328a580cae226fdc83e3fdd965eb78 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.6"/>
<title>mxnet: src/common/cuda_utils.h File Reference</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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">mxnet
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a></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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_fdedb0aba14d44ce9d99bc100e026e6a.html">common</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">cuda_utils.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>CUDA debugging utilities.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;dmlc/logging.h&gt;</code><br/>
<code>#include &lt;mshadow/base.h&gt;</code><br/>
<code>#include &lt;cuda_runtime.h&gt;</code><br/>
<code>#include &lt;cublas_v2.h&gt;</code><br/>
<code>#include &lt;curand.h&gt;</code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for cuda_utils.h:</div>
<div class="dyncontent">
<div class="center"><img src="cuda__utils_8h__incl.png" border="0" usemap="#src_2common_2cuda__utils_8h" alt=""/></div>
<map name="src_2common_2cuda__utils_8h" id="src_2common_2cuda__utils_8h">
</map>
</div>
</div>
<p><a href="cuda__utils_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacemxnet"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet.html">mxnet</a></td></tr>
<tr class="memdesc:namespacemxnet"><td class="mdescLeft">&#160;</td><td class="mdescRight">namespace of mxnet <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespacemxnet_1_1common"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1common.html">mxnet::common</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespacemxnet_1_1common_1_1cuda"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1common_1_1cuda.html">mxnet::common::cuda</a></td></tr>
<tr class="memdesc:namespacemxnet_1_1common_1_1cuda"><td class="mdescLeft">&#160;</td><td class="mdescRight">common utils for cuda <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:afc69a418242c5b851993bc2307b1c897"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cuda__utils_8h.html#afc69a418242c5b851993bc2307b1c897">CHECK_CUDA_ERROR</a>(msg)</td></tr>
<tr class="memdesc:afc69a418242c5b851993bc2307b1c897"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check CUDA error. <a href="#afc69a418242c5b851993bc2307b1c897">More...</a><br/></td></tr>
<tr class="separator:afc69a418242c5b851993bc2307b1c897"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a06cc7d24ca66505e69f5ad40009f5e8d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cuda__utils_8h.html#a06cc7d24ca66505e69f5ad40009f5e8d">CUDA_CALL</a>(func)</td></tr>
<tr class="memdesc:a06cc7d24ca66505e69f5ad40009f5e8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Protected CUDA call. <a href="#a06cc7d24ca66505e69f5ad40009f5e8d">More...</a><br/></td></tr>
<tr class="separator:a06cc7d24ca66505e69f5ad40009f5e8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a685d7ca3c9370ff471665abcacdeb381"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cuda__utils_8h.html#a685d7ca3c9370ff471665abcacdeb381">CUBLAS_CALL</a>(func)</td></tr>
<tr class="memdesc:a685d7ca3c9370ff471665abcacdeb381"><td class="mdescLeft">&#160;</td><td class="mdescRight">Protected cuBLAS call. <a href="#a685d7ca3c9370ff471665abcacdeb381">More...</a><br/></td></tr>
<tr class="separator:a685d7ca3c9370ff471665abcacdeb381"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82d7233550780a8c186e79c24aed8406"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cuda__utils_8h.html#a82d7233550780a8c186e79c24aed8406">CURAND_CALL</a>(func)</td></tr>
<tr class="memdesc:a82d7233550780a8c186e79c24aed8406"><td class="mdescLeft">&#160;</td><td class="mdescRight">Protected cuRAND call. <a href="#a82d7233550780a8c186e79c24aed8406">More...</a><br/></td></tr>
<tr class="separator:a82d7233550780a8c186e79c24aed8406"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a9feee613a4f16a954dd68e55345a72ac"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1common_1_1cuda.html#a9feee613a4f16a954dd68e55345a72ac">mxnet::common::cuda::CublasGetErrorString</a> (cublasStatus_t error)</td></tr>
<tr class="memdesc:a9feee613a4f16a954dd68e55345a72ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get string representation of cuBLAS errors. <a href="#a9feee613a4f16a954dd68e55345a72ac">More...</a><br/></td></tr>
<tr class="separator:a9feee613a4f16a954dd68e55345a72ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97c06b2f4d26445a7386b0f54fae1feb"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1common_1_1cuda.html#a97c06b2f4d26445a7386b0f54fae1feb">mxnet::common::cuda::CurandGetErrorString</a> (curandStatus_t status)</td></tr>
<tr class="memdesc:a97c06b2f4d26445a7386b0f54fae1feb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get string representation of cuRAND errors. <a href="#a97c06b2f4d26445a7386b0f54fae1feb">More...</a><br/></td></tr>
<tr class="separator:a97c06b2f4d26445a7386b0f54fae1feb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>CUDA debugging utilities. </p>
<p>Copyright (c) 2015 by Contributors </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="afc69a418242c5b851993bc2307b1c897"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CHECK_CUDA_ERROR</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">msg</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">{ \</div>
<div class="line"> cudaError_t e = cudaGetLastError(); \</div>
<div class="line"> CHECK_EQ(e, cudaSuccess) &lt;&lt; (msg) &lt;&lt; <span class="stringliteral">&quot; CUDA: &quot;</span> &lt;&lt; cudaGetErrorString(e); \</div>
<div class="line"> }</div>
</div><!-- fragment -->
<p>Check CUDA error. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msg</td><td>Message to print if an error occured. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a685d7ca3c9370ff471665abcacdeb381"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CUBLAS_CALL</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">func</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">{ \</div>
<div class="line"> cublasStatus_t e = (func); \</div>
<div class="line"> CHECK_EQ(e, CUBLAS_STATUS_SUCCESS) \</div>
<div class="line"> &lt;&lt; <span class="stringliteral">&quot;cuBLAS: &quot;</span> &lt;&lt; <a class="code" href="namespacemxnet_1_1common_1_1cuda.html#a9feee613a4f16a954dd68e55345a72ac">common::cuda::CublasGetErrorString</a>(e); \</div>
<div class="line"> }</div>
<div class="ttc" id="namespacemxnet_1_1common_1_1cuda_html_a9feee613a4f16a954dd68e55345a72ac"><div class="ttname"><a href="namespacemxnet_1_1common_1_1cuda.html#a9feee613a4f16a954dd68e55345a72ac">mxnet::common::cuda::CublasGetErrorString</a></div><div class="ttdeci">const char * CublasGetErrorString(cublasStatus_t error)</div><div class="ttdoc">Get string representation of cuBLAS errors. </div><div class="ttdef"><b>Definition:</b> cuda_utils.h:44</div></div>
</div><!-- fragment -->
<p>Protected cuBLAS call. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">func</td><td>Expression to call.</td></tr>
</table>
</dd>
</dl>
<p>It checks for cuBLAS errors after invocation of the expression. </p>
</div>
</div>
<a class="anchor" id="a06cc7d24ca66505e69f5ad40009f5e8d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CUDA_CALL</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">func</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">{ \</div>
<div class="line"> cudaError_t e = (func); \</div>
<div class="line"> CHECK(e == cudaSuccess || e == cudaErrorCudartUnloading) \</div>
<div class="line"> &lt;&lt; <span class="stringliteral">&quot;CUDA: &quot;</span> &lt;&lt; cudaGetErrorString(e); \</div>
<div class="line"> }</div>
</div><!-- fragment -->
<p>Protected CUDA call. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">func</td><td>Expression to call.</td></tr>
</table>
</dd>
</dl>
<p>It checks for CUDA errors after invocation of the expression. </p>
</div>
</div>
<a class="anchor" id="a82d7233550780a8c186e79c24aed8406"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CURAND_CALL</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">func</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">{ \</div>
<div class="line"> curandStatus_t e = (func); \</div>
<div class="line"> CHECK_EQ(e, CURAND_STATUS_SUCCESS) \</div>
<div class="line"> &lt;&lt; <span class="stringliteral">&quot;cuRAND: &quot;</span> &lt;&lt; <a class="code" href="namespacemxnet_1_1common_1_1cuda.html#a97c06b2f4d26445a7386b0f54fae1feb">common::cuda::CurandGetErrorString</a>(e); \</div>
<div class="line"> }</div>
<div class="ttc" id="namespacemxnet_1_1common_1_1cuda_html_a97c06b2f4d26445a7386b0f54fae1feb"><div class="ttname"><a href="namespacemxnet_1_1common_1_1cuda.html#a97c06b2f4d26445a7386b0f54fae1feb">mxnet::common::cuda::CurandGetErrorString</a></div><div class="ttdeci">const char * CurandGetErrorString(curandStatus_t status)</div><div class="ttdoc">Get string representation of cuRAND errors. </div><div class="ttdef"><b>Definition:</b> cuda_utils.h:75</div></div>
</div><!-- fragment -->
<p>Protected cuRAND call. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">func</td><td>Expression to call.</td></tr>
</table>
</dd>
</dl>
<p>It checks for cuRAND errors after invocation of the expression. </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Aug 6 2017 07:14:31 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>