blob: b0d666c8ae6efdf11bb4c9afae522edb58fc679e [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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Apache Singa: singa::Device Class 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/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">Apache Singa
</div>
<div id="projectbrief">A General Distributed Deep Learning Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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="namespacesinga.html">singa</a></li><li class="navelem"><a class="el" href="classsinga_1_1Device.html">Device</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classsinga_1_1Device-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">singa::Device Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Allocate memory and execute <a class="el" href="classsinga_1_1Tensor.html" title="A Tensor instance is a multi-dimensional array resident on a Device (default device is the host CPU)...">Tensor</a> operations.
<a href="classsinga_1_1Device.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="device_8h_source.html">device.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for singa::Device:</div>
<div class="dyncontent">
<div class="center"><img src="classsinga_1_1Device__inherit__graph.png" border="0" usemap="#singa_1_1Device_inherit__map" alt="Inheritance graph"/></div>
<!-- MAP 0 -->
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for singa::Device:</div>
<div class="dyncontent">
<div class="center"><img src="classsinga_1_1Device__coll__graph.png" border="0" usemap="#singa_1_1Device_coll__map" alt="Collaboration graph"/></div>
<!-- MAP 1 -->
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a6f74eb06d4d5df8ac6ea542a49cd28ce"><td class="memItemLeft" align="right" valign="top"><a id="a6f74eb06d4d5df8ac6ea542a49cd28ce"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Device.html#a6f74eb06d4d5df8ac6ea542a49cd28ce">Device</a> (int id, int num_executors)</td></tr>
<tr class="memdesc:a6f74eb06d4d5df8ac6ea542a49cd28ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor with device ID, num of executors (e.g., cuda streams), max mem size to use (in MB) <br /></td></tr>
<tr class="separator:a6f74eb06d4d5df8ac6ea542a49cd28ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae384fe27027a200a22cd22aa4d38b40a"><td class="memItemLeft" align="right" valign="top"><a id="ae384fe27027a200a22cd22aa4d38b40a"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>SetRandSeed</b> (unsigned seed)=0</td></tr>
<tr class="separator:ae384fe27027a200a22cd22aa4d38b40a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acdcaf51aa6aa3cd574531b309688dd99"><td class="memItemLeft" align="right" valign="top"><a id="acdcaf51aa6aa3cd574531b309688dd99"></a>
<a class="el" href="classsinga_1_1Block.html">Block</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Device.html#acdcaf51aa6aa3cd574531b309688dd99">NewBlock</a> (int size)</td></tr>
<tr class="memdesc:acdcaf51aa6aa3cd574531b309688dd99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called by <a class="el" href="classsinga_1_1Tensor.html" title="A Tensor instance is a multi-dimensional array resident on a Device (default device is the host CPU)...">Tensor</a>. <br /></td></tr>
<tr class="separator:acdcaf51aa6aa3cd574531b309688dd99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2a3aaebf33c373739fcf77124332bfc"><td class="memItemLeft" align="right" valign="top"><a id="ad2a3aaebf33c373739fcf77124332bfc"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Device.html#ad2a3aaebf33c373739fcf77124332bfc">FreeBlock</a> (<a class="el" href="classsinga_1_1Block.html">Block</a> *block)</td></tr>
<tr class="memdesc:ad2a3aaebf33c373739fcf77124332bfc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called by <a class="el" href="classsinga_1_1Tensor.html" title="A Tensor instance is a multi-dimensional array resident on a Device (default device is the host CPU)...">Tensor</a>. <br /></td></tr>
<tr class="separator:ad2a3aaebf33c373739fcf77124332bfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf3169a7059287389466a408f9d68dc1"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Device.html#acf3169a7059287389466a408f9d68dc1">GetAllocatedMem</a> ()</td></tr>
<tr class="memdesc:acf3169a7059287389466a408f9d68dc1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the size (bytes) of memory in use TODO(wangwei) override this function for all devices. <a href="#acf3169a7059287389466a408f9d68dc1">More...</a><br /></td></tr>
<tr class="separator:acf3169a7059287389466a408f9d68dc1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84f17d9301ae2ad082322cdc0ad265f7"><td class="memItemLeft" align="right" valign="top"><a id="a84f17d9301ae2ad082322cdc0ad265f7"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Device.html#a84f17d9301ae2ad082322cdc0ad265f7">CopyDataToFrom</a> (<a class="el" href="classsinga_1_1Block.html">Block</a> *dst, <a class="el" href="classsinga_1_1Block.html">Block</a> *src, size_t nBytes, CopyDirection direction, int dst_offset, int src_offset)</td></tr>
<tr class="memdesc:a84f17d9301ae2ad082322cdc0ad265f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy data within or across devices. <br /></td></tr>
<tr class="separator:a84f17d9301ae2ad082322cdc0ad265f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0245c7145d9ea642e071178aabffb10"><td class="memItemLeft" align="right" valign="top"><a id="ad0245c7145d9ea642e071178aabffb10"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>CopyDataFromHostPtr</b> (<a class="el" href="classsinga_1_1Block.html">Block</a> *dst, const void *src, size_t nBytes, size_t dst_offset=0)</td></tr>
<tr class="separator:ad0245c7145d9ea642e071178aabffb10"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13db259bad7b0b92ffeb7f661dcd9144"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Device.html#a13db259bad7b0b92ffeb7f661dcd9144">Exec</a> (function&lt; void(<a class="el" href="structsinga_1_1__Context.html">Context</a> *)&gt; &amp;&amp;fn, const vector&lt; <a class="el" href="classsinga_1_1Block.html">Block</a> *&gt; read_blocks, const vector&lt; <a class="el" href="classsinga_1_1Block.html">Block</a> *&gt; write_blocks, bool use_rand_generator=false)</td></tr>
<tr class="memdesc:a13db259bad7b0b92ffeb7f661dcd9144"><td class="mdescLeft">&#160;</td><td class="mdescRight">Submit the operation to the device, which may execute it right now or delay it depending on the scheduler. <a href="#a13db259bad7b0b92ffeb7f661dcd9144">More...</a><br /></td></tr>
<tr class="separator:a13db259bad7b0b92ffeb7f661dcd9144"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61744e09ab97eeeb8b822bd9adc930db"><td class="memItemLeft" align="right" valign="top"><a id="a61744e09ab97eeeb8b822bd9adc930db"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Device.html#a61744e09ab97eeeb8b822bd9adc930db">Sync</a> ()</td></tr>
<tr class="memdesc:a61744e09ab97eeeb8b822bd9adc930db"><td class="mdescLeft">&#160;</td><td class="mdescRight">wait for all operations submitted to this device. <br /></td></tr>
<tr class="separator:a61744e09ab97eeeb8b822bd9adc930db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6db2e92a308783e243eed58bc106edb9"><td class="memItemLeft" align="right" valign="top"><a id="a6db2e92a308783e243eed58bc106edb9"></a>
LangType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Device.html#a6db2e92a308783e243eed58bc106edb9">lang</a> () const</td></tr>
<tr class="memdesc:a6db2e92a308783e243eed58bc106edb9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the programming language for this device. <br /></td></tr>
<tr class="separator:a6db2e92a308783e243eed58bc106edb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9997f53f73b276a33c1933007a70b594"><td class="memItemLeft" align="right" valign="top"><a id="a9997f53f73b276a33c1933007a70b594"></a>
virtual std::shared_ptr&lt; <a class="el" href="classsinga_1_1Device.html">Device</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>host</b> () const</td></tr>
<tr class="separator:a9997f53f73b276a33c1933007a70b594"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afdfbec14803559287bf443d0cf66caf1"><td class="memItemLeft" align="right" valign="top"><a id="afdfbec14803559287bf443d0cf66caf1"></a>
<a class="el" href="structsinga_1_1__Context.html">Context</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>context</b> (int k)</td></tr>
<tr class="separator:afdfbec14803559287bf443d0cf66caf1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aab575f6e99426ed98ae9563a047e6ae5"><td class="memItemLeft" align="right" valign="top"><a id="aab575f6e99426ed98ae9563a047e6ae5"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>id</b> () const</td></tr>
<tr class="separator:aab575f6e99426ed98ae9563a047e6ae5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:acd15581a3f7e5c9cf5f5d7502f163c81"><td class="memItemLeft" align="right" valign="top"><a id="acd15581a3f7e5c9cf5f5d7502f163c81"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Device.html#acd15581a3f7e5c9cf5f5d7502f163c81">DoExec</a> (function&lt; void(<a class="el" href="structsinga_1_1__Context.html">Context</a> *)&gt; &amp;&amp;fn, int executor)=0</td></tr>
<tr class="memdesc:acd15581a3f7e5c9cf5f5d7502f163c81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute one operation on one executor. <br /></td></tr>
<tr class="separator:acd15581a3f7e5c9cf5f5d7502f163c81"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa65e5c7f4692fce8a6352407b6fa75ed"><td class="memItemLeft" align="right" valign="top"><a id="aa65e5c7f4692fce8a6352407b6fa75ed"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>CopyToFrom</b> (void *dst, const void *src, size_t nBytes, CopyDirection direction, <a class="el" href="structsinga_1_1__Context.html">Context</a> *ctx)=0</td></tr>
<tr class="separator:aa65e5c7f4692fce8a6352407b6fa75ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af0bcace0d0f33db28b7a49300a2aedf3"><td class="memItemLeft" align="right" valign="top"><a id="af0bcace0d0f33db28b7a49300a2aedf3"></a>
virtual void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Device.html#af0bcace0d0f33db28b7a49300a2aedf3">Malloc</a> (int size)=0</td></tr>
<tr class="memdesc:af0bcace0d0f33db28b7a49300a2aedf3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate device memory. <br /></td></tr>
<tr class="separator:af0bcace0d0f33db28b7a49300a2aedf3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0795c72763fe4097355b870e6b95b8c3"><td class="memItemLeft" align="right" valign="top"><a id="a0795c72763fe4097355b870e6b95b8c3"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Device.html#a0795c72763fe4097355b870e6b95b8c3">Free</a> (void *ptr)=0</td></tr>
<tr class="memdesc:a0795c72763fe4097355b870e6b95b8c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free device memory. <br /></td></tr>
<tr class="separator:a0795c72763fe4097355b870e6b95b8c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a13eec194e2950564a617e2a90117f4d4"><td class="memItemLeft" align="right" valign="top"><a id="a13eec194e2950564a617e2a90117f4d4"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>id_</b> = 0</td></tr>
<tr class="separator:a13eec194e2950564a617e2a90117f4d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab5e132c43017d391300a13363a008e48"><td class="memItemLeft" align="right" valign="top"><a id="ab5e132c43017d391300a13363a008e48"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>num_executors_</b> = 0</td></tr>
<tr class="separator:ab5e132c43017d391300a13363a008e48"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2919065d27373e4b6234a244760f151c"><td class="memItemLeft" align="right" valign="top"><a id="a2919065d27373e4b6234a244760f151c"></a>
unsigned&#160;</td><td class="memItemRight" valign="bottom"><b>seed_</b> = 0</td></tr>
<tr class="separator:a2919065d27373e4b6234a244760f151c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6401c02a3f4a96994f37ed3312cacb45"><td class="memItemLeft" align="right" valign="top"><a id="a6401c02a3f4a96994f37ed3312cacb45"></a>
LangType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Device.html#a6401c02a3f4a96994f37ed3312cacb45">lang_</a></td></tr>
<tr class="memdesc:a6401c02a3f4a96994f37ed3312cacb45"><td class="mdescLeft">&#160;</td><td class="mdescRight">Programming language type, could be kCpp, kCuda, kOpencl. <br /></td></tr>
<tr class="separator:a6401c02a3f4a96994f37ed3312cacb45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d27f7538aabe42e9eea3f10cf702148"><td class="memItemLeft" align="right" valign="top"><a id="a3d27f7538aabe42e9eea3f10cf702148"></a>
std::shared_ptr&lt; <a class="el" href="classsinga_1_1Device.html">Device</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsinga_1_1Device.html#a3d27f7538aabe42e9eea3f10cf702148">host_</a></td></tr>
<tr class="memdesc:a3d27f7538aabe42e9eea3f10cf702148"><td class="mdescLeft">&#160;</td><td class="mdescRight">The host device. <br /></td></tr>
<tr class="separator:a3d27f7538aabe42e9eea3f10cf702148"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1bdf617ae8f45c24cfabf32e66c82fc"><td class="memItemLeft" align="right" valign="top"><a id="af1bdf617ae8f45c24cfabf32e66c82fc"></a>
<a class="el" href="structsinga_1_1__Context.html">Context</a>&#160;</td><td class="memItemRight" valign="bottom"><b>ctx_</b></td></tr>
<tr class="separator:af1bdf617ae8f45c24cfabf32e66c82fc"><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>Allocate memory and execute <a class="el" href="classsinga_1_1Tensor.html" title="A Tensor instance is a multi-dimensional array resident on a Device (default device is the host CPU)...">Tensor</a> operations. </p>
<p>There are three types of devices distinguished by their programming languages, namely cpp, cuda and opencl. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a13db259bad7b0b92ffeb7f661dcd9144"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a13db259bad7b0b92ffeb7f661dcd9144">&#9670;&nbsp;</a></span>Exec()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void singa::Device::Exec </td>
<td>(</td>
<td class="paramtype">function&lt; void(<a class="el" href="structsinga_1_1__Context.html">Context</a> *)&gt; &amp;&amp;&#160;</td>
<td class="paramname"><em>fn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const vector&lt; <a class="el" href="classsinga_1_1Block.html">Block</a> *&gt;&#160;</td>
<td class="paramname"><em>read_blocks</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const vector&lt; <a class="el" href="classsinga_1_1Block.html">Block</a> *&gt;&#160;</td>
<td class="paramname"><em>write_blocks</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>use_rand_generator</em> = <code>false</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Submit the operation to the device, which may execute it right now or delay it depending on the scheduler. </p>
</div>
</div>
<a id="acf3169a7059287389466a408f9d68dc1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf3169a7059287389466a408f9d68dc1">&#9670;&nbsp;</a></span>GetAllocatedMem()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t singa::Device::GetAllocatedMem </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the size (bytes) of memory in use TODO(wangwei) override this function for all devices. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/home/moaz/incubator-singa/include/singa/core/<a class="el" href="device_8h_source.html">device.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Apr 22 2019 12:27:05 for Apache Singa by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>