mika/libnx
1
0
Fork 0
mirror of https://github.com/switchbrew/libnx.git synced 2025-07-26 03:52:24 +02:00
Code Issues Packages Projects Releases Wiki Activity
gh-pages
libnx/shmem_8h.html
WinterMute bf00061749 Deploying to gh-pages from @ 29f6f4fa7a 🚀
2025-05-08 06:59:12 +00:00

349 lines
18 KiB
HTML
Raw Permalink Blame History

<!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" lang="en-US">
<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.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libnx: include/switch/kernel/shmem.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/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 id="projectrow">
<td id="projectalign">
<div id="projectname">libnx<span id="projectnumber">&#160;v4.9.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_42bea3d40f1f1694e41a8f3166c98108.html">switch</a></li><li class="navelem"><a class="el" href="dir_36b4ff30955378a33ed199d75bfba1a9.html">kernel</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">shmem.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Shared memory object handling.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="types_8h_source.html">../types.h</a>&quot;</code><br />
</div>
<p><a href="shmem_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSharedMemory.html">SharedMemory</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shared memory information structure. <a href="structSharedMemory.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="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ac4ef5e2675caed34565bf106863a5542" id="r_ac4ef5e2675caed34565bf106863a5542"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="shmem_8h.html#ac4ef5e2675caed34565bf106863a5542">shmemCreate</a> (<a class="el" href="structSharedMemory.html">SharedMemory</a> *s, size_t size, <a class="el" href="svc_8h.html#a1474fa581c530fcdc28ca0a11770200c">Permission</a> local_perm, <a class="el" href="svc_8h.html#a1474fa581c530fcdc28ca0a11770200c">Permission</a> remote_perm)</td></tr>
<tr class="memdesc:ac4ef5e2675caed34565bf106863a5542"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a shared memory object. <br /></td></tr>
<tr class="separator:ac4ef5e2675caed34565bf106863a5542"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a956a6fc9e616b26dd7b22771053bbe14" id="r_a956a6fc9e616b26dd7b22771053bbe14"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="shmem_8h.html#a956a6fc9e616b26dd7b22771053bbe14">shmemLoadRemote</a> (<a class="el" href="structSharedMemory.html">SharedMemory</a> *s, <a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> handle, size_t size, <a class="el" href="svc_8h.html#a1474fa581c530fcdc28ca0a11770200c">Permission</a> perm)</td></tr>
<tr class="memdesc:a956a6fc9e616b26dd7b22771053bbe14"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads a shared memory object coming from a remote process. <br /></td></tr>
<tr class="separator:a956a6fc9e616b26dd7b22771053bbe14"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1c35fb61dd2fe994b17221f292c3ac9" id="r_ab1c35fb61dd2fe994b17221f292c3ac9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="shmem_8h.html#ab1c35fb61dd2fe994b17221f292c3ac9">shmemMap</a> (<a class="el" href="structSharedMemory.html">SharedMemory</a> *s)</td></tr>
<tr class="memdesc:ab1c35fb61dd2fe994b17221f292c3ac9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maps a shared memory object. <br /></td></tr>
<tr class="separator:ab1c35fb61dd2fe994b17221f292c3ac9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48a173626f9c2da886233c65f4e5ce46" id="r_a48a173626f9c2da886233c65f4e5ce46"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="shmem_8h.html#a48a173626f9c2da886233c65f4e5ce46">shmemUnmap</a> (<a class="el" href="structSharedMemory.html">SharedMemory</a> *s)</td></tr>
<tr class="memdesc:a48a173626f9c2da886233c65f4e5ce46"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unmaps a shared memory object. <br /></td></tr>
<tr class="separator:a48a173626f9c2da886233c65f4e5ce46"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa423982e9d4f14d4ce4c95e47bb753f1" id="r_aa423982e9d4f14d4ce4c95e47bb753f1"><td class="memItemLeft" align="right" valign="top">static void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="shmem_8h.html#aa423982e9d4f14d4ce4c95e47bb753f1">shmemGetAddr</a> (<a class="el" href="structSharedMemory.html">SharedMemory</a> *s)</td></tr>
<tr class="memdesc:aa423982e9d4f14d4ce4c95e47bb753f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the mapped address of a shared memory object. <br /></td></tr>
<tr class="separator:aa423982e9d4f14d4ce4c95e47bb753f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac63a2544e4cc95f05058f05dc3f734e7" id="r_ac63a2544e4cc95f05058f05dc3f734e7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="shmem_8h.html#ac63a2544e4cc95f05058f05dc3f734e7">shmemClose</a> (<a class="el" href="structSharedMemory.html">SharedMemory</a> *s)</td></tr>
<tr class="memdesc:ac63a2544e4cc95f05058f05dc3f734e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Frees up resources used by a shared memory object, unmapping and closing handles, etc. <br /></td></tr>
<tr class="separator:ac63a2544e4cc95f05058f05dc3f734e7"><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>Shared memory object handling. </p>
<dl class="section author"><dt>Author</dt><dd>plutoo </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>libnx Authors </dd></dl>
<dl class="section remark"><dt>Remarks</dt><dd>Shared memory differs from transfer memory in the fact that the kernel (as opposed to the user process) allocates and owns its backing memory. </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="ac63a2544e4cc95f05058f05dc3f734e7" name="ac63a2544e4cc95f05058f05dc3f734e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac63a2544e4cc95f05058f05dc3f734e7">&#9670;&#160;</a></span>shmemClose()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> shmemClose </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structSharedMemory.html">SharedMemory</a> *&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Frees up resources used by a shared memory object, unmapping and closing handles, etc. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>Shared memory information structure. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code. </dd></dl>
</div>
</div>
<a id="ac4ef5e2675caed34565bf106863a5542" name="ac4ef5e2675caed34565bf106863a5542"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4ef5e2675caed34565bf106863a5542">&#9670;&#160;</a></span>shmemCreate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> shmemCreate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structSharedMemory.html">SharedMemory</a> *&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="svc_8h.html#a1474fa581c530fcdc28ca0a11770200c">Permission</a>&#160;</td>
<td class="paramname"><em>local_perm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="svc_8h.html#a1474fa581c530fcdc28ca0a11770200c">Permission</a>&#160;</td>
<td class="paramname"><em>remote_perm</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a shared memory object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>Shared memory information structure which will be filled in. </td></tr>
<tr><td class="paramname">size</td><td>Size of the shared memory object to create. </td></tr>
<tr><td class="paramname">local_perm</td><td>Permissions with which the shared memory object will be mapped in the local process. </td></tr>
<tr><td class="paramname">remote_perm</td><td>Permissions with which the shared memory object will be mapped in the remote process (can be Perm_DontCare). </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code. </dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>This is a privileged operation; in normal circumstances applications cannot use this function. </dd></dl>
</div>
</div>
<a id="aa423982e9d4f14d4ce4c95e47bb753f1" name="aa423982e9d4f14d4ce4c95e47bb753f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa423982e9d4f14d4ce4c95e47bb753f1">&#9670;&#160;</a></span>shmemGetAddr()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void * shmemGetAddr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structSharedMemory.html">SharedMemory</a> *&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the mapped address of a shared memory object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>Shared memory information structure. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Mapped address of the shared memory object. </dd></dl>
</div>
</div>
<a id="a956a6fc9e616b26dd7b22771053bbe14" name="a956a6fc9e616b26dd7b22771053bbe14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a956a6fc9e616b26dd7b22771053bbe14">&#9670;&#160;</a></span>shmemLoadRemote()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void shmemLoadRemote </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structSharedMemory.html">SharedMemory</a> *&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a>&#160;</td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="svc_8h.html#a1474fa581c530fcdc28ca0a11770200c">Permission</a>&#160;</td>
<td class="paramname"><em>perm</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Loads a shared memory object coming from a remote process. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>Shared memory information structure which will be filled in. </td></tr>
<tr><td class="paramname">handle</td><td>Handle of the shared memory object. </td></tr>
<tr><td class="paramname">size</td><td>Size of the shared memory object that is being loaded. </td></tr>
<tr><td class="paramname">perm</td><td>Permissions with which the shared memory object will be mapped in the local process. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab1c35fb61dd2fe994b17221f292c3ac9" name="ab1c35fb61dd2fe994b17221f292c3ac9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab1c35fb61dd2fe994b17221f292c3ac9">&#9670;&#160;</a></span>shmemMap()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> shmemMap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structSharedMemory.html">SharedMemory</a> *&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Maps a shared memory object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>Shared memory information structure. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code. </dd></dl>
</div>
</div>
<a id="a48a173626f9c2da886233c65f4e5ce46" name="a48a173626f9c2da886233c65f4e5ce46"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48a173626f9c2da886233c65f4e5ce46">&#9670;&#160;</a></span>shmemUnmap()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> shmemUnmap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structSharedMemory.html">SharedMemory</a> *&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unmaps a shared memory object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>Shared memory information structure. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code. </dd></dl>
</div>
</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.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink