Skip to content

Commit

Permalink
generate documentation html
Browse files Browse the repository at this point in the history
  • Loading branch information
@pvelesko
pvelesko committed Dec 23, 2021
1 parent 584b688 commit d595171
Show file tree
Hide file tree
Showing 319 changed files with 32,536 additions and 74 deletions.
Binary file modified .DS_Store
View file
Binary file not shown.
Binary file modified docs/.DS_Store
View file
Binary file not shown.
173 changes: 173 additions & 0 deletions docs/html/_c_h_i_p_backend_8hh.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,173 @@
<!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=11"/>
<meta name="generator" content="Doxygen 1.9.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>CHIP-SPV: /Users/pvelesko/local/CHIP-SPV/src/CHIPBackend.hh 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/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">CHIP-SPV<span id="projectnumber">&#160;0.1.0</span>
</div>
<div id="projectbrief">Multiple backend interface for HIP</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">CHIPBackend.hh File Reference</div></div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="class_c_h_i_p_backend.html" title="Primary object to interact with the backend.">CHIPBackend</a> class definition. CHIP backends are to inherit from this base class and override desired virtual functions. Overrides for this class are expected to be minimal with primary overrides being done on lower-level classes such as <a class="el" href="class_c_h_i_p_context.html" title="Context class Contexts contain execution queues and are created on top of a single or multiple device...">CHIPContext</a> consturctors, etc.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;algorithm&gt;</code><br />
<code>#include &lt;iostream&gt;</code><br />
<code>#include &lt;map&gt;</code><br />
<code>#include &lt;set&gt;</code><br />
<code>#include &lt;mutex&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &lt;vector&gt;</code><br />
<code>#include &lt;stack&gt;</code><br />
<code>#include &quot;spirv.hh&quot;</code><br />
<code>#include &quot;hip/hip_runtime_api.h&quot;</code><br />
<code>#include &quot;hip/spirv_hip.hh&quot;</code><br />
<code>#include &quot;<a class="el" href="_c_h_i_p_driver_8hh_source.html">CHIPDriver.hh</a>&quot;</code><br />
<code>#include &quot;logging.hh&quot;</code><br />
<code>#include &quot;macros.hh&quot;</code><br />
<code>#include &quot;CHIPException.hh&quot;</code><br />
</div>
<p><a href="_c_h_i_p_backend_8hh_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 id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_h_i_p_callback_data.html">CHIPCallbackData</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_h_i_p_event_monitor.html">CHIPEventMonitor</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_h_i_p_texture.html">CHIPTexture</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structallocation__info.html">allocation_info</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_h_i_p_allocation_tracker.html">CHIPAllocationTracker</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class for keeping track of device allocations. <a href="class_c_h_i_p_allocation_tracker.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_h_i_p_device_var.html">CHIPDeviceVar</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_h_i_p_event.html">CHIPEvent</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_h_i_p_module.html">CHIPModule</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Module abstraction. Contains global variables and kernels. Can be extracted from FatBinary or loaded at runtime. OpenCL - ClProgram Level Zero - zeModule ROCclr - amd::Program CUDA - CUmodule. <a href="class_c_h_i_p_module.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_h_i_p_kernel.html">CHIPKernel</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains information about the function on the host and device. <a href="class_c_h_i_p_kernel.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_h_i_p_exec_item.html">CHIPExecItem</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains kernel arguments and a queue on which to execute. Prior to kernel launch, the arguments are setup via <a class="el" href="class_c_h_i_p_backend.html#a9d802a4ed8ee1c36996ea05d346bdb1d" title="Configure an upcoming kernel call.">CHIPBackend::configureCall()</a>. Because of this, we get the kernel last so the kernel so the launch() takes a kernel argument as opposed to queue receiving a <a class="el" href="class_c_h_i_p_exec_item.html" title="Contains kernel arguments and a queue on which to execute. Prior to kernel launch,...">CHIPExecItem</a> containing the kernel and arguments. <a href="class_c_h_i_p_exec_item.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_h_i_p_device.html">CHIPDevice</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute device class. <a href="class_c_h_i_p_device.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_h_i_p_context.html">CHIPContext</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Context class Contexts contain execution queues and are created on top of a single or multiple devices. Provides for creation of additional queues, events, and interaction with devices. <a href="class_c_h_i_p_context.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_h_i_p_backend.html">CHIPBackend</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Primary object to interact with the backend. <a href="class_c_h_i_p_backend.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_h_i_p_queue.html">CHIPQueue</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Queue class for submitting kernels to for execution. <a href="class_c_h_i_p_queue.html#details">More...</a><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 id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:af3e4e883ce4d2e56e3be2b4e2e774aa9"><td class="memItemLeft" align="right" valign="top"><a id="af3e4e883ce4d2e56e3be2b4e2e774aa9" name="af3e4e883ce4d2e56e3be2b4e2e774aa9"></a>enum class &#160;</td><td class="memItemRight" valign="bottom"><b>CHIPMemoryType</b> : unsigned { <b>Host</b> = 0
, <b>Device</b> = 1
, <b>Shared</b> = 2
}</td></tr>
<tr class="separator:af3e4e883ce4d2e56e3be2b4e2e774aa9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a433b3bd8236b2b473f2a73e3b1fe6c"><td class="memItemLeft" align="right" valign="top"><a id="a5a433b3bd8236b2b473f2a73e3b1fe6c" name="a5a433b3bd8236b2b473f2a73e3b1fe6c"></a>enum class &#160;</td><td class="memItemRight" valign="bottom"><b>CHIPEventType</b> : unsigned { <b>Default</b> = hipEventDefault
, <b>BlockingSync</b> = hipEventBlockingSync
, <b>DisableTiming</b> = hipEventDisableTiming
, <b>Interprocess</b> = hipEventInterprocess
}</td></tr>
<tr class="separator:a5a433b3bd8236b2b473f2a73e3b1fe6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ad699516f65dc92809e7d82791b6e0c02"><td class="memItemLeft" align="right" valign="top"><a id="ad699516f65dc92809e7d82791b6e0c02" name="ad699516f65dc92809e7d82791b6e0c02"></a>
void *&#160;</td><td class="memItemRight" valign="bottom"><b>monitor_wrapper</b> (void *event_monitor_)</td></tr>
<tr class="separator:ad699516f65dc92809e7d82791b6e0c02"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abd250241a724b134aa19aec8c48760d6"><td class="memTemplParams" colspan="2"><a id="abd250241a724b134aa19aec8c48760d6" name="abd250241a724b134aa19aec8c48760d6"></a>
template&lt;class T &gt; </td></tr>
<tr class="memitem:abd250241a724b134aa19aec8c48760d6"><td class="memTemplItemLeft" align="right" valign="top">std::string&#160;</td><td class="memTemplItemRight" valign="bottom"><b>resultToString</b> (T err)</td></tr>
<tr class="separator:abd250241a724b134aa19aec8c48760d6"><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 ><a class="el" href="class_c_h_i_p_backend.html" title="Primary object to interact with the backend.">CHIPBackend</a> class definition. CHIP backends are to inherit from this base class and override desired virtual functions. Overrides for this class are expected to be minimal with primary overrides being done on lower-level classes such as <a class="el" href="class_c_h_i_p_context.html" title="Context class Contexts contain execution queues and are created on top of a single or multiple device...">CHIPContext</a> consturctors, etc. </p>
<dl class="section author"><dt>Author</dt><dd>Paulius Velesko (<a href="#" onclick="location.href='mai'+'lto:'+'pve'+'le'+'sko'+'@g'+'mai'+'l.'+'com'; return false;">pvele<span style="display: none;">.nosp@m.</span>sko@<span style="display: none;">.nosp@m.</span>gmail<span style="display: none;">.nosp@m.</span>.com</a>) </dd></dl>
<dl class="section version"><dt>Version</dt><dd>0.1 </dd></dl>
<dl class="section date"><dt>Date</dt><dd>2021-08-19</dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (c) 2021 </dd></dl>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.2
</small></address>
</body>
</html>
Loading

0 comments on commit d595171

Please sign in to comment.