mirror of
https://github.com/encounter/libnx.git
synced 2026-03-30 11:18:54 -07:00
doozer-agent
115 lines
20 KiB
HTML
115 lines
20 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.11"/>
|
|
<title>libnx: include/switch/kernel/thread.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>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</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 style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">libnx
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.11 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>Globals</span></a></li>
|
|
</ul>
|
|
</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">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</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">thread.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="thread_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/**</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * @file thread.h</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * @brief Multi-threading support</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * @author plutoo</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * @copyright libnx Authors</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> */</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "../types.h"</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">/// Thread information structure.</span></div><div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="structThread.html"> 11</a></span> <span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div><div class="line"><a name="l00012"></a><span class="lineno"><a class="line" href="structThread.html#a68b9cab9abef37893b71336c787ac05f"> 12</a></span>  <a class="code" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> <a class="code" href="structThread.html#a68b9cab9abef37893b71336c787ac05f">handle</a>; <span class="comment">///< Thread handle.</span></div><div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="structThread.html#adb295e5e7964c105e6eae2e698f4a2b7"> 13</a></span> <span class="comment"></span> <span class="keywordtype">void</span>* <a class="code" href="structThread.html#adb295e5e7964c105e6eae2e698f4a2b7">stack_mem</a>; <span class="comment">///< Pointer to stack memory.</span></div><div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="structThread.html#aebce2668b5d18cfeb413757b1db7d7c7"> 14</a></span> <span class="comment"></span> <span class="keywordtype">void</span>* <a class="code" href="structThread.html#aebce2668b5d18cfeb413757b1db7d7c7">stack_mirror</a>; <span class="comment">///< Pointer to stack memory mirror.</span></div><div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="structThread.html#a82427b1fb4f606b4cbbecb22b8fe15e3"> 15</a></span> <span class="comment"></span> <span class="keywordtype">size_t</span> <a class="code" href="structThread.html#a82427b1fb4f606b4cbbecb22b8fe15e3">stack_sz</a>; <span class="comment">///< Stack size.</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"></span>} <a class="code" href="structThread.html">Thread</a>;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"></span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">/**</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * @brief Creates a thread.</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * @param t Thread information structure which will be filled in.</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * @param entry Entrypoint of the thread.</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * @param arg Argument to pass to the entrypoint.</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * @param stack_sz Stack size (rounded up to page alignment).</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * @param prio Thread priority (0x00~0x3F); 0x2C is the usual priority of the main thread.</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * @param cpuid ID of the core on which to create the thread (0~3); or -2 to use the default core for the current process.</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * @return Result code.</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> */</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <a class="code" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code" href="thread_8h.html#a54c3fafd57aa167f1c15c4aaccd650cb">threadCreate</a>(</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <a class="code" href="structThread.html">Thread</a>* t, <a class="code" href="types_8h.html#a857e4e893f41191500e83c00058df64e">ThreadFunc</a> entry, <span class="keywordtype">void</span>* arg, <span class="keywordtype">size_t</span> stack_sz, <span class="keywordtype">int</span> prio,</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keywordtype">int</span> cpuid);</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"></span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">/**</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> * @brief Starts the execution of a thread.</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> * @param t Thread information structure.</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> * @return Result code.</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> */</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <a class="code" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code" href="thread_8h.html#a281fc7ada387987bb234e8c720623c70">threadStart</a>(<a class="code" href="structThread.html">Thread</a>* t);</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"></span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">/**</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * @brief Waits for a thread to finish executing.</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * @param t Thread information structure.</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * @return Result code.</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> */</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <a class="code" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code" href="thread_8h.html#abf3971a364d3b4acc51a9acab8fb48ca">threadWaitForExit</a>(<a class="code" href="structThread.html">Thread</a>* t);</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"></span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">/**</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * @brief Frees up resources associated with a thread.</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * @param t Thread information structure.</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * @return Result code.</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> */</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <a class="code" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code" href="thread_8h.html#a164dae120ea7ccfb6046a1bddebb67ee">threadClose</a>(<a class="code" href="structThread.html">Thread</a>* t);</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"></span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">/**</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * @brief Pauses the execution of a thread.</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * @param t Thread information structure.</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * @return Result code.</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> * @warning This is a privileged operation; in normal circumstances applications cannot use this function.</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> */</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <a class="code" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code" href="thread_8h.html#a641f84744cafc196900726d7fe05c535">threadPause</a>(<a class="code" href="structThread.html">Thread</a>* t);</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"></span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">/**</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * @brief Resumes the execution of a thread, after having been paused.</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> * @param t Thread information structure.</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * @return Result code.</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * @warning This is a privileged operation; in normal circumstances applications cannot use this function.</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> */</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <a class="code" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code" href="thread_8h.html#a39a3b6584e8926f9ebea9bb7cb4383e3">threadResume</a>(<a class="code" href="structThread.html">Thread</a>* t);</div><div class="ttc" id="types_8h_html_a857e4e893f41191500e83c00058df64e"><div class="ttname"><a href="types_8h.html#a857e4e893f41191500e83c00058df64e">ThreadFunc</a></div><div class="ttdeci">void(* ThreadFunc)(void *)</div><div class="ttdoc">Thread entrypoint function. </div><div class="ttdef"><b>Definition:</b> types.h:47</div></div>
|
|
<div class="ttc" id="structThread_html_a68b9cab9abef37893b71336c787ac05f"><div class="ttname"><a href="structThread.html#a68b9cab9abef37893b71336c787ac05f">Thread::handle</a></div><div class="ttdeci">Handle handle</div><div class="ttdoc">Thread handle. </div><div class="ttdef"><b>Definition:</b> thread.h:12</div></div>
|
|
<div class="ttc" id="thread_8h_html_a281fc7ada387987bb234e8c720623c70"><div class="ttname"><a href="thread_8h.html#a281fc7ada387987bb234e8c720623c70">threadStart</a></div><div class="ttdeci">Result threadStart(Thread *t)</div><div class="ttdoc">Starts the execution of a thread. </div></div>
|
|
<div class="ttc" id="types_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:45</div></div>
|
|
<div class="ttc" id="types_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:46</div></div>
|
|
<div class="ttc" id="thread_8h_html_a39a3b6584e8926f9ebea9bb7cb4383e3"><div class="ttname"><a href="thread_8h.html#a39a3b6584e8926f9ebea9bb7cb4383e3">threadResume</a></div><div class="ttdeci">Result threadResume(Thread *t)</div><div class="ttdoc">Resumes the execution of a thread, after having been paused. </div></div>
|
|
<div class="ttc" id="structThread_html_a82427b1fb4f606b4cbbecb22b8fe15e3"><div class="ttname"><a href="structThread.html#a82427b1fb4f606b4cbbecb22b8fe15e3">Thread::stack_sz</a></div><div class="ttdeci">size_t stack_sz</div><div class="ttdoc">Stack size. </div><div class="ttdef"><b>Definition:</b> thread.h:15</div></div>
|
|
<div class="ttc" id="thread_8h_html_a54c3fafd57aa167f1c15c4aaccd650cb"><div class="ttname"><a href="thread_8h.html#a54c3fafd57aa167f1c15c4aaccd650cb">threadCreate</a></div><div class="ttdeci">Result threadCreate(Thread *t, ThreadFunc entry, void *arg, size_t stack_sz, int prio, int cpuid)</div><div class="ttdoc">Creates a thread. </div></div>
|
|
<div class="ttc" id="thread_8h_html_a164dae120ea7ccfb6046a1bddebb67ee"><div class="ttname"><a href="thread_8h.html#a164dae120ea7ccfb6046a1bddebb67ee">threadClose</a></div><div class="ttdeci">Result threadClose(Thread *t)</div><div class="ttdoc">Frees up resources associated with a thread. </div></div>
|
|
<div class="ttc" id="thread_8h_html_abf3971a364d3b4acc51a9acab8fb48ca"><div class="ttname"><a href="thread_8h.html#abf3971a364d3b4acc51a9acab8fb48ca">threadWaitForExit</a></div><div class="ttdeci">Result threadWaitForExit(Thread *t)</div><div class="ttdoc">Waits for a thread to finish executing. </div></div>
|
|
<div class="ttc" id="structThread_html_adb295e5e7964c105e6eae2e698f4a2b7"><div class="ttname"><a href="structThread.html#adb295e5e7964c105e6eae2e698f4a2b7">Thread::stack_mem</a></div><div class="ttdeci">void * stack_mem</div><div class="ttdoc">Pointer to stack memory. </div><div class="ttdef"><b>Definition:</b> thread.h:13</div></div>
|
|
<div class="ttc" id="structThread_html_aebce2668b5d18cfeb413757b1db7d7c7"><div class="ttname"><a href="structThread.html#aebce2668b5d18cfeb413757b1db7d7c7">Thread::stack_mirror</a></div><div class="ttdeci">void * stack_mirror</div><div class="ttdoc">Pointer to stack memory mirror. </div><div class="ttdef"><b>Definition:</b> thread.h:14</div></div>
|
|
<div class="ttc" id="thread_8h_html_a641f84744cafc196900726d7fe05c535"><div class="ttname"><a href="thread_8h.html#a641f84744cafc196900726d7fe05c535">threadPause</a></div><div class="ttdeci">Result threadPause(Thread *t)</div><div class="ttdoc">Pauses the execution of a thread. </div></div>
|
|
<div class="ttc" id="structThread_html"><div class="ttname"><a href="structThread.html">Thread</a></div><div class="ttdoc">Thread information structure. </div><div class="ttdef"><b>Definition:</b> thread.h:11</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.11
|
|
</small></address>
|
|
</body>
|
|
</html>
|