wut/group__coreinit__fastmutex.html
2020-03-26 16:49:18 +11:00

343 lines
17 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">
<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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>wut: Fast Mutex</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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">wut
&#160;<span id="projectnumber">1.0.0-beta9</span>
</div>
<div id="projectbrief">Wii U Toolchain</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- 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 class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Fast Mutex<div class="ingroups"><a class="el" href="group__coreinit.html">coreinit</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:structOSFastMutexLink"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__fastmutex.html#structOSFastMutexLink">OSFastMutexLink</a></td></tr>
<tr class="separator:structOSFastMutexLink"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:structOSFastMutex"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__fastmutex.html#structOSFastMutex">OSFastMutex</a></td></tr>
<tr class="separator:structOSFastMutex"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gaa4219c81acd042a06aeea86a482eb6a3"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__fastmutex.html#gaa4219c81acd042a06aeea86a482eb6a3">OS_FAST_MUTEX_TAG</a>&#160;&#160;&#160;0x664D7458u</td></tr>
<tr class="separator:gaa4219c81acd042a06aeea86a482eb6a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga1a46c02caff79a13ecf041e55a454696"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__coreinit__fastmutex.html#structOSFastMutex">OSFastMutex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__fastmutex.html#ga1a46c02caff79a13ecf041e55a454696">OSFastMutex</a></td></tr>
<tr class="separator:ga1a46c02caff79a13ecf041e55a454696"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaef0985d566ee3706b739e0c302177b56"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__coreinit__fastmutex.html#structOSFastMutexLink">OSFastMutexLink</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__fastmutex.html#gaef0985d566ee3706b739e0c302177b56">OSFastMutexLink</a></td></tr>
<tr class="separator:gaef0985d566ee3706b739e0c302177b56"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga784c1f297785a31abbf82704dd60f98c"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__coreinit__fastcond.html#structOSFastCondition">OSFastCondition</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__fastmutex.html#ga784c1f297785a31abbf82704dd60f98c">OSFastCondition</a></td></tr>
<tr class="separator:ga784c1f297785a31abbf82704dd60f98c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga996895e65c693a3a052498849dd922ee"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__fastmutex.html#ga996895e65c693a3a052498849dd922ee">OSFastMutex_Init</a> (<a class="el" href="group__coreinit__fastmutex.html#structOSFastMutex">OSFastMutex</a> *mutex, const char *name)</td></tr>
<tr class="separator:ga996895e65c693a3a052498849dd922ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga68e24274234702d41d36ed206cdbfe1d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__fastmutex.html#ga68e24274234702d41d36ed206cdbfe1d">OSFastMutex_Lock</a> (<a class="el" href="group__coreinit__fastmutex.html#structOSFastMutex">OSFastMutex</a> *mutex)</td></tr>
<tr class="separator:ga68e24274234702d41d36ed206cdbfe1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab1cc24eee4a6b3bace1a511b4d4b03cf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__fastmutex.html#gab1cc24eee4a6b3bace1a511b4d4b03cf">OSFastMutex_Unlock</a> (<a class="el" href="group__coreinit__fastmutex.html#structOSFastMutex">OSFastMutex</a> *mutex)</td></tr>
<tr class="separator:gab1cc24eee4a6b3bace1a511b4d4b03cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac4a61678d2b5f0aa5c7e0fac167297e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__fastmutex.html#gac4a61678d2b5f0aa5c7e0fac167297e3">OSFastMutex_TryLock</a> (<a class="el" href="group__coreinit__fastmutex.html#structOSFastMutex">OSFastMutex</a> *mutex)</td></tr>
<tr class="separator:gac4a61678d2b5f0aa5c7e0fac167297e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Similar to <a class="el" href="group__coreinit__mutex.html#structOSMutex">OSMutex</a> but tries to acquire the mutex without using the global scheduler lock, and does not test for thread cancel. </p>
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
<a name="structOSFastMutexLink" id="structOSFastMutexLink"></a>
<h2 class="memtitle"><span class="permalink"><a href="#structOSFastMutexLink">&#9670;&nbsp;</a></span>OSFastMutexLink</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct OSFastMutexLink</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="fastmutex_8h_source.html#l00022">22</a> of file <a class="el" href="fastmutex_8h_source.html">fastmutex.h</a>.</p>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a id="a1c63da7e950aca2219132b3e699c5b22"></a><a class="el" href="group__coreinit__fastmutex.html#structOSFastMutex">OSFastMutex</a> *</td>
<td class="fieldname">
next</td>
<td class="fielddoc">
</td></tr>
<tr><td class="fieldtype">
<a id="aa5326d186503dd5d8a77ee48493b5221"></a><a class="el" href="group__coreinit__fastmutex.html#structOSFastMutex">OSFastMutex</a> *</td>
<td class="fieldname">
prev</td>
<td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<a name="structOSFastMutex" id="structOSFastMutex"></a>
<h2 class="memtitle"><span class="permalink"><a href="#structOSFastMutex">&#9670;&nbsp;</a></span>OSFastMutex</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct OSFastMutex</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="fastmutex_8h_source.html#l00033">33</a> of file <a class="el" href="fastmutex_8h_source.html">fastmutex.h</a>.</p>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a id="a1c50fcd1195659821729f52af8f3bb7d"></a>uint32_t</td>
<td class="fieldname">
tag</td>
<td class="fielddoc">
</td></tr>
<tr><td class="fieldtype">
<a id="a8f8f80d37794cde9472343e4487ba3eb"></a>const char *</td>
<td class="fieldname">
name</td>
<td class="fielddoc">
</td></tr>
<tr><td class="fieldtype">
<a id="aca875af83d051fe0792ad13654a2e445"></a><a class="el" href="group__coreinit__threadq.html#structOSThreadSimpleQueue">OSThreadSimpleQueue</a></td>
<td class="fieldname">
queue</td>
<td class="fielddoc">
</td></tr>
<tr><td class="fieldtype">
<a id="afa8c319f706a6446c1309c1734a51110"></a><a class="el" href="group__coreinit__fastmutex.html#structOSFastMutexLink">OSFastMutexLink</a></td>
<td class="fieldname">
link</td>
<td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="gaa4219c81acd042a06aeea86a482eb6a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa4219c81acd042a06aeea86a482eb6a3">&#9670;&nbsp;</a></span>OS_FAST_MUTEX_TAG</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define OS_FAST_MUTEX_TAG&#160;&#160;&#160;0x664D7458u</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="fastmutex_8h_source.html#l00031">31</a> of file <a class="el" href="fastmutex_8h_source.html">fastmutex.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga1a46c02caff79a13ecf041e55a454696"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1a46c02caff79a13ecf041e55a454696">&#9670;&nbsp;</a></span>OSFastMutex</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="group__coreinit__fastmutex.html#structOSFastMutex">OSFastMutex</a> <a class="el" href="group__coreinit__fastmutex.html#structOSFastMutex">OSFastMutex</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="fastmutex_8h_source.html#l00018">18</a> of file <a class="el" href="fastmutex_8h_source.html">fastmutex.h</a>.</p>
</div>
</div>
<a id="gaef0985d566ee3706b739e0c302177b56"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaef0985d566ee3706b739e0c302177b56">&#9670;&nbsp;</a></span>OSFastMutexLink</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="group__coreinit__fastmutex.html#structOSFastMutexLink">OSFastMutexLink</a> <a class="el" href="group__coreinit__fastmutex.html#structOSFastMutexLink">OSFastMutexLink</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="fastmutex_8h_source.html#l00019">19</a> of file <a class="el" href="fastmutex_8h_source.html">fastmutex.h</a>.</p>
</div>
</div>
<a id="ga784c1f297785a31abbf82704dd60f98c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga784c1f297785a31abbf82704dd60f98c">&#9670;&nbsp;</a></span>OSFastCondition</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="group__coreinit__fastcond.html#structOSFastCondition">OSFastCondition</a> <a class="el" href="group__coreinit__fastcond.html#structOSFastCondition">OSFastCondition</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="fastmutex_8h_source.html#l00020">20</a> of file <a class="el" href="fastmutex_8h_source.html">fastmutex.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga996895e65c693a3a052498849dd922ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga996895e65c693a3a052498849dd922ee">&#9670;&nbsp;</a></span>OSFastMutex_Init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OSFastMutex_Init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__coreinit__fastmutex.html#structOSFastMutex">OSFastMutex</a> *&#160;</td>
<td class="paramname"><em>mutex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga68e24274234702d41d36ed206cdbfe1d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga68e24274234702d41d36ed206cdbfe1d">&#9670;&nbsp;</a></span>OSFastMutex_Lock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OSFastMutex_Lock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__coreinit__fastmutex.html#structOSFastMutex">OSFastMutex</a> *&#160;</td>
<td class="paramname"><em>mutex</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gab1cc24eee4a6b3bace1a511b4d4b03cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab1cc24eee4a6b3bace1a511b4d4b03cf">&#9670;&nbsp;</a></span>OSFastMutex_Unlock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OSFastMutex_Unlock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__coreinit__fastmutex.html#structOSFastMutex">OSFastMutex</a> *&#160;</td>
<td class="paramname"><em>mutex</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gac4a61678d2b5f0aa5c7e0fac167297e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac4a61678d2b5f0aa5c7e0fac167297e3">&#9670;&nbsp;</a></span>OSFastMutex_TryLock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a> OSFastMutex_TryLock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__coreinit__fastmutex.html#structOSFastMutex">OSFastMutex</a> *&#160;</td>
<td class="paramname"><em>mutex</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>