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

160 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/virtmem.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">virtmem.h</div></div>
</div><!--header-->
<div class="contents">
<a href="virtmem_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 virtmem.h</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * @brief Virtual memory mapping utilities</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"> */</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &quot;../types.h&quot;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"></span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment">/// Address space reservation type (see \ref virtmemAddReservation)</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="virtmem_8h.html#afc213e69b0fd5a6e8a4554529098bc76"> 11</a></span><span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_typedef" href="virtmem_8h.html#afc213e69b0fd5a6e8a4554529098bc76">VirtmemReservation</a> <a class="code hl_typedef" href="virtmem_8h.html#afc213e69b0fd5a6e8a4554529098bc76">VirtmemReservation</a>;</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"></span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment">/// Locks the virtual memory manager mutex.</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="virtmem_8h.html#aebca09781c11695dbf43e7f71fc3e544"> 14</a></span><span class="comment"></span><span class="keywordtype">void</span> <a class="code hl_function" href="virtmem_8h.html#aebca09781c11695dbf43e7f71fc3e544">virtmemLock</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"></span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment">/// Unlocks the virtual memory manager mutex.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="virtmem_8h.html#a2b4467b60b7c8a71e7ab22cb2e481cae"> 17</a></span><span class="comment"></span><span class="keywordtype">void</span> <a class="code hl_function" href="virtmem_8h.html#a2b4467b60b7c8a71e7ab22cb2e481cae">virtmemUnlock</a>(<span class="keywordtype">void</span>);</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 Finds a random slice of free general purpose address space.</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment"> * @param size Desired size of the slice (rounded up to page alignment).</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment"> * @param guard_size Desired size of the unmapped guard areas surrounding the slice (rounded up to page alignment).</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment"> * @return Pointer to the slice of address space, or NULL on failure.</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="comment"> * @note The virtual memory manager mutex must be held during the find-and-map process (see \ref virtmemLock and \ref virtmemUnlock).</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment"> */</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="virtmem_8h.html#a9ca43dde44051f59619d7af275fbcc74"> 26</a></span><span class="keywordtype">void</span>* <a class="code hl_function" href="virtmem_8h.html#a9ca43dde44051f59619d7af275fbcc74">virtmemFindAslr</a>(<span class="keywordtype">size_t</span> size, <span class="keywordtype">size_t</span> guard_size);</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"> 28</span><span class="comment">/**</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment"> * @brief Finds a random slice of free stack address space.</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment"> * @param size Desired size of the slice (rounded up to page alignment).</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment"> * @param guard_size Desired size of the unmapped guard areas surrounding the slice (rounded up to page alignment).</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment"> * @return Pointer to the slice of address space, or NULL on failure.</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment"> * @note The virtual memory manager mutex must be held during the find-and-map process (see \ref virtmemLock and \ref virtmemUnlock).</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment"> */</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="virtmem_8h.html#a1ef87e069a824315298e5c1a1bb857e0"> 35</a></span><span class="keywordtype">void</span>* <a class="code hl_function" href="virtmem_8h.html#a1ef87e069a824315298e5c1a1bb857e0">virtmemFindStack</a>(<span class="keywordtype">size_t</span> size, <span class="keywordtype">size_t</span> guard_size);</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"> 37</span><span class="comment">/**</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="comment"> * @brief Finds a random slice of free code memory address space.</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="comment"> * @param size Desired size of the slice (rounded up to page alignment).</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="comment"> * @param guard_size Desired size of the unmapped guard areas surrounding the slice (rounded up to page alignment).</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="comment"> * @return Pointer to the slice of address space, or NULL on failure.</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment"> * @note The virtual memory manager mutex must be held during the find-and-map process (see \ref virtmemLock and \ref virtmemUnlock).</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="virtmem_8h.html#aeebf6e17b30b29290273e4eeba27201e"> 44</a></span><span class="keywordtype">void</span>* <a class="code hl_function" href="virtmem_8h.html#aeebf6e17b30b29290273e4eeba27201e">virtmemFindCodeMemory</a>(<span class="keywordtype">size_t</span> size, <span class="keywordtype">size_t</span> guard_size);</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 Reserves a range of memory address space.</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="comment"> * @param mem Pointer to the address space slice.</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment"> * @param size Size of the slice.</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="comment"> * @return Pointer to a reservation object, or NULL on failure.</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="comment"> * @remark This function is intended to be used in lieu of a memory map operation when the memory won&#39;t be mapped straight away.</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="comment"> * @note The virtual memory manager mutex must be held during the find-and-reserve process (see \ref virtmemLock and \ref virtmemUnlock).</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"><a class="line" href="virtmem_8h.html#a213d5d5efc56b6b8ba909f9276016f2f"> 54</a></span><a class="code hl_typedef" href="virtmem_8h.html#afc213e69b0fd5a6e8a4554529098bc76">VirtmemReservation</a>* <a class="code hl_function" href="virtmem_8h.html#a213d5d5efc56b6b8ba909f9276016f2f">virtmemAddReservation</a>(<span class="keywordtype">void</span>* mem, <span class="keywordtype">size_t</span> size);</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="comment"></span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="comment">/**</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="comment"> * @brief Releases a memory address space reservation.</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="comment"> * @param rv Reservation to release.</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="comment"> * @note The virtual memory manager mutex must be held before calling this function (see \ref virtmemLock and \ref virtmemUnlock).</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="comment"> */</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"><a class="line" href="virtmem_8h.html#a7133c63be8fcdeb9e5307761f2e1bd68"> 61</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="virtmem_8h.html#a7133c63be8fcdeb9e5307761f2e1bd68">virtmemRemoveReservation</a>(<a class="code hl_typedef" href="virtmem_8h.html#afc213e69b0fd5a6e8a4554529098bc76">VirtmemReservation</a>* rv);</div>
<div class="ttc" id="avirtmem_8h_html_a1ef87e069a824315298e5c1a1bb857e0"><div class="ttname"><a href="virtmem_8h.html#a1ef87e069a824315298e5c1a1bb857e0">virtmemFindStack</a></div><div class="ttdeci">void * virtmemFindStack(size_t size, size_t guard_size)</div><div class="ttdoc">Finds a random slice of free stack address space.</div></div>
<div class="ttc" id="avirtmem_8h_html_a213d5d5efc56b6b8ba909f9276016f2f"><div class="ttname"><a href="virtmem_8h.html#a213d5d5efc56b6b8ba909f9276016f2f">virtmemAddReservation</a></div><div class="ttdeci">VirtmemReservation * virtmemAddReservation(void *mem, size_t size)</div><div class="ttdoc">Reserves a range of memory address space.</div></div>
<div class="ttc" id="avirtmem_8h_html_a2b4467b60b7c8a71e7ab22cb2e481cae"><div class="ttname"><a href="virtmem_8h.html#a2b4467b60b7c8a71e7ab22cb2e481cae">virtmemUnlock</a></div><div class="ttdeci">void virtmemUnlock(void)</div><div class="ttdoc">Unlocks the virtual memory manager mutex.</div></div>
<div class="ttc" id="avirtmem_8h_html_a7133c63be8fcdeb9e5307761f2e1bd68"><div class="ttname"><a href="virtmem_8h.html#a7133c63be8fcdeb9e5307761f2e1bd68">virtmemRemoveReservation</a></div><div class="ttdeci">void virtmemRemoveReservation(VirtmemReservation *rv)</div><div class="ttdoc">Releases a memory address space reservation.</div></div>
<div class="ttc" id="avirtmem_8h_html_a9ca43dde44051f59619d7af275fbcc74"><div class="ttname"><a href="virtmem_8h.html#a9ca43dde44051f59619d7af275fbcc74">virtmemFindAslr</a></div><div class="ttdeci">void * virtmemFindAslr(size_t size, size_t guard_size)</div><div class="ttdoc">Finds a random slice of free general purpose address space.</div></div>
<div class="ttc" id="avirtmem_8h_html_aebca09781c11695dbf43e7f71fc3e544"><div class="ttname"><a href="virtmem_8h.html#aebca09781c11695dbf43e7f71fc3e544">virtmemLock</a></div><div class="ttdeci">void virtmemLock(void)</div><div class="ttdoc">Locks the virtual memory manager mutex.</div></div>
<div class="ttc" id="avirtmem_8h_html_aeebf6e17b30b29290273e4eeba27201e"><div class="ttname"><a href="virtmem_8h.html#aeebf6e17b30b29290273e4eeba27201e">virtmemFindCodeMemory</a></div><div class="ttdeci">void * virtmemFindCodeMemory(size_t size, size_t guard_size)</div><div class="ttdoc">Finds a random slice of free code memory address space.</div></div>
<div class="ttc" id="avirtmem_8h_html_afc213e69b0fd5a6e8a4554529098bc76"><div class="ttname"><a href="virtmem_8h.html#afc213e69b0fd5a6e8a4554529098bc76">VirtmemReservation</a></div><div class="ttdeci">struct VirtmemReservation VirtmemReservation</div><div class="ttdoc">Address space reservation type (see virtmemAddReservation)</div><div class="ttdef"><b>Definition</b> virtmem.h:11</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>
Reference in New Issue View Git Blame Copy Permalink