Files
rocm-systems/docs/RuntimeAPI/html/group__Context.html
T
Maneesh Gupta f052f43b3b Updated doxygen documentation
Change-Id: If04d1155173fba8d3e050f3259da8b3edc60e076
2016-12-19 04:04:06 +00:00

608 خطوط
64 KiB
HTML

<!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>HIP: Heterogenous-computing Interface for Portability: Management</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">HIP: Heterogenous-computing Interface for Portability
</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="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><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><!-- top -->
<!-- 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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</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 class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Management<div class="ingroups"><a class="el" href="group__Driver.html">Initialization and Version</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gab6dbcff5c5b1249a5ac5cf39ae9d08bc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Context.html#gab6dbcff5c5b1249a5ac5cf39ae9d08bc">hipCtxCreate</a> (<a class="el" href="classihipCtx__t.html">hipCtx_t</a> *ctx, unsigned int flags, <a class="el" href="classihipDevice__t.html">hipDevice_t</a> device)</td></tr>
<tr class="memdesc:gab6dbcff5c5b1249a5ac5cf39ae9d08bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a context and set it as current/ default context. <a href="#gab6dbcff5c5b1249a5ac5cf39ae9d08bc">More...</a><br/></td></tr>
<tr class="separator:gab6dbcff5c5b1249a5ac5cf39ae9d08bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9a65fe43238ef303a6d97826c05fd14e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Context.html#ga9a65fe43238ef303a6d97826c05fd14e">hipCtxDestroy</a> (<a class="el" href="classihipCtx__t.html">hipCtx_t</a> ctx)</td></tr>
<tr class="memdesc:ga9a65fe43238ef303a6d97826c05fd14e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy a HIP context. <a href="#ga9a65fe43238ef303a6d97826c05fd14e">More...</a><br/></td></tr>
<tr class="separator:ga9a65fe43238ef303a6d97826c05fd14e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2cc4ea5a6b78d9d7990a88a7863467d4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Context.html#ga2cc4ea5a6b78d9d7990a88a7863467d4">hipCtxPopCurrent</a> (<a class="el" href="classihipCtx__t.html">hipCtx_t</a> *ctx)</td></tr>
<tr class="memdesc:ga2cc4ea5a6b78d9d7990a88a7863467d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pop the current/default context and return the popped context. <a href="#ga2cc4ea5a6b78d9d7990a88a7863467d4">More...</a><br/></td></tr>
<tr class="separator:ga2cc4ea5a6b78d9d7990a88a7863467d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9c9d92f29d68cacdea4c062c97e50a8a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Context.html#ga9c9d92f29d68cacdea4c062c97e50a8a">hipCtxPushCurrent</a> (<a class="el" href="classihipCtx__t.html">hipCtx_t</a> ctx)</td></tr>
<tr class="memdesc:ga9c9d92f29d68cacdea4c062c97e50a8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Push the context to be set as current/ default context. <a href="#ga9c9d92f29d68cacdea4c062c97e50a8a">More...</a><br/></td></tr>
<tr class="separator:ga9c9d92f29d68cacdea4c062c97e50a8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga834a192f70c2bfc0269c309436776feb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Context.html#ga834a192f70c2bfc0269c309436776feb">hipCtxSetCurrent</a> (<a class="el" href="classihipCtx__t.html">hipCtx_t</a> ctx)</td></tr>
<tr class="memdesc:ga834a192f70c2bfc0269c309436776feb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the passed context as current/default. <a href="#ga834a192f70c2bfc0269c309436776feb">More...</a><br/></td></tr>
<tr class="separator:ga834a192f70c2bfc0269c309436776feb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga741786101d348fdbfa1f64546860357a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Context.html#ga741786101d348fdbfa1f64546860357a">hipCtxGetCurrent</a> (<a class="el" href="classihipCtx__t.html">hipCtx_t</a> *ctx)</td></tr>
<tr class="memdesc:ga741786101d348fdbfa1f64546860357a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the handle of the current/ default context. <a href="#ga741786101d348fdbfa1f64546860357a">More...</a><br/></td></tr>
<tr class="separator:ga741786101d348fdbfa1f64546860357a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8aa32cf64272da929f23ecbafefefcee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Context.html#ga8aa32cf64272da929f23ecbafefefcee">hipCtxGetDevice</a> (<a class="el" href="classihipDevice__t.html">hipDevice_t</a> *device)</td></tr>
<tr class="memdesc:ga8aa32cf64272da929f23ecbafefefcee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the handle of the device associated with current/default context. <a href="#ga8aa32cf64272da929f23ecbafefefcee">More...</a><br/></td></tr>
<tr class="separator:ga8aa32cf64272da929f23ecbafefefcee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabe5941e6798c71a8351b7d51311e7e8f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Context.html#gabe5941e6798c71a8351b7d51311e7e8f">hipCtxGetApiVersion</a> (<a class="el" href="classihipCtx__t.html">hipCtx_t</a> ctx, int *apiVersion)</td></tr>
<tr class="memdesc:gabe5941e6798c71a8351b7d51311e7e8f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the approximate HIP api version. <a href="#gabe5941e6798c71a8351b7d51311e7e8f">More...</a><br/></td></tr>
<tr class="separator:gabe5941e6798c71a8351b7d51311e7e8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab10373068faafd3042c9003e2e6d905a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Context.html#gab10373068faafd3042c9003e2e6d905a">hipCtxGetCacheConfig</a> (<a class="el" href="group__GlobalDefs.html#ga86e5c5692645963a9a673e1aa88ba6ca">hipFuncCache_t</a> *cacheConfig)</td></tr>
<tr class="memdesc:gab10373068faafd3042c9003e2e6d905a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set Cache configuration for a specific function. <a href="#gab10373068faafd3042c9003e2e6d905a">More...</a><br/></td></tr>
<tr class="separator:gab10373068faafd3042c9003e2e6d905a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7eacc656f1d1b6f5a683bea31be67a2f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Context.html#ga7eacc656f1d1b6f5a683bea31be67a2f">hipCtxSetCacheConfig</a> (<a class="el" href="group__GlobalDefs.html#ga86e5c5692645963a9a673e1aa88ba6ca">hipFuncCache_t</a> cacheConfig)</td></tr>
<tr class="memdesc:ga7eacc656f1d1b6f5a683bea31be67a2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set L1/Shared cache partition. <a href="#ga7eacc656f1d1b6f5a683bea31be67a2f">More...</a><br/></td></tr>
<tr class="separator:ga7eacc656f1d1b6f5a683bea31be67a2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad5c1d4ced27f584a74ed550dd002fa5a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Context.html#gad5c1d4ced27f584a74ed550dd002fa5a">hipCtxSetSharedMemConfig</a> (<a class="el" href="group__GlobalDefs.html#ga2e17b71d94ac350f2ccd914fd49d104e">hipSharedMemConfig</a> config)</td></tr>
<tr class="memdesc:gad5c1d4ced27f584a74ed550dd002fa5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set Shared memory bank configuration. <a href="#gad5c1d4ced27f584a74ed550dd002fa5a">More...</a><br/></td></tr>
<tr class="separator:gad5c1d4ced27f584a74ed550dd002fa5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3c78b22dd03435a7ca88621a45409565"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Context.html#ga3c78b22dd03435a7ca88621a45409565">hipCtxGetSharedMemConfig</a> (<a class="el" href="group__GlobalDefs.html#ga2e17b71d94ac350f2ccd914fd49d104e">hipSharedMemConfig</a> *pConfig)</td></tr>
<tr class="memdesc:ga3c78b22dd03435a7ca88621a45409565"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get Shared memory bank configuration. <a href="#ga3c78b22dd03435a7ca88621a45409565">More...</a><br/></td></tr>
<tr class="separator:ga3c78b22dd03435a7ca88621a45409565"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad45cd968e8e3dcfd24ef050cab2f41c8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Context.html#gad45cd968e8e3dcfd24ef050cab2f41c8">hipCtxSynchronize</a> (void)</td></tr>
<tr class="memdesc:gad45cd968e8e3dcfd24ef050cab2f41c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Blocks until the default context has completed all preceding requested tasks. <a href="#gad45cd968e8e3dcfd24ef050cab2f41c8">More...</a><br/></td></tr>
<tr class="separator:gad45cd968e8e3dcfd24ef050cab2f41c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga12a7a993e10f775fbf61a0b14288ed1b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Context.html#ga12a7a993e10f775fbf61a0b14288ed1b">hipCtxGetFlags</a> (unsigned int *flags)</td></tr>
<tr class="memdesc:ga12a7a993e10f775fbf61a0b14288ed1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return flags used for creating default context. <a href="#ga12a7a993e10f775fbf61a0b14288ed1b">More...</a><br/></td></tr>
<tr class="separator:ga12a7a993e10f775fbf61a0b14288ed1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga834dfd99d72082fe8770142fa30b30e2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Context.html#ga834dfd99d72082fe8770142fa30b30e2">hipCtxEnablePeerAccess</a> (<a class="el" href="classihipCtx__t.html">hipCtx_t</a> peerCtx, unsigned int flags)</td></tr>
<tr class="memdesc:ga834dfd99d72082fe8770142fa30b30e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables direct access to memory allocations in a peer context. <a href="#ga834dfd99d72082fe8770142fa30b30e2">More...</a><br/></td></tr>
<tr class="separator:ga834dfd99d72082fe8770142fa30b30e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf48e4e9c3b6bbad5deaeff10d2e28b31"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Context.html#gaf48e4e9c3b6bbad5deaeff10d2e28b31">hipCtxDisablePeerAccess</a> (<a class="el" href="classihipCtx__t.html">hipCtx_t</a> peerCtx)</td></tr>
<tr class="memdesc:gaf48e4e9c3b6bbad5deaeff10d2e28b31"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable direct access from current context's virtual address space to memory allocations physically located on a peer context.Disables direct access to memory allocations in a peer context and unregisters any registered allocations. <a href="#gaf48e4e9c3b6bbad5deaeff10d2e28b31">More...</a><br/></td></tr>
<tr class="separator:gaf48e4e9c3b6bbad5deaeff10d2e28b31"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2>----------------------------------------------------------------------------------------------&mdash; </h2>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gab6dbcff5c5b1249a5ac5cf39ae9d08bc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipCtxCreate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classihipCtx__t.html">hipCtx_t</a> *&#160;</td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classihipDevice__t.html">hipDevice_t</a>&#160;</td>
<td class="paramname"><em>device</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a context and set it as current/ default context. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">ctx</td><td></td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td></td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">associated</td><td>device handle</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063" title="Successful completion. ">hipSuccess</a></dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Context.html#ga9a65fe43238ef303a6d97826c05fd14e" title="Destroy a HIP context. ">hipCtxDestroy</a>, <a class="el" href="group__Context.html#ga12a7a993e10f775fbf61a0b14288ed1b" title="Return flags used for creating default context. ">hipCtxGetFlags</a>, <a class="el" href="group__Context.html#ga2cc4ea5a6b78d9d7990a88a7863467d4" title="Pop the current/default context and return the popped context. ">hipCtxPopCurrent</a>, <a class="el" href="group__Context.html#ga741786101d348fdbfa1f64546860357a" title="Get the handle of the current/ default context. ">hipCtxGetCurrent</a>, <a class="el" href="group__Context.html#ga9c9d92f29d68cacdea4c062c97e50a8a" title="Push the context to be set as current/ default context. ">hipCtxPushCurrent</a>, <a class="el" href="group__Context.html#ga7eacc656f1d1b6f5a683bea31be67a2f" title="Set L1/Shared cache partition. ">hipCtxSetCacheConfig</a>, <a class="el" href="group__Context.html#gad45cd968e8e3dcfd24ef050cab2f41c8" title="Blocks until the default context has completed all preceding requested tasks. ">hipCtxSynchronize</a>, <a class="el" href="group__Context.html#ga8aa32cf64272da929f23ecbafefefcee" title="Get the handle of the device associated with current/default context. ">hipCtxGetDevice</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga9a65fe43238ef303a6d97826c05fd14e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipCtxDestroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classihipCtx__t.html">hipCtx_t</a>&#160;</td>
<td class="paramname"><em>ctx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy a HIP context. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ctx</td><td>Context to destroy</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063" title="Successful completion. ">hipSuccess</a>, <a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594a1e8215fe1108a508bad3944bce7b4d83" title="One or more of the parameters passed to the API call is NULL or not in an acceptable range...">hipErrorInvalidValue</a></dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Context.html#gab6dbcff5c5b1249a5ac5cf39ae9d08bc" title="Create a context and set it as current/ default context. ">hipCtxCreate</a>, <a class="el" href="group__Context.html#ga12a7a993e10f775fbf61a0b14288ed1b" title="Return flags used for creating default context. ">hipCtxGetFlags</a>, <a class="el" href="group__Context.html#ga2cc4ea5a6b78d9d7990a88a7863467d4" title="Pop the current/default context and return the popped context. ">hipCtxPopCurrent</a>, <a class="el" href="group__Context.html#ga741786101d348fdbfa1f64546860357a" title="Get the handle of the current/ default context. ">hipCtxGetCurrent</a>,<a class="el" href="group__Context.html#ga834a192f70c2bfc0269c309436776feb" title="Set the passed context as current/default. ">hipCtxSetCurrent</a>, <a class="el" href="group__Context.html#ga9c9d92f29d68cacdea4c062c97e50a8a" title="Push the context to be set as current/ default context. ">hipCtxPushCurrent</a>, <a class="el" href="group__Context.html#ga7eacc656f1d1b6f5a683bea31be67a2f" title="Set L1/Shared cache partition. ">hipCtxSetCacheConfig</a>, <a class="el" href="group__Context.html#gad45cd968e8e3dcfd24ef050cab2f41c8" title="Blocks until the default context has completed all preceding requested tasks. ">hipCtxSynchronize</a> , <a class="el" href="group__Context.html#ga8aa32cf64272da929f23ecbafefefcee" title="Get the handle of the device associated with current/default context. ">hipCtxGetDevice</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaf48e4e9c3b6bbad5deaeff10d2e28b31"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipCtxDisablePeerAccess </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classihipCtx__t.html">hipCtx_t</a>&#160;</td>
<td class="paramname"><em>peerCtx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Disable direct access from current context's virtual address space to memory allocations physically located on a peer context.Disables direct access to memory allocations in a peer context and unregisters any registered allocations. </p>
<p>Returns hipErrorPeerAccessNotEnabled if direct access to memory on peerDevice has not yet been enabled from the current device.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">peerCtx</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063" title="Successful completion. ">hipSuccess</a>, <a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594a2ee0bf2e64840f253e4a1b12bbaf2d09" title="Peer access was never enabled from the current device. ">hipErrorPeerAccessNotEnabled</a></dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Context.html#gab6dbcff5c5b1249a5ac5cf39ae9d08bc" title="Create a context and set it as current/ default context. ">hipCtxCreate</a>, <a class="el" href="group__Context.html#ga9a65fe43238ef303a6d97826c05fd14e" title="Destroy a HIP context. ">hipCtxDestroy</a>, <a class="el" href="group__Context.html#ga12a7a993e10f775fbf61a0b14288ed1b" title="Return flags used for creating default context. ">hipCtxGetFlags</a>, <a class="el" href="group__Context.html#ga2cc4ea5a6b78d9d7990a88a7863467d4" title="Pop the current/default context and return the popped context. ">hipCtxPopCurrent</a>, <a class="el" href="group__Context.html#ga741786101d348fdbfa1f64546860357a" title="Get the handle of the current/ default context. ">hipCtxGetCurrent</a>, <a class="el" href="group__Context.html#ga834a192f70c2bfc0269c309436776feb" title="Set the passed context as current/default. ">hipCtxSetCurrent</a>, <a class="el" href="group__Context.html#ga9c9d92f29d68cacdea4c062c97e50a8a" title="Push the context to be set as current/ default context. ">hipCtxPushCurrent</a>, <a class="el" href="group__Context.html#ga7eacc656f1d1b6f5a683bea31be67a2f" title="Set L1/Shared cache partition. ">hipCtxSetCacheConfig</a>, <a class="el" href="group__Context.html#gad45cd968e8e3dcfd24ef050cab2f41c8" title="Blocks until the default context has completed all preceding requested tasks. ">hipCtxSynchronize</a>, <a class="el" href="group__Context.html#ga8aa32cf64272da929f23ecbafefefcee" title="Get the handle of the device associated with current/default context. ">hipCtxGetDevice</a> </dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>PeerToPeer support is experimental. </dd></dl>
</div>
</div>
<a class="anchor" id="ga834dfd99d72082fe8770142fa30b30e2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipCtxEnablePeerAccess </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classihipCtx__t.html">hipCtx_t</a>&#160;</td>
<td class="paramname"><em>peerCtx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>flags</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enables direct access to memory allocations in a peer context. </p>
<p>Memory which already allocated on peer device will be mapped into the address space of the current device. In addition, all future memory allocations on peerDeviceId will be mapped into the address space of the current device when the memory is allocated. The peer memory remains accessible from the current device until a call to hipDeviceDisablePeerAccess or hipDeviceReset.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">peerCtx</td><td></td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063" title="Successful completion. ">hipSuccess</a>, <a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594a07ab9b704ea693c1781a52741c60cd0d" title="DeviceID must be in range 0...#compute-devices. ">hipErrorInvalidDevice</a>, <a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594a1e8215fe1108a508bad3944bce7b4d83" title="One or more of the parameters passed to the API call is NULL or not in an acceptable range...">hipErrorInvalidValue</a>, <a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594a5399c146f91246f8b77abcd4ea30e7ac" title="Peer access was already enabled from the current device. ">hipErrorPeerAccessAlreadyEnabled</a></dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Context.html#gab6dbcff5c5b1249a5ac5cf39ae9d08bc" title="Create a context and set it as current/ default context. ">hipCtxCreate</a>, <a class="el" href="group__Context.html#ga9a65fe43238ef303a6d97826c05fd14e" title="Destroy a HIP context. ">hipCtxDestroy</a>, <a class="el" href="group__Context.html#ga12a7a993e10f775fbf61a0b14288ed1b" title="Return flags used for creating default context. ">hipCtxGetFlags</a>, <a class="el" href="group__Context.html#ga2cc4ea5a6b78d9d7990a88a7863467d4" title="Pop the current/default context and return the popped context. ">hipCtxPopCurrent</a>, <a class="el" href="group__Context.html#ga741786101d348fdbfa1f64546860357a" title="Get the handle of the current/ default context. ">hipCtxGetCurrent</a>, <a class="el" href="group__Context.html#ga834a192f70c2bfc0269c309436776feb" title="Set the passed context as current/default. ">hipCtxSetCurrent</a>, <a class="el" href="group__Context.html#ga9c9d92f29d68cacdea4c062c97e50a8a" title="Push the context to be set as current/ default context. ">hipCtxPushCurrent</a>, <a class="el" href="group__Context.html#ga7eacc656f1d1b6f5a683bea31be67a2f" title="Set L1/Shared cache partition. ">hipCtxSetCacheConfig</a>, <a class="el" href="group__Context.html#gad45cd968e8e3dcfd24ef050cab2f41c8" title="Blocks until the default context has completed all preceding requested tasks. ">hipCtxSynchronize</a>, <a class="el" href="group__Context.html#ga8aa32cf64272da929f23ecbafefefcee" title="Get the handle of the device associated with current/default context. ">hipCtxGetDevice</a> </dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>PeerToPeer support is experimental. </dd></dl>
</div>
</div>
<a class="anchor" id="gabe5941e6798c71a8351b7d51311e7e8f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipCtxGetApiVersion </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classihipCtx__t.html">hipCtx_t</a>&#160;</td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int *&#160;</td>
<td class="paramname"><em>apiVersion</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the approximate HIP api version. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ctx</td><td>Context to check </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">apiVersion</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063" title="Successful completion. ">hipSuccess</a></dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>The HIP feature set does not correspond to an exact CUDA SDK api revision. This function always set *apiVersion to 4 as an approximation though HIP supports some features which were introduced in later CUDA SDK revisions. HIP apps code should not rely on the api revision number here and should use arch feature flags to test device capabilities or conditional compilation.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Context.html#gab6dbcff5c5b1249a5ac5cf39ae9d08bc" title="Create a context and set it as current/ default context. ">hipCtxCreate</a>, <a class="el" href="group__Context.html#ga9a65fe43238ef303a6d97826c05fd14e" title="Destroy a HIP context. ">hipCtxDestroy</a>, <a class="el" href="group__Context.html#ga8aa32cf64272da929f23ecbafefefcee" title="Get the handle of the device associated with current/default context. ">hipCtxGetDevice</a>, <a class="el" href="group__Context.html#ga12a7a993e10f775fbf61a0b14288ed1b" title="Return flags used for creating default context. ">hipCtxGetFlags</a>, <a class="el" href="group__Context.html#ga2cc4ea5a6b78d9d7990a88a7863467d4" title="Pop the current/default context and return the popped context. ">hipCtxPopCurrent</a>, <a class="el" href="group__Context.html#ga9c9d92f29d68cacdea4c062c97e50a8a" title="Push the context to be set as current/ default context. ">hipCtxPushCurrent</a>, <a class="el" href="group__Context.html#ga7eacc656f1d1b6f5a683bea31be67a2f" title="Set L1/Shared cache partition. ">hipCtxSetCacheConfig</a>, <a class="el" href="group__Context.html#gad45cd968e8e3dcfd24ef050cab2f41c8" title="Blocks until the default context has completed all preceding requested tasks. ">hipCtxSynchronize</a>, <a class="el" href="group__Context.html#ga8aa32cf64272da929f23ecbafefefcee" title="Get the handle of the device associated with current/default context. ">hipCtxGetDevice</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gab10373068faafd3042c9003e2e6d905a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipCtxGetCacheConfig </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__GlobalDefs.html#ga86e5c5692645963a9a673e1aa88ba6ca">hipFuncCache_t</a> *&#160;</td>
<td class="paramname"><em>cacheConfig</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set Cache configuration for a specific function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">cacheConfiguration</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063" title="Successful completion. ">hipSuccess</a></dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>AMD devices and recent Nvidia GPUS do not support reconfigurable cache. This hint is ignored on those architectures.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Context.html#gab6dbcff5c5b1249a5ac5cf39ae9d08bc" title="Create a context and set it as current/ default context. ">hipCtxCreate</a>, <a class="el" href="group__Context.html#ga9a65fe43238ef303a6d97826c05fd14e" title="Destroy a HIP context. ">hipCtxDestroy</a>, <a class="el" href="group__Context.html#ga12a7a993e10f775fbf61a0b14288ed1b" title="Return flags used for creating default context. ">hipCtxGetFlags</a>, <a class="el" href="group__Context.html#ga2cc4ea5a6b78d9d7990a88a7863467d4" title="Pop the current/default context and return the popped context. ">hipCtxPopCurrent</a>, <a class="el" href="group__Context.html#ga741786101d348fdbfa1f64546860357a" title="Get the handle of the current/ default context. ">hipCtxGetCurrent</a>, <a class="el" href="group__Context.html#ga834a192f70c2bfc0269c309436776feb" title="Set the passed context as current/default. ">hipCtxSetCurrent</a>, <a class="el" href="group__Context.html#ga9c9d92f29d68cacdea4c062c97e50a8a" title="Push the context to be set as current/ default context. ">hipCtxPushCurrent</a>, <a class="el" href="group__Context.html#ga7eacc656f1d1b6f5a683bea31be67a2f" title="Set L1/Shared cache partition. ">hipCtxSetCacheConfig</a>, <a class="el" href="group__Context.html#gad45cd968e8e3dcfd24ef050cab2f41c8" title="Blocks until the default context has completed all preceding requested tasks. ">hipCtxSynchronize</a>, <a class="el" href="group__Context.html#ga8aa32cf64272da929f23ecbafefefcee" title="Get the handle of the device associated with current/default context. ">hipCtxGetDevice</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga741786101d348fdbfa1f64546860357a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipCtxGetCurrent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classihipCtx__t.html">hipCtx_t</a> *&#160;</td>
<td class="paramname"><em>ctx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the handle of the current/ default context. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">ctx</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063" title="Successful completion. ">hipSuccess</a>, <a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594ad9d895f7f4dbf63a4586b2aab593c9fe" title="Produced when input context is invalid. ">hipErrorInvalidContext</a></dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Context.html#gab6dbcff5c5b1249a5ac5cf39ae9d08bc" title="Create a context and set it as current/ default context. ">hipCtxCreate</a>, <a class="el" href="group__Context.html#ga9a65fe43238ef303a6d97826c05fd14e" title="Destroy a HIP context. ">hipCtxDestroy</a>, <a class="el" href="group__Context.html#ga8aa32cf64272da929f23ecbafefefcee" title="Get the handle of the device associated with current/default context. ">hipCtxGetDevice</a>, <a class="el" href="group__Context.html#ga12a7a993e10f775fbf61a0b14288ed1b" title="Return flags used for creating default context. ">hipCtxGetFlags</a>, <a class="el" href="group__Context.html#ga2cc4ea5a6b78d9d7990a88a7863467d4" title="Pop the current/default context and return the popped context. ">hipCtxPopCurrent</a>, <a class="el" href="group__Context.html#ga9c9d92f29d68cacdea4c062c97e50a8a" title="Push the context to be set as current/ default context. ">hipCtxPushCurrent</a>, <a class="el" href="group__Context.html#ga7eacc656f1d1b6f5a683bea31be67a2f" title="Set L1/Shared cache partition. ">hipCtxSetCacheConfig</a>, <a class="el" href="group__Context.html#gad45cd968e8e3dcfd24ef050cab2f41c8" title="Blocks until the default context has completed all preceding requested tasks. ">hipCtxSynchronize</a>, <a class="el" href="group__Context.html#ga8aa32cf64272da929f23ecbafefefcee" title="Get the handle of the device associated with current/default context. ">hipCtxGetDevice</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga8aa32cf64272da929f23ecbafefefcee"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipCtxGetDevice </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classihipDevice__t.html">hipDevice_t</a> *&#160;</td>
<td class="paramname"><em>device</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the handle of the device associated with current/default context. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">device</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063" title="Successful completion. ">hipSuccess</a>, <a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594ad9d895f7f4dbf63a4586b2aab593c9fe" title="Produced when input context is invalid. ">hipErrorInvalidContext</a></dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Context.html#gab6dbcff5c5b1249a5ac5cf39ae9d08bc" title="Create a context and set it as current/ default context. ">hipCtxCreate</a>, <a class="el" href="group__Context.html#ga9a65fe43238ef303a6d97826c05fd14e" title="Destroy a HIP context. ">hipCtxDestroy</a>, <a class="el" href="group__Context.html#ga12a7a993e10f775fbf61a0b14288ed1b" title="Return flags used for creating default context. ">hipCtxGetFlags</a>, <a class="el" href="group__Context.html#ga2cc4ea5a6b78d9d7990a88a7863467d4" title="Pop the current/default context and return the popped context. ">hipCtxPopCurrent</a>, <a class="el" href="group__Context.html#ga741786101d348fdbfa1f64546860357a" title="Get the handle of the current/ default context. ">hipCtxGetCurrent</a>, <a class="el" href="group__Context.html#ga9c9d92f29d68cacdea4c062c97e50a8a" title="Push the context to be set as current/ default context. ">hipCtxPushCurrent</a>, <a class="el" href="group__Context.html#ga7eacc656f1d1b6f5a683bea31be67a2f" title="Set L1/Shared cache partition. ">hipCtxSetCacheConfig</a>, <a class="el" href="group__Context.html#gad45cd968e8e3dcfd24ef050cab2f41c8" title="Blocks until the default context has completed all preceding requested tasks. ">hipCtxSynchronize</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga12a7a993e10f775fbf61a0b14288ed1b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipCtxGetFlags </td>
<td>(</td>
<td class="paramtype">unsigned int *&#160;</td>
<td class="paramname"><em>flags</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return flags used for creating default context. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">flags</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063" title="Successful completion. ">hipSuccess</a></dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Context.html#gab6dbcff5c5b1249a5ac5cf39ae9d08bc" title="Create a context and set it as current/ default context. ">hipCtxCreate</a>, <a class="el" href="group__Context.html#ga9a65fe43238ef303a6d97826c05fd14e" title="Destroy a HIP context. ">hipCtxDestroy</a>, <a class="el" href="group__Context.html#ga2cc4ea5a6b78d9d7990a88a7863467d4" title="Pop the current/default context and return the popped context. ">hipCtxPopCurrent</a>, <a class="el" href="group__Context.html#ga741786101d348fdbfa1f64546860357a" title="Get the handle of the current/ default context. ">hipCtxGetCurrent</a>, <a class="el" href="group__Context.html#ga741786101d348fdbfa1f64546860357a" title="Get the handle of the current/ default context. ">hipCtxGetCurrent</a>, <a class="el" href="group__Context.html#ga834a192f70c2bfc0269c309436776feb" title="Set the passed context as current/default. ">hipCtxSetCurrent</a>, <a class="el" href="group__Context.html#ga9c9d92f29d68cacdea4c062c97e50a8a" title="Push the context to be set as current/ default context. ">hipCtxPushCurrent</a>, <a class="el" href="group__Context.html#ga7eacc656f1d1b6f5a683bea31be67a2f" title="Set L1/Shared cache partition. ">hipCtxSetCacheConfig</a>, <a class="el" href="group__Context.html#gad45cd968e8e3dcfd24ef050cab2f41c8" title="Blocks until the default context has completed all preceding requested tasks. ">hipCtxSynchronize</a>, <a class="el" href="group__Context.html#ga8aa32cf64272da929f23ecbafefefcee" title="Get the handle of the device associated with current/default context. ">hipCtxGetDevice</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga3c78b22dd03435a7ca88621a45409565"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipCtxGetSharedMemConfig </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__GlobalDefs.html#ga2e17b71d94ac350f2ccd914fd49d104e">hipSharedMemConfig</a> *&#160;</td>
<td class="paramname"><em>pConfig</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get Shared memory bank configuration. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">sharedMemoryConfiguration</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063" title="Successful completion. ">hipSuccess</a></dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>AMD devices and recent Nvidia GPUS do not support shared cache banking, and the hint is ignored on those architectures.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Context.html#gab6dbcff5c5b1249a5ac5cf39ae9d08bc" title="Create a context and set it as current/ default context. ">hipCtxCreate</a>, <a class="el" href="group__Context.html#ga9a65fe43238ef303a6d97826c05fd14e" title="Destroy a HIP context. ">hipCtxDestroy</a>, <a class="el" href="group__Context.html#ga12a7a993e10f775fbf61a0b14288ed1b" title="Return flags used for creating default context. ">hipCtxGetFlags</a>, <a class="el" href="group__Context.html#ga2cc4ea5a6b78d9d7990a88a7863467d4" title="Pop the current/default context and return the popped context. ">hipCtxPopCurrent</a>, <a class="el" href="group__Context.html#ga741786101d348fdbfa1f64546860357a" title="Get the handle of the current/ default context. ">hipCtxGetCurrent</a>, <a class="el" href="group__Context.html#ga834a192f70c2bfc0269c309436776feb" title="Set the passed context as current/default. ">hipCtxSetCurrent</a>, <a class="el" href="group__Context.html#ga9c9d92f29d68cacdea4c062c97e50a8a" title="Push the context to be set as current/ default context. ">hipCtxPushCurrent</a>, <a class="el" href="group__Context.html#ga7eacc656f1d1b6f5a683bea31be67a2f" title="Set L1/Shared cache partition. ">hipCtxSetCacheConfig</a>, <a class="el" href="group__Context.html#gad45cd968e8e3dcfd24ef050cab2f41c8" title="Blocks until the default context has completed all preceding requested tasks. ">hipCtxSynchronize</a>, <a class="el" href="group__Context.html#ga8aa32cf64272da929f23ecbafefefcee" title="Get the handle of the device associated with current/default context. ">hipCtxGetDevice</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga2cc4ea5a6b78d9d7990a88a7863467d4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipCtxPopCurrent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classihipCtx__t.html">hipCtx_t</a> *&#160;</td>
<td class="paramname"><em>ctx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Pop the current/default context and return the popped context. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">ctx</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063" title="Successful completion. ">hipSuccess</a>, <a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594ad9d895f7f4dbf63a4586b2aab593c9fe" title="Produced when input context is invalid. ">hipErrorInvalidContext</a></dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Context.html#gab6dbcff5c5b1249a5ac5cf39ae9d08bc" title="Create a context and set it as current/ default context. ">hipCtxCreate</a>, <a class="el" href="group__Context.html#ga9a65fe43238ef303a6d97826c05fd14e" title="Destroy a HIP context. ">hipCtxDestroy</a>, <a class="el" href="group__Context.html#ga12a7a993e10f775fbf61a0b14288ed1b" title="Return flags used for creating default context. ">hipCtxGetFlags</a>, <a class="el" href="group__Context.html#ga834a192f70c2bfc0269c309436776feb" title="Set the passed context as current/default. ">hipCtxSetCurrent</a>, <a class="el" href="group__Context.html#ga741786101d348fdbfa1f64546860357a" title="Get the handle of the current/ default context. ">hipCtxGetCurrent</a>, <a class="el" href="group__Context.html#ga9c9d92f29d68cacdea4c062c97e50a8a" title="Push the context to be set as current/ default context. ">hipCtxPushCurrent</a>, <a class="el" href="group__Context.html#ga7eacc656f1d1b6f5a683bea31be67a2f" title="Set L1/Shared cache partition. ">hipCtxSetCacheConfig</a>, <a class="el" href="group__Context.html#gad45cd968e8e3dcfd24ef050cab2f41c8" title="Blocks until the default context has completed all preceding requested tasks. ">hipCtxSynchronize</a>, <a class="el" href="group__Context.html#ga8aa32cf64272da929f23ecbafefefcee" title="Get the handle of the device associated with current/default context. ">hipCtxGetDevice</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga9c9d92f29d68cacdea4c062c97e50a8a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipCtxPushCurrent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classihipCtx__t.html">hipCtx_t</a>&#160;</td>
<td class="paramname"><em>ctx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Push the context to be set as current/ default context. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ctx</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063" title="Successful completion. ">hipSuccess</a>, <a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594ad9d895f7f4dbf63a4586b2aab593c9fe" title="Produced when input context is invalid. ">hipErrorInvalidContext</a></dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Context.html#gab6dbcff5c5b1249a5ac5cf39ae9d08bc" title="Create a context and set it as current/ default context. ">hipCtxCreate</a>, <a class="el" href="group__Context.html#ga9a65fe43238ef303a6d97826c05fd14e" title="Destroy a HIP context. ">hipCtxDestroy</a>, <a class="el" href="group__Context.html#ga12a7a993e10f775fbf61a0b14288ed1b" title="Return flags used for creating default context. ">hipCtxGetFlags</a>, <a class="el" href="group__Context.html#ga2cc4ea5a6b78d9d7990a88a7863467d4" title="Pop the current/default context and return the popped context. ">hipCtxPopCurrent</a>, <a class="el" href="group__Context.html#ga741786101d348fdbfa1f64546860357a" title="Get the handle of the current/ default context. ">hipCtxGetCurrent</a>, <a class="el" href="group__Context.html#ga9c9d92f29d68cacdea4c062c97e50a8a" title="Push the context to be set as current/ default context. ">hipCtxPushCurrent</a>, <a class="el" href="group__Context.html#ga7eacc656f1d1b6f5a683bea31be67a2f" title="Set L1/Shared cache partition. ">hipCtxSetCacheConfig</a>, <a class="el" href="group__Context.html#gad45cd968e8e3dcfd24ef050cab2f41c8" title="Blocks until the default context has completed all preceding requested tasks. ">hipCtxSynchronize</a> , <a class="el" href="group__Context.html#ga8aa32cf64272da929f23ecbafefefcee" title="Get the handle of the device associated with current/default context. ">hipCtxGetDevice</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga7eacc656f1d1b6f5a683bea31be67a2f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipCtxSetCacheConfig </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__GlobalDefs.html#ga86e5c5692645963a9a673e1aa88ba6ca">hipFuncCache_t</a>&#160;</td>
<td class="paramname"><em>cacheConfig</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set L1/Shared cache partition. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cacheConfiguration</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063" title="Successful completion. ">hipSuccess</a></dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>AMD devices and recent Nvidia GPUS do not support reconfigurable cache. This hint is ignored on those architectures.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Context.html#gab6dbcff5c5b1249a5ac5cf39ae9d08bc" title="Create a context and set it as current/ default context. ">hipCtxCreate</a>, <a class="el" href="group__Context.html#ga9a65fe43238ef303a6d97826c05fd14e" title="Destroy a HIP context. ">hipCtxDestroy</a>, <a class="el" href="group__Context.html#ga12a7a993e10f775fbf61a0b14288ed1b" title="Return flags used for creating default context. ">hipCtxGetFlags</a>, <a class="el" href="group__Context.html#ga2cc4ea5a6b78d9d7990a88a7863467d4" title="Pop the current/default context and return the popped context. ">hipCtxPopCurrent</a>, <a class="el" href="group__Context.html#ga741786101d348fdbfa1f64546860357a" title="Get the handle of the current/ default context. ">hipCtxGetCurrent</a>, <a class="el" href="group__Context.html#ga834a192f70c2bfc0269c309436776feb" title="Set the passed context as current/default. ">hipCtxSetCurrent</a>, <a class="el" href="group__Context.html#ga9c9d92f29d68cacdea4c062c97e50a8a" title="Push the context to be set as current/ default context. ">hipCtxPushCurrent</a>, <a class="el" href="group__Context.html#ga7eacc656f1d1b6f5a683bea31be67a2f" title="Set L1/Shared cache partition. ">hipCtxSetCacheConfig</a>, <a class="el" href="group__Context.html#gad45cd968e8e3dcfd24ef050cab2f41c8" title="Blocks until the default context has completed all preceding requested tasks. ">hipCtxSynchronize</a>, <a class="el" href="group__Context.html#ga8aa32cf64272da929f23ecbafefefcee" title="Get the handle of the device associated with current/default context. ">hipCtxGetDevice</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga834a192f70c2bfc0269c309436776feb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipCtxSetCurrent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classihipCtx__t.html">hipCtx_t</a>&#160;</td>
<td class="paramname"><em>ctx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the passed context as current/default. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ctx</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063" title="Successful completion. ">hipSuccess</a>, <a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594ad9d895f7f4dbf63a4586b2aab593c9fe" title="Produced when input context is invalid. ">hipErrorInvalidContext</a></dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Context.html#gab6dbcff5c5b1249a5ac5cf39ae9d08bc" title="Create a context and set it as current/ default context. ">hipCtxCreate</a>, <a class="el" href="group__Context.html#ga9a65fe43238ef303a6d97826c05fd14e" title="Destroy a HIP context. ">hipCtxDestroy</a>, <a class="el" href="group__Context.html#ga12a7a993e10f775fbf61a0b14288ed1b" title="Return flags used for creating default context. ">hipCtxGetFlags</a>, <a class="el" href="group__Context.html#ga2cc4ea5a6b78d9d7990a88a7863467d4" title="Pop the current/default context and return the popped context. ">hipCtxPopCurrent</a>, <a class="el" href="group__Context.html#ga741786101d348fdbfa1f64546860357a" title="Get the handle of the current/ default context. ">hipCtxGetCurrent</a>, <a class="el" href="group__Context.html#ga9c9d92f29d68cacdea4c062c97e50a8a" title="Push the context to be set as current/ default context. ">hipCtxPushCurrent</a>, <a class="el" href="group__Context.html#ga7eacc656f1d1b6f5a683bea31be67a2f" title="Set L1/Shared cache partition. ">hipCtxSetCacheConfig</a>, <a class="el" href="group__Context.html#gad45cd968e8e3dcfd24ef050cab2f41c8" title="Blocks until the default context has completed all preceding requested tasks. ">hipCtxSynchronize</a> , <a class="el" href="group__Context.html#ga8aa32cf64272da929f23ecbafefefcee" title="Get the handle of the device associated with current/default context. ">hipCtxGetDevice</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gad5c1d4ced27f584a74ed550dd002fa5a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipCtxSetSharedMemConfig </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__GlobalDefs.html#ga2e17b71d94ac350f2ccd914fd49d104e">hipSharedMemConfig</a>&#160;</td>
<td class="paramname"><em>config</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set Shared memory bank configuration. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">sharedMemoryConfiguration</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063" title="Successful completion. ">hipSuccess</a></dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>AMD devices and recent Nvidia GPUS do not support shared cache banking, and the hint is ignored on those architectures.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Context.html#gab6dbcff5c5b1249a5ac5cf39ae9d08bc" title="Create a context and set it as current/ default context. ">hipCtxCreate</a>, <a class="el" href="group__Context.html#ga9a65fe43238ef303a6d97826c05fd14e" title="Destroy a HIP context. ">hipCtxDestroy</a>, <a class="el" href="group__Context.html#ga12a7a993e10f775fbf61a0b14288ed1b" title="Return flags used for creating default context. ">hipCtxGetFlags</a>, <a class="el" href="group__Context.html#ga2cc4ea5a6b78d9d7990a88a7863467d4" title="Pop the current/default context and return the popped context. ">hipCtxPopCurrent</a>, <a class="el" href="group__Context.html#ga741786101d348fdbfa1f64546860357a" title="Get the handle of the current/ default context. ">hipCtxGetCurrent</a>, <a class="el" href="group__Context.html#ga834a192f70c2bfc0269c309436776feb" title="Set the passed context as current/default. ">hipCtxSetCurrent</a>, <a class="el" href="group__Context.html#ga9c9d92f29d68cacdea4c062c97e50a8a" title="Push the context to be set as current/ default context. ">hipCtxPushCurrent</a>, <a class="el" href="group__Context.html#ga7eacc656f1d1b6f5a683bea31be67a2f" title="Set L1/Shared cache partition. ">hipCtxSetCacheConfig</a>, <a class="el" href="group__Context.html#gad45cd968e8e3dcfd24ef050cab2f41c8" title="Blocks until the default context has completed all preceding requested tasks. ">hipCtxSynchronize</a>, <a class="el" href="group__Context.html#ga8aa32cf64272da929f23ecbafefefcee" title="Get the handle of the device associated with current/default context. ">hipCtxGetDevice</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gad45cd968e8e3dcfd24ef050cab2f41c8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a> hipCtxSynchronize </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Blocks until the default context has completed all preceding requested tasks. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__GlobalDefs.html#ggadf5010f6e140a53ecbdf949e73e87594aadfbdb847b149723c684ebd764556063" title="Successful completion. ">hipSuccess</a></dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>This function waits for all streams on the default context to complete execution, and then returns.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Context.html#gab6dbcff5c5b1249a5ac5cf39ae9d08bc" title="Create a context and set it as current/ default context. ">hipCtxCreate</a>, <a class="el" href="group__Context.html#ga9a65fe43238ef303a6d97826c05fd14e" title="Destroy a HIP context. ">hipCtxDestroy</a>, <a class="el" href="group__Context.html#ga12a7a993e10f775fbf61a0b14288ed1b" title="Return flags used for creating default context. ">hipCtxGetFlags</a>, <a class="el" href="group__Context.html#ga2cc4ea5a6b78d9d7990a88a7863467d4" title="Pop the current/default context and return the popped context. ">hipCtxPopCurrent</a>, <a class="el" href="group__Context.html#ga741786101d348fdbfa1f64546860357a" title="Get the handle of the current/ default context. ">hipCtxGetCurrent</a>, <a class="el" href="group__Context.html#ga834a192f70c2bfc0269c309436776feb" title="Set the passed context as current/default. ">hipCtxSetCurrent</a>, <a class="el" href="group__Context.html#ga9c9d92f29d68cacdea4c062c97e50a8a" title="Push the context to be set as current/ default context. ">hipCtxPushCurrent</a>, <a class="el" href="group__Context.html#ga7eacc656f1d1b6f5a683bea31be67a2f" title="Set L1/Shared cache partition. ">hipCtxSetCacheConfig</a>, <a class="el" href="group__Context.html#ga8aa32cf64272da929f23ecbafefefcee" title="Get the handle of the device associated with current/default context. ">hipCtxGetDevice</a> </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Dec 19 2016 04:03:44 for HIP: Heterogenous-computing Interface for Portability 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>