1
0
mirror of https://github.com/switchbrew/libnx.git synced 2025-07-03 18:12:14 +02:00
libnx/shmem_8h_source.html
2025-05-08 06:59:12 +00:00

176 lines
22 KiB
HTML

<!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 Source File</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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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="headertitle"><div class="title">shmem.h</div></div>
</div><!--header-->
<div class="contents">
<a href="shmem_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/**</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * @file shmem.h</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * @brief Shared memory object handling</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * @author plutoo</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * @copyright libnx Authors</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * @remark Shared memory differs from transfer memory in the fact that the kernel (as opposed to the user process) allocates and owns its backing memory.</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> */</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &quot;../types.h&quot;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"></span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">/// Shared memory information structure.</span></div>
<div class="foldopen" id="foldopen00012" data-start="{" data-end="};">
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="structSharedMemory.html"> 12</a></span><span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="structSharedMemory.html#a9c593fcc08559bd1bd938bcd8d8647ad"> 13</a></span> <a class="code hl_typedef" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> <a class="code hl_variable" href="structSharedMemory.html#a9c593fcc08559bd1bd938bcd8d8647ad">handle</a>; <span class="comment">///&lt; Kernel object handle.</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="structSharedMemory.html#a3dd5fde72c6ea2c28b09d1bb659331cc"> 14</a></span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="structSharedMemory.html#a3dd5fde72c6ea2c28b09d1bb659331cc">size</a>; <span class="comment">///&lt; Size of the shared memory object.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="structSharedMemory.html#a67180a14a5bd90113a324d74015c47d4"> 15</a></span> <a class="code hl_enumeration" href="svc_8h.html#a1474fa581c530fcdc28ca0a11770200c">Permission</a> <a class="code hl_variable" href="structSharedMemory.html#a67180a14a5bd90113a324d74015c47d4">perm</a>; <span class="comment">///&lt; Permissions.</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="structSharedMemory.html#acf0a958021ceccf8499f44a804a81877"> 16</a></span> <span class="keywordtype">void</span>* <a class="code hl_variable" href="structSharedMemory.html#acf0a958021ceccf8499f44a804a81877">map_addr</a>; <span class="comment">///&lt; Address to which the shared memory object is mapped.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span>} <a class="code hl_struct" href="structSharedMemory.html">SharedMemory</a>;</div>
</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"></span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment">/**</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment"> * @brief Creates a shared memory object.</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment"> * @param s Shared memory information structure which will be filled in.</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment"> * @param size Size of the shared memory object to create.</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment"> * @param local_perm Permissions with which the shared memory object will be mapped in the local process.</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="comment"> * @param remote_perm Permissions with which the shared memory object will be mapped in the remote process (can be Perm_DontCare).</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment"> * @return Result code.</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="comment"> * @warning This is a privileged operation; in normal circumstances applications cannot use this function.</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="comment"> */</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="shmem_8h.html#ac4ef5e2675caed34565bf106863a5542"> 28</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="shmem_8h.html#ac4ef5e2675caed34565bf106863a5542">shmemCreate</a>(<a class="code hl_struct" href="structSharedMemory.html">SharedMemory</a>* s, <span class="keywordtype">size_t</span> size, <a class="code hl_enumeration" href="svc_8h.html#a1474fa581c530fcdc28ca0a11770200c">Permission</a> local_perm, <a class="code hl_enumeration" href="svc_8h.html#a1474fa581c530fcdc28ca0a11770200c">Permission</a> remote_perm);</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment"></span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment">/**</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment"> * @brief Loads a shared memory object coming from a remote process.</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment"> * @param s Shared memory information structure which will be filled in.</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment"> * @param handle Handle of the shared memory object.</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment"> * @param size Size of the shared memory object that is being loaded.</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="comment"> * @param perm Permissions with which the shared memory object will be mapped in the local process.</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="comment"> */</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="shmem_8h.html#a956a6fc9e616b26dd7b22771053bbe14"> 37</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="shmem_8h.html#a956a6fc9e616b26dd7b22771053bbe14">shmemLoadRemote</a>(<a class="code hl_struct" href="structSharedMemory.html">SharedMemory</a>* s, <a class="code hl_typedef" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> handle, <span class="keywordtype">size_t</span> size, <a class="code hl_enumeration" href="svc_8h.html#a1474fa581c530fcdc28ca0a11770200c">Permission</a> perm);</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="comment"></span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="comment">/**</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="comment"> * @brief Maps a shared memory object.</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="comment"> * @param s Shared memory information structure.</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment"> * @return Result code.</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="comment"> */</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="shmem_8h.html#ab1c35fb61dd2fe994b17221f292c3ac9"> 44</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="shmem_8h.html#ab1c35fb61dd2fe994b17221f292c3ac9">shmemMap</a>(<a class="code hl_struct" href="structSharedMemory.html">SharedMemory</a>* s);</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="comment"></span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="comment">/**</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="comment"> * @brief Unmaps a shared memory object.</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="comment"> * @param s Shared memory information structure.</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment"> * @return Result code.</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="comment"> */</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="shmem_8h.html#a48a173626f9c2da886233c65f4e5ce46"> 51</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="shmem_8h.html#a48a173626f9c2da886233c65f4e5ce46">shmemUnmap</a>(<a class="code hl_struct" href="structSharedMemory.html">SharedMemory</a>* s);</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="comment"></span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="comment">/**</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="comment"> * @brief Retrieves the mapped address of a shared memory object.</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="comment"> * @param s Shared memory information structure.</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="comment"> * @return Mapped address of the shared memory object.</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="comment"> */</span></div>
<div class="foldopen" id="foldopen00058" data-start="{" data-end="}">
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"><a class="line" href="shmem_8h.html#aa423982e9d4f14d4ce4c95e47bb753f1"> 58</a></span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span>* <a class="code hl_function" href="shmem_8h.html#aa423982e9d4f14d4ce4c95e47bb753f1">shmemGetAddr</a>(<a class="code hl_struct" href="structSharedMemory.html">SharedMemory</a>* s) {</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="keywordflow">return</span> s-&gt;<a class="code hl_variable" href="structSharedMemory.html#acf0a958021ceccf8499f44a804a81877">map_addr</a>;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span>}</div>
</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="comment"></span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="comment">/**</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="comment"> * @brief Frees up resources used by a shared memory object, unmapping and closing handles, etc.</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="comment"> * @param s Shared memory information structure.</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="comment"> * @return Result code.</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="comment"> */</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="shmem_8h.html#ac63a2544e4cc95f05058f05dc3f734e7"> 67</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="shmem_8h.html#ac63a2544e4cc95f05058f05dc3f734e7">shmemClose</a>(<a class="code hl_struct" href="structSharedMemory.html">SharedMemory</a>* s);</div>
<div class="ttc" id="ashmem_8h_html_a48a173626f9c2da886233c65f4e5ce46"><div class="ttname"><a href="shmem_8h.html#a48a173626f9c2da886233c65f4e5ce46">shmemUnmap</a></div><div class="ttdeci">Result shmemUnmap(SharedMemory *s)</div><div class="ttdoc">Unmaps a shared memory object.</div></div>
<div class="ttc" id="ashmem_8h_html_a956a6fc9e616b26dd7b22771053bbe14"><div class="ttname"><a href="shmem_8h.html#a956a6fc9e616b26dd7b22771053bbe14">shmemLoadRemote</a></div><div class="ttdeci">void shmemLoadRemote(SharedMemory *s, Handle handle, size_t size, Permission perm)</div><div class="ttdoc">Loads a shared memory object coming from a remote process.</div></div>
<div class="ttc" id="ashmem_8h_html_aa423982e9d4f14d4ce4c95e47bb753f1"><div class="ttname"><a href="shmem_8h.html#aa423982e9d4f14d4ce4c95e47bb753f1">shmemGetAddr</a></div><div class="ttdeci">static void * shmemGetAddr(SharedMemory *s)</div><div class="ttdoc">Retrieves the mapped address of a shared memory object.</div><div class="ttdef"><b>Definition</b> shmem.h:58</div></div>
<div class="ttc" id="ashmem_8h_html_ab1c35fb61dd2fe994b17221f292c3ac9"><div class="ttname"><a href="shmem_8h.html#ab1c35fb61dd2fe994b17221f292c3ac9">shmemMap</a></div><div class="ttdeci">Result shmemMap(SharedMemory *s)</div><div class="ttdoc">Maps a shared memory object.</div></div>
<div class="ttc" id="ashmem_8h_html_ac4ef5e2675caed34565bf106863a5542"><div class="ttname"><a href="shmem_8h.html#ac4ef5e2675caed34565bf106863a5542">shmemCreate</a></div><div class="ttdeci">Result shmemCreate(SharedMemory *s, size_t size, Permission local_perm, Permission remote_perm)</div><div class="ttdoc">Creates a shared memory object.</div></div>
<div class="ttc" id="ashmem_8h_html_ac63a2544e4cc95f05058f05dc3f734e7"><div class="ttname"><a href="shmem_8h.html#ac63a2544e4cc95f05058f05dc3f734e7">shmemClose</a></div><div class="ttdeci">Result shmemClose(SharedMemory *s)</div><div class="ttdoc">Frees up resources used by a shared memory object, unmapping and closing handles, etc.</div></div>
<div class="ttc" id="astructSharedMemory_html"><div class="ttname"><a href="structSharedMemory.html">SharedMemory</a></div><div class="ttdoc">Shared memory information structure.</div><div class="ttdef"><b>Definition</b> shmem.h:12</div></div>
<div class="ttc" id="astructSharedMemory_html_a3dd5fde72c6ea2c28b09d1bb659331cc"><div class="ttname"><a href="structSharedMemory.html#a3dd5fde72c6ea2c28b09d1bb659331cc">SharedMemory::size</a></div><div class="ttdeci">size_t size</div><div class="ttdoc">Size of the shared memory object.</div><div class="ttdef"><b>Definition</b> shmem.h:14</div></div>
<div class="ttc" id="astructSharedMemory_html_a67180a14a5bd90113a324d74015c47d4"><div class="ttname"><a href="structSharedMemory.html#a67180a14a5bd90113a324d74015c47d4">SharedMemory::perm</a></div><div class="ttdeci">Permission perm</div><div class="ttdoc">Permissions.</div><div class="ttdef"><b>Definition</b> shmem.h:15</div></div>
<div class="ttc" id="astructSharedMemory_html_a9c593fcc08559bd1bd938bcd8d8647ad"><div class="ttname"><a href="structSharedMemory.html#a9c593fcc08559bd1bd938bcd8d8647ad">SharedMemory::handle</a></div><div class="ttdeci">Handle handle</div><div class="ttdoc">Kernel object handle.</div><div class="ttdef"><b>Definition</b> shmem.h:13</div></div>
<div class="ttc" id="astructSharedMemory_html_acf0a958021ceccf8499f44a804a81877"><div class="ttname"><a href="structSharedMemory.html#acf0a958021ceccf8499f44a804a81877">SharedMemory::map_addr</a></div><div class="ttdeci">void * map_addr</div><div class="ttdoc">Address to which the shared memory object is mapped.</div><div class="ttdef"><b>Definition</b> shmem.h:16</div></div>
<div class="ttc" id="asvc_8h_html_a1474fa581c530fcdc28ca0a11770200c"><div class="ttname"><a href="svc_8h.html#a1474fa581c530fcdc28ca0a11770200c">Permission</a></div><div class="ttdeci">Permission</div><div class="ttdoc">Memory permission bitmasks.</div><div class="ttdef"><b>Definition</b> svc.h:80</div></div>
<div class="ttc" id="atypes_8h_html_ab6d744c6b5de129f12937e482dc674fb"><div class="ttname"><a href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a></div><div class="ttdeci">u32 Handle</div><div class="ttdoc">Kernel object handle.</div><div class="ttdef"><b>Definition</b> types.h:43</div></div>
<div class="ttc" id="atypes_8h_html_ad1be2721625a17f1be47fac918032afe"><div class="ttname"><a href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a></div><div class="ttdeci">u32 Result</div><div class="ttdoc">Function error code result type.</div><div class="ttdef"><b>Definition</b> types.h:44</div></div>
</div><!-- fragment --></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>