1
0
mirror of https://github.com/switchbrew/libnx.git synced 2025-07-15 15:32:15 +02:00
libnx/virtmem_8h.html
2025-05-08 06:59:12 +00:00

318 lines
18 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/virtmem.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="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">virtmem.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Virtual memory mapping utilities.
<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="virtmem_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="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:afc213e69b0fd5a6e8a4554529098bc76" id="r_afc213e69b0fd5a6e8a4554529098bc76"><td class="memItemLeft" align="right" valign="top"><a id="afc213e69b0fd5a6e8a4554529098bc76" name="afc213e69b0fd5a6e8a4554529098bc76"></a>
typedef struct <a class="el" href="virtmem_8h.html#afc213e69b0fd5a6e8a4554529098bc76">VirtmemReservation</a>&#160;</td><td class="memItemRight" valign="bottom"><b>VirtmemReservation</b></td></tr>
<tr class="memdesc:afc213e69b0fd5a6e8a4554529098bc76"><td class="mdescLeft">&#160;</td><td class="mdescRight">Address space reservation type (see <a class="el" href="virtmem_8h.html#a213d5d5efc56b6b8ba909f9276016f2f">virtmemAddReservation</a>) <br /></td></tr>
<tr class="separator:afc213e69b0fd5a6e8a4554529098bc76"><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:aebca09781c11695dbf43e7f71fc3e544" id="r_aebca09781c11695dbf43e7f71fc3e544"><td class="memItemLeft" align="right" valign="top"><a id="aebca09781c11695dbf43e7f71fc3e544" name="aebca09781c11695dbf43e7f71fc3e544"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>virtmemLock</b> (void)</td></tr>
<tr class="memdesc:aebca09781c11695dbf43e7f71fc3e544"><td class="mdescLeft">&#160;</td><td class="mdescRight">Locks the virtual memory manager mutex. <br /></td></tr>
<tr class="separator:aebca09781c11695dbf43e7f71fc3e544"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b4467b60b7c8a71e7ab22cb2e481cae" id="r_a2b4467b60b7c8a71e7ab22cb2e481cae"><td class="memItemLeft" align="right" valign="top"><a id="a2b4467b60b7c8a71e7ab22cb2e481cae" name="a2b4467b60b7c8a71e7ab22cb2e481cae"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>virtmemUnlock</b> (void)</td></tr>
<tr class="memdesc:a2b4467b60b7c8a71e7ab22cb2e481cae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unlocks the virtual memory manager mutex. <br /></td></tr>
<tr class="separator:a2b4467b60b7c8a71e7ab22cb2e481cae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ca43dde44051f59619d7af275fbcc74" id="r_a9ca43dde44051f59619d7af275fbcc74"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="virtmem_8h.html#a9ca43dde44051f59619d7af275fbcc74">virtmemFindAslr</a> (size_t size, size_t guard_size)</td></tr>
<tr class="memdesc:a9ca43dde44051f59619d7af275fbcc74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finds a random slice of free general purpose address space. <br /></td></tr>
<tr class="separator:a9ca43dde44051f59619d7af275fbcc74"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ef87e069a824315298e5c1a1bb857e0" id="r_a1ef87e069a824315298e5c1a1bb857e0"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="virtmem_8h.html#a1ef87e069a824315298e5c1a1bb857e0">virtmemFindStack</a> (size_t size, size_t guard_size)</td></tr>
<tr class="memdesc:a1ef87e069a824315298e5c1a1bb857e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finds a random slice of free stack address space. <br /></td></tr>
<tr class="separator:a1ef87e069a824315298e5c1a1bb857e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeebf6e17b30b29290273e4eeba27201e" id="r_aeebf6e17b30b29290273e4eeba27201e"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="virtmem_8h.html#aeebf6e17b30b29290273e4eeba27201e">virtmemFindCodeMemory</a> (size_t size, size_t guard_size)</td></tr>
<tr class="memdesc:aeebf6e17b30b29290273e4eeba27201e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finds a random slice of free code memory address space. <br /></td></tr>
<tr class="separator:aeebf6e17b30b29290273e4eeba27201e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a213d5d5efc56b6b8ba909f9276016f2f" id="r_a213d5d5efc56b6b8ba909f9276016f2f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="virtmem_8h.html#afc213e69b0fd5a6e8a4554529098bc76">VirtmemReservation</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="virtmem_8h.html#a213d5d5efc56b6b8ba909f9276016f2f">virtmemAddReservation</a> (void *mem, size_t size)</td></tr>
<tr class="memdesc:a213d5d5efc56b6b8ba909f9276016f2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reserves a range of memory address space. <br /></td></tr>
<tr class="separator:a213d5d5efc56b6b8ba909f9276016f2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7133c63be8fcdeb9e5307761f2e1bd68" id="r_a7133c63be8fcdeb9e5307761f2e1bd68"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="virtmem_8h.html#a7133c63be8fcdeb9e5307761f2e1bd68">virtmemRemoveReservation</a> (<a class="el" href="virtmem_8h.html#afc213e69b0fd5a6e8a4554529098bc76">VirtmemReservation</a> *rv)</td></tr>
<tr class="memdesc:a7133c63be8fcdeb9e5307761f2e1bd68"><td class="mdescLeft">&#160;</td><td class="mdescRight">Releases a memory address space reservation. <br /></td></tr>
<tr class="separator:a7133c63be8fcdeb9e5307761f2e1bd68"><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>Virtual memory mapping utilities. </p>
<dl class="section author"><dt>Author</dt><dd>plutoo </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>libnx Authors </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a213d5d5efc56b6b8ba909f9276016f2f" name="a213d5d5efc56b6b8ba909f9276016f2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a213d5d5efc56b6b8ba909f9276016f2f">&#9670;&#160;</a></span>virtmemAddReservation()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="virtmem_8h.html#afc213e69b0fd5a6e8a4554529098bc76">VirtmemReservation</a> * virtmemAddReservation </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>mem</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reserves a range of memory address space. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mem</td><td>Pointer to the address space slice. </td></tr>
<tr><td class="paramname">size</td><td>Size of the slice. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to a reservation object, or NULL on failure. </dd></dl>
<dl class="section remark"><dt>Remarks</dt><dd>This function is intended to be used in lieu of a memory map operation when the memory won't be mapped straight away. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>The virtual memory manager mutex must be held during the find-and-reserve process (see <a class="el" href="virtmem_8h.html#aebca09781c11695dbf43e7f71fc3e544">virtmemLock</a> and <a class="el" href="virtmem_8h.html#a2b4467b60b7c8a71e7ab22cb2e481cae">virtmemUnlock</a>). </dd></dl>
</div>
</div>
<a id="a9ca43dde44051f59619d7af275fbcc74" name="a9ca43dde44051f59619d7af275fbcc74"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ca43dde44051f59619d7af275fbcc74">&#9670;&#160;</a></span>virtmemFindAslr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void * virtmemFindAslr </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">size_t&#160;</td>
<td class="paramname"><em>guard_size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Finds a random slice of free general purpose address space. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>Desired size of the slice (rounded up to page alignment). </td></tr>
<tr><td class="paramname">guard_size</td><td>Desired size of the unmapped guard areas surrounding the slice (rounded up to page alignment). </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to the slice of address space, or NULL on failure. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>The virtual memory manager mutex must be held during the find-and-map process (see <a class="el" href="virtmem_8h.html#aebca09781c11695dbf43e7f71fc3e544">virtmemLock</a> and <a class="el" href="virtmem_8h.html#a2b4467b60b7c8a71e7ab22cb2e481cae">virtmemUnlock</a>). </dd></dl>
</div>
</div>
<a id="aeebf6e17b30b29290273e4eeba27201e" name="aeebf6e17b30b29290273e4eeba27201e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeebf6e17b30b29290273e4eeba27201e">&#9670;&#160;</a></span>virtmemFindCodeMemory()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void * virtmemFindCodeMemory </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">size_t&#160;</td>
<td class="paramname"><em>guard_size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Finds a random slice of free code memory address space. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>Desired size of the slice (rounded up to page alignment). </td></tr>
<tr><td class="paramname">guard_size</td><td>Desired size of the unmapped guard areas surrounding the slice (rounded up to page alignment). </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to the slice of address space, or NULL on failure. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>The virtual memory manager mutex must be held during the find-and-map process (see <a class="el" href="virtmem_8h.html#aebca09781c11695dbf43e7f71fc3e544">virtmemLock</a> and <a class="el" href="virtmem_8h.html#a2b4467b60b7c8a71e7ab22cb2e481cae">virtmemUnlock</a>). </dd></dl>
</div>
</div>
<a id="a1ef87e069a824315298e5c1a1bb857e0" name="a1ef87e069a824315298e5c1a1bb857e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ef87e069a824315298e5c1a1bb857e0">&#9670;&#160;</a></span>virtmemFindStack()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void * virtmemFindStack </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">size_t&#160;</td>
<td class="paramname"><em>guard_size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Finds a random slice of free stack address space. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>Desired size of the slice (rounded up to page alignment). </td></tr>
<tr><td class="paramname">guard_size</td><td>Desired size of the unmapped guard areas surrounding the slice (rounded up to page alignment). </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to the slice of address space, or NULL on failure. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>The virtual memory manager mutex must be held during the find-and-map process (see <a class="el" href="virtmem_8h.html#aebca09781c11695dbf43e7f71fc3e544">virtmemLock</a> and <a class="el" href="virtmem_8h.html#a2b4467b60b7c8a71e7ab22cb2e481cae">virtmemUnlock</a>). </dd></dl>
</div>
</div>
<a id="a7133c63be8fcdeb9e5307761f2e1bd68" name="a7133c63be8fcdeb9e5307761f2e1bd68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7133c63be8fcdeb9e5307761f2e1bd68">&#9670;&#160;</a></span>virtmemRemoveReservation()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void virtmemRemoveReservation </td>
<td>(</td>
<td class="paramtype"><a class="el" href="virtmem_8h.html#afc213e69b0fd5a6e8a4554529098bc76">VirtmemReservation</a> *&#160;</td>
<td class="paramname"><em>rv</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Releases a memory address space reservation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rv</td><td>Reservation to release. </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>The virtual memory manager mutex must be held before calling this function (see <a class="el" href="virtmem_8h.html#aebca09781c11695dbf43e7f71fc3e544">virtmemLock</a> and <a class="el" href="virtmem_8h.html#a2b4467b60b7c8a71e7ab22cb2e481cae">virtmemUnlock</a>). </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>