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/thread_8h.html
WinterMute bf00061749 Deploying to gh-pages from @ 29f6f4fa7a 🚀
2025-05-08 06:59:12 +00:00

565 lines
31 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/thread.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="#nested-classes">Data Structures</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">thread.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Multi-threading support.
<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 />
<code>#include &quot;<a class="el" href="thread__context_8h_source.html">../arm/thread_context.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="wait_8h_source.html">wait.h</a>&quot;</code><br />
</div>
<p><a href="thread_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="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structThread.html">Thread</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structThread.html" title="Thread information structure.">Thread</a> information structure. <a href="structThread.html#details">More...</a><br /></td></tr>
<tr class="separator:"><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:a2e6e3f29723798d9a913e15f75ad739a" id="r_a2e6e3f29723798d9a913e15f75ad739a"><td class="memItemLeft" align="right" valign="top"><a id="a2e6e3f29723798d9a913e15f75ad739a" name="a2e6e3f29723798d9a913e15f75ad739a"></a>
static <a class="el" href="structWaiter.html">Waiter</a>&#160;</td><td class="memItemRight" valign="bottom"><b>waiterForThread</b> (<a class="el" href="structThread.html">Thread</a> *t)</td></tr>
<tr class="memdesc:a2e6e3f29723798d9a913e15f75ad739a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a <a class="el" href="structWaiter.html">Waiter</a> for a <a class="el" href="structThread.html">Thread</a>. <br /></td></tr>
<tr class="separator:a2e6e3f29723798d9a913e15f75ad739a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e364a2e5a676593ee47b4dd394bae37" id="r_a1e364a2e5a676593ee47b4dd394bae37"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#a1e364a2e5a676593ee47b4dd394bae37">threadCreate</a> (<a class="el" href="structThread.html">Thread</a> *t, <a class="el" href="types_8h.html#a857e4e893f41191500e83c00058df64e">ThreadFunc</a> entry, void *arg, void *stack_mem, size_t stack_sz, int prio, int cpuid)</td></tr>
<tr class="memdesc:a1e364a2e5a676593ee47b4dd394bae37"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a thread. <br /></td></tr>
<tr class="separator:a1e364a2e5a676593ee47b4dd394bae37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a281fc7ada387987bb234e8c720623c70" id="r_a281fc7ada387987bb234e8c720623c70"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#a281fc7ada387987bb234e8c720623c70">threadStart</a> (<a class="el" href="structThread.html">Thread</a> *t)</td></tr>
<tr class="memdesc:a281fc7ada387987bb234e8c720623c70"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts the execution of a thread. <br /></td></tr>
<tr class="separator:a281fc7ada387987bb234e8c720623c70"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2bf2e2199de56b7b481fc56bbb5e0596" id="r_a2bf2e2199de56b7b481fc56bbb5e0596"><td class="memItemLeft" align="right" valign="top"><a id="a2bf2e2199de56b7b481fc56bbb5e0596" name="a2bf2e2199de56b7b481fc56bbb5e0596"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>threadExit</b> (void)</td></tr>
<tr class="memdesc:a2bf2e2199de56b7b481fc56bbb5e0596"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exits the current thread immediately. <br /></td></tr>
<tr class="separator:a2bf2e2199de56b7b481fc56bbb5e0596"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf3971a364d3b4acc51a9acab8fb48ca" id="r_abf3971a364d3b4acc51a9acab8fb48ca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#abf3971a364d3b4acc51a9acab8fb48ca">threadWaitForExit</a> (<a class="el" href="structThread.html">Thread</a> *t)</td></tr>
<tr class="memdesc:abf3971a364d3b4acc51a9acab8fb48ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Waits for a thread to finish executing. <br /></td></tr>
<tr class="separator:abf3971a364d3b4acc51a9acab8fb48ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a164dae120ea7ccfb6046a1bddebb67ee" id="r_a164dae120ea7ccfb6046a1bddebb67ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#a164dae120ea7ccfb6046a1bddebb67ee">threadClose</a> (<a class="el" href="structThread.html">Thread</a> *t)</td></tr>
<tr class="memdesc:a164dae120ea7ccfb6046a1bddebb67ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Frees up resources associated with a thread. <br /></td></tr>
<tr class="separator:a164dae120ea7ccfb6046a1bddebb67ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a641f84744cafc196900726d7fe05c535" id="r_a641f84744cafc196900726d7fe05c535"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#a641f84744cafc196900726d7fe05c535">threadPause</a> (<a class="el" href="structThread.html">Thread</a> *t)</td></tr>
<tr class="memdesc:a641f84744cafc196900726d7fe05c535"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pauses the execution of a thread. <br /></td></tr>
<tr class="separator:a641f84744cafc196900726d7fe05c535"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39a3b6584e8926f9ebea9bb7cb4383e3" id="r_a39a3b6584e8926f9ebea9bb7cb4383e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#a39a3b6584e8926f9ebea9bb7cb4383e3">threadResume</a> (<a class="el" href="structThread.html">Thread</a> *t)</td></tr>
<tr class="memdesc:a39a3b6584e8926f9ebea9bb7cb4383e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resumes the execution of a thread, after having been paused. <br /></td></tr>
<tr class="separator:a39a3b6584e8926f9ebea9bb7cb4383e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a62ab4a6b389d55dfcbd3e5888c956477" id="r_a62ab4a6b389d55dfcbd3e5888c956477"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#a62ab4a6b389d55dfcbd3e5888c956477">threadDumpContext</a> (<a class="el" href="structThreadContext.html">ThreadContext</a> *ctx, <a class="el" href="structThread.html">Thread</a> *t)</td></tr>
<tr class="memdesc:a62ab4a6b389d55dfcbd3e5888c956477"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dumps the registers of a thread paused by <a class="el" href="thread_8h.html#a641f84744cafc196900726d7fe05c535">threadPause</a> (register groups: all). <br /></td></tr>
<tr class="separator:a62ab4a6b389d55dfcbd3e5888c956477"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9bd639e8dce00938edad775ac2a265e0" id="r_a9bd639e8dce00938edad775ac2a265e0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structThread.html">Thread</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#a9bd639e8dce00938edad775ac2a265e0">threadGetSelf</a> (void)</td></tr>
<tr class="memdesc:a9bd639e8dce00938edad775ac2a265e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets a pointer to the current thread structure. <br /></td></tr>
<tr class="separator:a9bd639e8dce00938edad775ac2a265e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1e73de2d30787392ce4c6e5e95863ec" id="r_ab1e73de2d30787392ce4c6e5e95863ec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#ab1e73de2d30787392ce4c6e5e95863ec">threadGetCurHandle</a> (void)</td></tr>
<tr class="memdesc:ab1e73de2d30787392ce4c6e5e95863ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the raw handle to the current thread. <br /></td></tr>
<tr class="separator:ab1e73de2d30787392ce4c6e5e95863ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4f9356f6c1ca991a5aac1ee3f4a48fb6" id="r_a4f9356f6c1ca991a5aac1ee3f4a48fb6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#a4f9356f6c1ca991a5aac1ee3f4a48fb6">threadTlsAlloc</a> (void(*destructor)(void *))</td></tr>
<tr class="memdesc:a4f9356f6c1ca991a5aac1ee3f4a48fb6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocates a TLS slot. <br /></td></tr>
<tr class="separator:a4f9356f6c1ca991a5aac1ee3f4a48fb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef4eb92dd60d717dd4ab7a4f9dc5ff50" id="r_aef4eb92dd60d717dd4ab7a4f9dc5ff50"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#aef4eb92dd60d717dd4ab7a4f9dc5ff50">threadTlsGet</a> (<a class="el" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> slot_id)</td></tr>
<tr class="memdesc:aef4eb92dd60d717dd4ab7a4f9dc5ff50"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the value stored in a TLS slot. <br /></td></tr>
<tr class="separator:aef4eb92dd60d717dd4ab7a4f9dc5ff50"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d3610073ab88b78191d779a421386b2" id="r_a3d3610073ab88b78191d779a421386b2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#a3d3610073ab88b78191d779a421386b2">threadTlsSet</a> (<a class="el" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> slot_id, void *value)</td></tr>
<tr class="memdesc:a3d3610073ab88b78191d779a421386b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stores the specified value into a TLS slot. <br /></td></tr>
<tr class="separator:a3d3610073ab88b78191d779a421386b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d9bfdfcf558827a48a5e5057e145f19" id="r_a4d9bfdfcf558827a48a5e5057e145f19"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="thread_8h.html#a4d9bfdfcf558827a48a5e5057e145f19">threadTlsFree</a> (<a class="el" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> slot_id)</td></tr>
<tr class="memdesc:a4d9bfdfcf558827a48a5e5057e145f19"><td class="mdescLeft">&#160;</td><td class="mdescRight">Frees a TLS slot. <br /></td></tr>
<tr class="separator:a4d9bfdfcf558827a48a5e5057e145f19"><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>Multi-threading support. </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="a164dae120ea7ccfb6046a1bddebb67ee" name="a164dae120ea7ccfb6046a1bddebb67ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a164dae120ea7ccfb6046a1bddebb67ee">&#9670;&#160;</a></span>threadClose()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> threadClose </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structThread.html">Thread</a> *&#160;</td>
<td class="paramname"><em>t</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Frees up resources associated with a thread. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">t</td><td><a class="el" href="structThread.html" title="Thread information structure.">Thread</a> information structure. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code. </dd></dl>
</div>
</div>
<a id="a1e364a2e5a676593ee47b4dd394bae37" name="a1e364a2e5a676593ee47b4dd394bae37"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e364a2e5a676593ee47b4dd394bae37">&#9670;&#160;</a></span>threadCreate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> threadCreate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structThread.html">Thread</a> *&#160;</td>
<td class="paramname"><em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a857e4e893f41191500e83c00058df64e">ThreadFunc</a>&#160;</td>
<td class="paramname"><em>entry</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>arg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>stack_mem</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>stack_sz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>prio</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>cpuid</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a thread. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">t</td><td><a class="el" href="structThread.html" title="Thread information structure.">Thread</a> information structure which will be filled in. </td></tr>
<tr><td class="paramname">entry</td><td>Entrypoint of the thread. </td></tr>
<tr><td class="paramname">arg</td><td>Argument to pass to the entrypoint. </td></tr>
<tr><td class="paramname">stack_mem</td><td>Memory to use as backing for stack/tls/reent. Must be page-aligned. NULL argument means to allocate new memory. </td></tr>
<tr><td class="paramname">stack_sz</td><td>If stack_mem is NULL, size to use for stack. If stack_mem is non-NULL, size to use for stack + reent + tls (must be page-aligned). </td></tr>
<tr><td class="paramname">prio</td><td><a class="el" href="structThread.html" title="Thread information structure.">Thread</a> priority (0x00~0x3F); 0x2C is the usual priority of the main thread, 0x3B is a special priority on cores 0..2 that enables preemptive multithreading (0x3F on core 3). </td></tr>
<tr><td class="paramname">cpuid</td><td>ID of the core on which to create the thread (0~3); or -2 to use the default core for the current process. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code. </dd></dl>
</div>
</div>
<a id="a62ab4a6b389d55dfcbd3e5888c956477" name="a62ab4a6b389d55dfcbd3e5888c956477"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a62ab4a6b389d55dfcbd3e5888c956477">&#9670;&#160;</a></span>threadDumpContext()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> threadDumpContext </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structThreadContext.html">ThreadContext</a> *&#160;</td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structThread.html">Thread</a> *&#160;</td>
<td class="paramname"><em>t</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Dumps the registers of a thread paused by <a class="el" href="thread_8h.html#a641f84744cafc196900726d7fe05c535">threadPause</a> (register groups: all). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">ctx</td><td>Output thread context (register dump). </td></tr>
<tr><td class="paramdir"></td><td class="paramname">t</td><td><a class="el" href="structThread.html" title="Thread information structure.">Thread</a> information structure. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code. </dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>Official kernel will not dump x0..x18 if the thread is currently executing a system call, and prior to 6.0.0 doesn't dump TPIDR_EL0. </dd></dl>
</div>
</div>
<a id="ab1e73de2d30787392ce4c6e5e95863ec" name="ab1e73de2d30787392ce4c6e5e95863ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab1e73de2d30787392ce4c6e5e95863ec">&#9670;&#160;</a></span>threadGetCurHandle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> threadGetCurHandle </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the raw handle to the current thread. </p>
<dl class="section return"><dt>Returns</dt><dd>The current thread's handle. </dd></dl>
</div>
</div>
<a id="a9bd639e8dce00938edad775ac2a265e0" name="a9bd639e8dce00938edad775ac2a265e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9bd639e8dce00938edad775ac2a265e0">&#9670;&#160;</a></span>threadGetSelf()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structThread.html">Thread</a> * threadGetSelf </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets a pointer to the current thread structure. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="structThread.html" title="Thread information structure.">Thread</a> information structure. </dd></dl>
</div>
</div>
<a id="a641f84744cafc196900726d7fe05c535" name="a641f84744cafc196900726d7fe05c535"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a641f84744cafc196900726d7fe05c535">&#9670;&#160;</a></span>threadPause()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> threadPause </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structThread.html">Thread</a> *&#160;</td>
<td class="paramname"><em>t</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Pauses the execution of a thread. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">t</td><td><a class="el" href="structThread.html" title="Thread information structure.">Thread</a> information structure. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code. </dd></dl>
</div>
</div>
<a id="a39a3b6584e8926f9ebea9bb7cb4383e3" name="a39a3b6584e8926f9ebea9bb7cb4383e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39a3b6584e8926f9ebea9bb7cb4383e3">&#9670;&#160;</a></span>threadResume()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> threadResume </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structThread.html">Thread</a> *&#160;</td>
<td class="paramname"><em>t</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resumes the execution of a thread, after having been paused. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">t</td><td><a class="el" href="structThread.html" title="Thread information structure.">Thread</a> information structure. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code. </dd></dl>
</div>
</div>
<a id="a281fc7ada387987bb234e8c720623c70" name="a281fc7ada387987bb234e8c720623c70"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a281fc7ada387987bb234e8c720623c70">&#9670;&#160;</a></span>threadStart()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> threadStart </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structThread.html">Thread</a> *&#160;</td>
<td class="paramname"><em>t</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Starts the execution of a thread. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">t</td><td><a class="el" href="structThread.html" title="Thread information structure.">Thread</a> information structure. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code. </dd></dl>
</div>
</div>
<a id="a4f9356f6c1ca991a5aac1ee3f4a48fb6" name="a4f9356f6c1ca991a5aac1ee3f4a48fb6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f9356f6c1ca991a5aac1ee3f4a48fb6">&#9670;&#160;</a></span>threadTlsAlloc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> threadTlsAlloc </td>
<td>(</td>
<td class="paramtype">void(*)(void *)&#160;</td>
<td class="paramname"><em>destructor</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocates a TLS slot. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">destructor</td><td>Function to run automatically when a thread exits. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TLS slot ID on success, or a negative value on failure. </dd></dl>
</div>
</div>
<a id="a4d9bfdfcf558827a48a5e5057e145f19" name="a4d9bfdfcf558827a48a5e5057e145f19"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d9bfdfcf558827a48a5e5057e145f19">&#9670;&#160;</a></span>threadTlsFree()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void threadTlsFree </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a>&#160;</td>
<td class="paramname"><em>slot_id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Frees a TLS slot. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">slot_id</td><td>TLS slot ID. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aef4eb92dd60d717dd4ab7a4f9dc5ff50" name="aef4eb92dd60d717dd4ab7a4f9dc5ff50"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef4eb92dd60d717dd4ab7a4f9dc5ff50">&#9670;&#160;</a></span>threadTlsGet()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void * threadTlsGet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a>&#160;</td>
<td class="paramname"><em>slot_id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the value stored in a TLS slot. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">slot_id</td><td>TLS slot ID. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Value. </dd></dl>
</div>
</div>
<a id="a3d3610073ab88b78191d779a421386b2" name="a3d3610073ab88b78191d779a421386b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d3610073ab88b78191d779a421386b2">&#9670;&#160;</a></span>threadTlsSet()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void threadTlsSet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a>&#160;</td>
<td class="paramname"><em>slot_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>value</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Stores the specified value into a TLS slot. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">slot_id</td><td>TLS slot ID. </td></tr>
<tr><td class="paramname">value</td><td>Value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="abf3971a364d3b4acc51a9acab8fb48ca" name="abf3971a364d3b4acc51a9acab8fb48ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf3971a364d3b4acc51a9acab8fb48ca">&#9670;&#160;</a></span>threadWaitForExit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> threadWaitForExit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structThread.html">Thread</a> *&#160;</td>
<td class="paramname"><em>t</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Waits for a thread to finish executing. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">t</td><td><a class="el" href="structThread.html" title="Thread information structure.">Thread</a> information structure. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code. </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>
Reference in New Issue View Git Blame Copy Permalink