<!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/jit.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"> 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&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&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&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">jit.h</div></div>
</div><!--header-->
<div class="contents">
<a href="jit_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 jit.h</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * @brief Just-in-time compilation support.</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 "../types.h"</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include "<a class="code" href="virtmem_8h.html">virtmem.h</a>"</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">/// JIT implementation type.</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="jit_8h.html#a35d64f85c128c4c58e61c24cf8175872"> 12</a></span><span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="jit_8h.html#a35d64f85c128c4c58e61c24cf8175872a0b485e66e1fa34dccc98b6ff8488580c"> 13</a></span> <a class="code hl_enumvalue" href="jit_8h.html#a35d64f85c128c4c58e61c24cf8175872a0b485e66e1fa34dccc98b6ff8488580c">JitType_SetProcessMemoryPermission</a>, <span class="comment">///< JIT supported using svcSetProcessMemoryPermission</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="jit_8h.html#a35d64f85c128c4c58e61c24cf8175872a64d499093babc8b73b12ef7e32a781e9"> 14</a></span> <a class="code hl_enumvalue" href="jit_8h.html#a35d64f85c128c4c58e61c24cf8175872a64d499093babc8b73b12ef7e32a781e9">JitType_CodeMemory</a>, <span class="comment">///< JIT supported using [4.0.0+] CodeMemory syscalls</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span>} <a class="code hl_enumeration" href="jit_8h.html#a35d64f85c128c4c58e61c24cf8175872">JitType</a>;</div>
</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"></span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">/// JIT buffer object.</span></div>
<div class="foldopen" id="foldopen00018" data-start="{" data-end="};">
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="structJit.html"> 18</a></span><span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <a class="code hl_enumeration" href="jit_8h.html#a35d64f85c128c4c58e61c24cf8175872">JitType</a> type;</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keywordtype">size_t</span> size;</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <span class="keywordtype">void</span>* src_addr;</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <span class="keywordtype">void</span>* rx_addr;</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keywordtype">void</span>* rw_addr;</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="keywordtype">bool</span> is_executable;</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">union </span>{</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <a class="code hl_typedef" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> handle;</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <a class="code hl_typedef" href="virtmem_8h.html#afc213e69b0fd5a6e8a4554529098bc76">VirtmemReservation</a>* rv;</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> };</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span>} <a class="code hl_struct" href="structJit.html">Jit</a>;</div>
</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">/**</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment"> * @brief Creates a JIT buffer.</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment"> * @param j JIT buffer.</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment"> * @param size Size of the JIT buffer.</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="comment"> * @return Result code.</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="jit_8h.html#a12601e99aaad5b23e405fbebbf87dfa4"> 37</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="jit_8h.html#a12601e99aaad5b23e405fbebbf87dfa4">jitCreate</a>(<a class="code hl_struct" href="structJit.html">Jit</a>* j, <span class="keywordtype">size_t</span> size);</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 Transition a JIT buffer to have writable permission.</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="comment"> * @param j JIT buffer.</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="jit_8h.html#ae878c8f659a8bf5a3942ca823b2d4905"> 44</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="jit_8h.html#ae878c8f659a8bf5a3942ca823b2d4905">jitTransitionToWritable</a>(<a class="code hl_struct" href="structJit.html">Jit</a>* j);</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 Transition a JIT buffer to have executable permission.</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="comment"> * @param j JIT buffer.</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="jit_8h.html#a5698d206d20e80d764f26779a85339c1"> 51</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="jit_8h.html#a5698d206d20e80d764f26779a85339c1">jitTransitionToExecutable</a>(<a class="code hl_struct" href="structJit.html">Jit</a>* j);</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 Destroys a JIT buffer.</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="comment"> * @param j JIT buffer.</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="comment"> * @return Result code.</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="comment"> */</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"><a class="line" href="jit_8h.html#a874636f211bd919bac5a58806640e55e"> 58</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="jit_8h.html#a874636f211bd919bac5a58806640e55e">jitClose</a>(<a class="code hl_struct" href="structJit.html">Jit</a>* j);</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="comment"></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"> 61</span><span class="comment"> * @brief Gets the address of the writable memory alias of a JIT buffer.</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="comment"> * @param j JIT buffer.</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="comment"> * @return Pointer to alias of the JIT buffer that can be written to.</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="comment"> */</span></div>
<div class="foldopen" id="foldopen00065" data-start="{" data-end="}">
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="jit_8h.html#af5a5feb4ef2c28fb926a5116ed802473"> 65</a></span><a class="code hl_define" href="types_8h.html#ae2a0903442f062ed4f9f0568a6f1a297">NX_CONSTEXPR</a> <span class="keywordtype">void</span>* <a class="code hl_function" href="jit_8h.html#af5a5feb4ef2c28fb926a5116ed802473">jitGetRwAddr</a>(<a class="code hl_struct" href="structJit.html">Jit</a>* j) {</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="keywordflow">return</span> j->rw_addr;</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span>}</div>
</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="comment"></span> </div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span><span class="comment">/**</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><span class="comment"> * @brief Gets the address of the executable memory alias of a JIT buffer.</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span><span class="comment"> * @param j JIT buffer.</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><span class="comment"> * @return Pointer to alias of the JIT buffer that can be executed.</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span><span class="comment"> */</span></div>
<div class="foldopen" id="foldopen00074" data-start="{" data-end="}">
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="jit_8h.html#a265921b3af1150007ab9b3febb858f36"> 74</a></span><a class="code hl_define" href="types_8h.html#ae2a0903442f062ed4f9f0568a6f1a297">NX_CONSTEXPR</a> <span class="keywordtype">void</span>* <a class="code hl_function" href="jit_8h.html#a265921b3af1150007ab9b3febb858f36">jitGetRxAddr</a>(<a class="code hl_struct" href="structJit.html">Jit</a>* j) {</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keywordflow">return</span> j->rx_addr;</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span>}</div>
</div>
<div class="ttc" id="ajit_8h_html_a12601e99aaad5b23e405fbebbf87dfa4"><div class="ttname"><a href="jit_8h.html#a12601e99aaad5b23e405fbebbf87dfa4">jitCreate</a></div><div class="ttdeci">Result jitCreate(Jit *j, size_t size)</div><div class="ttdoc">Creates a JIT buffer.</div></div>
<div class="ttc" id="ajit_8h_html_a265921b3af1150007ab9b3febb858f36"><div class="ttname"><a href="jit_8h.html#a265921b3af1150007ab9b3febb858f36">jitGetRxAddr</a></div><div class="ttdeci">static void * jitGetRxAddr(Jit *j)</div><div class="ttdoc">Gets the address of the executable memory alias of a JIT buffer.</div><div class="ttdef"><b>Definition</b> jit.h:74</div></div>
<div class="ttc" id="ajit_8h_html_a35d64f85c128c4c58e61c24cf8175872"><div class="ttname"><a href="jit_8h.html#a35d64f85c128c4c58e61c24cf8175872">JitType</a></div><div class="ttdeci">JitType</div><div class="ttdoc">JIT implementation type.</div><div class="ttdef"><b>Definition</b> jit.h:12</div></div>
<div class="ttc" id="ajit_8h_html_a35d64f85c128c4c58e61c24cf8175872a0b485e66e1fa34dccc98b6ff8488580c"><div class="ttname"><a href="jit_8h.html#a35d64f85c128c4c58e61c24cf8175872a0b485e66e1fa34dccc98b6ff8488580c">JitType_SetProcessMemoryPermission</a></div><div class="ttdeci">@ JitType_SetProcessMemoryPermission</div><div class="ttdoc">JIT supported using svcSetProcessMemoryPermission.</div><div class="ttdef"><b>Definition</b> jit.h:13</div></div>
<div class="ttc" id="ajit_8h_html_a35d64f85c128c4c58e61c24cf8175872a64d499093babc8b73b12ef7e32a781e9"><div class="ttname"><a href="jit_8h.html#a35d64f85c128c4c58e61c24cf8175872a64d499093babc8b73b12ef7e32a781e9">JitType_CodeMemory</a></div><div class="ttdeci">@ JitType_CodeMemory</div><div class="ttdoc">JIT supported using [4.0.0+] CodeMemory syscalls.</div><div class="ttdef"><b>Definition</b> jit.h:14</div></div>
<div class="ttc" id="ajit_8h_html_a5698d206d20e80d764f26779a85339c1"><div class="ttname"><a href="jit_8h.html#a5698d206d20e80d764f26779a85339c1">jitTransitionToExecutable</a></div><div class="ttdeci">Result jitTransitionToExecutable(Jit *j)</div><div class="ttdoc">Transition a JIT buffer to have executable permission.</div></div>
<div class="ttc" id="ajit_8h_html_a874636f211bd919bac5a58806640e55e"><div class="ttname"><a href="jit_8h.html#a874636f211bd919bac5a58806640e55e">jitClose</a></div><div class="ttdeci">Result jitClose(Jit *j)</div><div class="ttdoc">Destroys a JIT buffer.</div></div>
<div class="ttc" id="ajit_8h_html_ae878c8f659a8bf5a3942ca823b2d4905"><div class="ttname"><a href="jit_8h.html#ae878c8f659a8bf5a3942ca823b2d4905">jitTransitionToWritable</a></div><div class="ttdeci">Result jitTransitionToWritable(Jit *j)</div><div class="ttdoc">Transition a JIT buffer to have writable permission.</div></div>
<div class="ttc" id="ajit_8h_html_af5a5feb4ef2c28fb926a5116ed802473"><div class="ttname"><a href="jit_8h.html#af5a5feb4ef2c28fb926a5116ed802473">jitGetRwAddr</a></div><div class="ttdeci">static void * jitGetRwAddr(Jit *j)</div><div class="ttdoc">Gets the address of the writable memory alias of a JIT buffer.</div><div class="ttdef"><b>Definition</b> jit.h:65</div></div>
<div class="ttc" id="astructJit_html"><div class="ttname"><a href="structJit.html">Jit</a></div><div class="ttdoc">JIT buffer object.</div><div class="ttdef"><b>Definition</b> jit.h:18</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 class="ttc" id="atypes_8h_html_ae2a0903442f062ed4f9f0568a6f1a297"><div class="ttname"><a href="types_8h.html#ae2a0903442f062ed4f9f0568a6f1a297">NX_CONSTEXPR</a></div><div class="ttdeci">#define NX_CONSTEXPR</div><div class="ttdoc">Flags a function as constexpr in C++14 and above; or as (always) inline otherwise.</div><div class="ttdef"><b>Definition</b> types.h:92</div></div>
<div class="ttc" id="avirtmem_8h_html"><div class="ttname"><a href="virtmem_8h.html">virtmem.h</a></div><div class="ttdoc">Virtual memory mapping utilities.</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 <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>