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

398 lines
20 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/mutex.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">mutex.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Mutex synchronization primitive.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;sys/lock.h&gt;</code><br />
<code>#include &quot;<a class="el" href="types_8h_source.html">../types.h</a>&quot;</code><br />
</div>
<p><a href="mutex_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:a2d649c880d4330dc891cda67837eb897" id="r_a2d649c880d4330dc891cda67837eb897"><td class="memItemLeft" align="right" valign="top"><a id="a2d649c880d4330dc891cda67837eb897" name="a2d649c880d4330dc891cda67837eb897"></a>
typedef _LOCK_T&#160;</td><td class="memItemRight" valign="bottom"><b>Mutex</b></td></tr>
<tr class="memdesc:a2d649c880d4330dc891cda67837eb897"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mutex datatype, defined in newlib. <br /></td></tr>
<tr class="separator:a2d649c880d4330dc891cda67837eb897"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f2d4d58b8e3fd8af6e0bf3209fb156c" id="r_a2f2d4d58b8e3fd8af6e0bf3209fb156c"><td class="memItemLeft" align="right" valign="top"><a id="a2f2d4d58b8e3fd8af6e0bf3209fb156c" name="a2f2d4d58b8e3fd8af6e0bf3209fb156c"></a>
typedef _LOCK_RECURSIVE_T&#160;</td><td class="memItemRight" valign="bottom"><b>RMutex</b></td></tr>
<tr class="memdesc:a2f2d4d58b8e3fd8af6e0bf3209fb156c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Recursive mutex datatype, defined in newlib. <br /></td></tr>
<tr class="separator:a2f2d4d58b8e3fd8af6e0bf3209fb156c"><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:a5b5f4842680656dda447d2f46011ccbd" id="r_a5b5f4842680656dda447d2f46011ccbd"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mutex_8h.html#a5b5f4842680656dda447d2f46011ccbd">mutexInit</a> (<a class="el" href="mutex_8h.html#a2d649c880d4330dc891cda67837eb897">Mutex</a> *m)</td></tr>
<tr class="memdesc:a5b5f4842680656dda447d2f46011ccbd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes a mutex. <br /></td></tr>
<tr class="separator:a5b5f4842680656dda447d2f46011ccbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8fca41abd240c6c5d41554d36eaebc17" id="r_a8fca41abd240c6c5d41554d36eaebc17"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mutex_8h.html#a8fca41abd240c6c5d41554d36eaebc17">mutexLock</a> (<a class="el" href="mutex_8h.html#a2d649c880d4330dc891cda67837eb897">Mutex</a> *m)</td></tr>
<tr class="memdesc:a8fca41abd240c6c5d41554d36eaebc17"><td class="mdescLeft">&#160;</td><td class="mdescRight">Locks a mutex. <br /></td></tr>
<tr class="separator:a8fca41abd240c6c5d41554d36eaebc17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a70bddc6f3b732a315d4004656988d6bc" id="r_a70bddc6f3b732a315d4004656988d6bc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mutex_8h.html#a70bddc6f3b732a315d4004656988d6bc">mutexTryLock</a> (<a class="el" href="mutex_8h.html#a2d649c880d4330dc891cda67837eb897">Mutex</a> *m)</td></tr>
<tr class="memdesc:a70bddc6f3b732a315d4004656988d6bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attempts to lock a mutex without waiting. <br /></td></tr>
<tr class="separator:a70bddc6f3b732a315d4004656988d6bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a502b8f0e525b7c32cdd204a4949a24b3" id="r_a502b8f0e525b7c32cdd204a4949a24b3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mutex_8h.html#a502b8f0e525b7c32cdd204a4949a24b3">mutexUnlock</a> (<a class="el" href="mutex_8h.html#a2d649c880d4330dc891cda67837eb897">Mutex</a> *m)</td></tr>
<tr class="memdesc:a502b8f0e525b7c32cdd204a4949a24b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unlocks a mutex. <br /></td></tr>
<tr class="separator:a502b8f0e525b7c32cdd204a4949a24b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae31cc20ba6bad0525a37c5de42fe38a" id="r_aae31cc20ba6bad0525a37c5de42fe38a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mutex_8h.html#aae31cc20ba6bad0525a37c5de42fe38a">mutexIsLockedByCurrentThread</a> (const <a class="el" href="mutex_8h.html#a2d649c880d4330dc891cda67837eb897">Mutex</a> *m)</td></tr>
<tr class="memdesc:aae31cc20ba6bad0525a37c5de42fe38a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets whether the current thread owns the mutex. <br /></td></tr>
<tr class="separator:aae31cc20ba6bad0525a37c5de42fe38a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af486c816008970eaf842c56b9a20dd60" id="r_af486c816008970eaf842c56b9a20dd60"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mutex_8h.html#af486c816008970eaf842c56b9a20dd60">rmutexInit</a> (<a class="el" href="mutex_8h.html#a2f2d4d58b8e3fd8af6e0bf3209fb156c">RMutex</a> *m)</td></tr>
<tr class="memdesc:af486c816008970eaf842c56b9a20dd60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes a recursive mutex. <br /></td></tr>
<tr class="separator:af486c816008970eaf842c56b9a20dd60"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab19f58528e1ab9616bc5a59266a0ed20" id="r_ab19f58528e1ab9616bc5a59266a0ed20"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mutex_8h.html#ab19f58528e1ab9616bc5a59266a0ed20">rmutexLock</a> (<a class="el" href="mutex_8h.html#a2f2d4d58b8e3fd8af6e0bf3209fb156c">RMutex</a> *m)</td></tr>
<tr class="memdesc:ab19f58528e1ab9616bc5a59266a0ed20"><td class="mdescLeft">&#160;</td><td class="mdescRight">Locks a recursive mutex. <br /></td></tr>
<tr class="separator:ab19f58528e1ab9616bc5a59266a0ed20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68584b2a443d389834e492eaf54e4b2f" id="r_a68584b2a443d389834e492eaf54e4b2f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mutex_8h.html#a68584b2a443d389834e492eaf54e4b2f">rmutexTryLock</a> (<a class="el" href="mutex_8h.html#a2f2d4d58b8e3fd8af6e0bf3209fb156c">RMutex</a> *m)</td></tr>
<tr class="memdesc:a68584b2a443d389834e492eaf54e4b2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attempts to lock a recursive mutex without waiting. <br /></td></tr>
<tr class="separator:a68584b2a443d389834e492eaf54e4b2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a96a01191d7aa5c3d6444e0467a96bdb1" id="r_a96a01191d7aa5c3d6444e0467a96bdb1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mutex_8h.html#a96a01191d7aa5c3d6444e0467a96bdb1">rmutexUnlock</a> (<a class="el" href="mutex_8h.html#a2f2d4d58b8e3fd8af6e0bf3209fb156c">RMutex</a> *m)</td></tr>
<tr class="memdesc:a96a01191d7aa5c3d6444e0467a96bdb1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unlocks a recursive mutex. <br /></td></tr>
<tr class="separator:a96a01191d7aa5c3d6444e0467a96bdb1"><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>Mutex synchronization primitive. </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="a5b5f4842680656dda447d2f46011ccbd" name="a5b5f4842680656dda447d2f46011ccbd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5b5f4842680656dda447d2f46011ccbd">&#9670;&#160;</a></span>mutexInit()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void mutexInit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="mutex_8h.html#a2d649c880d4330dc891cda67837eb897">Mutex</a> *&#160;</td>
<td class="paramname"><em>m</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes a mutex. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">m</td><td>Mutex object. </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>A mutex can also be statically initialized by assigning 0 to it. </dd></dl>
</div>
</div>
<a id="aae31cc20ba6bad0525a37c5de42fe38a" name="aae31cc20ba6bad0525a37c5de42fe38a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae31cc20ba6bad0525a37c5de42fe38a">&#9670;&#160;</a></span>mutexIsLockedByCurrentThread()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mutexIsLockedByCurrentThread </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="mutex_8h.html#a2d649c880d4330dc891cda67837eb897">Mutex</a> *&#160;</td>
<td class="paramname"><em>m</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets whether the current thread owns the mutex. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">m</td><td>Mutex object. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if the mutex is locked by the current thread, and 0 otherwise. </dd></dl>
</div>
</div>
<a id="a8fca41abd240c6c5d41554d36eaebc17" name="a8fca41abd240c6c5d41554d36eaebc17"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8fca41abd240c6c5d41554d36eaebc17">&#9670;&#160;</a></span>mutexLock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mutexLock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="mutex_8h.html#a2d649c880d4330dc891cda67837eb897">Mutex</a> *&#160;</td>
<td class="paramname"><em>m</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Locks a mutex. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">m</td><td>Mutex object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a70bddc6f3b732a315d4004656988d6bc" name="a70bddc6f3b732a315d4004656988d6bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a70bddc6f3b732a315d4004656988d6bc">&#9670;&#160;</a></span>mutexTryLock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mutexTryLock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="mutex_8h.html#a2d649c880d4330dc891cda67837eb897">Mutex</a> *&#160;</td>
<td class="paramname"><em>m</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Attempts to lock a mutex without waiting. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">m</td><td>Mutex object. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if the mutex has been acquired successfully, and 0 on contention. </dd></dl>
</div>
</div>
<a id="a502b8f0e525b7c32cdd204a4949a24b3" name="a502b8f0e525b7c32cdd204a4949a24b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a502b8f0e525b7c32cdd204a4949a24b3">&#9670;&#160;</a></span>mutexUnlock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mutexUnlock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="mutex_8h.html#a2d649c880d4330dc891cda67837eb897">Mutex</a> *&#160;</td>
<td class="paramname"><em>m</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unlocks a mutex. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">m</td><td>Mutex object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af486c816008970eaf842c56b9a20dd60" name="af486c816008970eaf842c56b9a20dd60"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af486c816008970eaf842c56b9a20dd60">&#9670;&#160;</a></span>rmutexInit()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void rmutexInit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="mutex_8h.html#a2f2d4d58b8e3fd8af6e0bf3209fb156c">RMutex</a> *&#160;</td>
<td class="paramname"><em>m</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes a recursive mutex. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">m</td><td>Recursive mutex object. </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>A recursive mutex can also be statically initialized by assigning {0,0,0} to it. </dd></dl>
</div>
</div>
<a id="ab19f58528e1ab9616bc5a59266a0ed20" name="ab19f58528e1ab9616bc5a59266a0ed20"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab19f58528e1ab9616bc5a59266a0ed20">&#9670;&#160;</a></span>rmutexLock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void rmutexLock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="mutex_8h.html#a2f2d4d58b8e3fd8af6e0bf3209fb156c">RMutex</a> *&#160;</td>
<td class="paramname"><em>m</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Locks a recursive mutex. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">m</td><td>Recursive mutex object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a68584b2a443d389834e492eaf54e4b2f" name="a68584b2a443d389834e492eaf54e4b2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68584b2a443d389834e492eaf54e4b2f">&#9670;&#160;</a></span>rmutexTryLock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool rmutexTryLock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="mutex_8h.html#a2f2d4d58b8e3fd8af6e0bf3209fb156c">RMutex</a> *&#160;</td>
<td class="paramname"><em>m</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Attempts to lock a recursive mutex without waiting. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">m</td><td>Recursive mutex object. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if the mutex has been acquired successfully, and 0 on contention. </dd></dl>
</div>
</div>
<a id="a96a01191d7aa5c3d6444e0467a96bdb1" name="a96a01191d7aa5c3d6444e0467a96bdb1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a96a01191d7aa5c3d6444e0467a96bdb1">&#9670;&#160;</a></span>rmutexUnlock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void rmutexUnlock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="mutex_8h.html#a2f2d4d58b8e3fd8af6e0bf3209fb156c">RMutex</a> *&#160;</td>
<td class="paramname"><em>m</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unlocks a recursive mutex. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">m</td><td>Recursive mutex object. </td></tr>
</table>
</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>