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

150 lines
16 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/semaphore.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">&#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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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">semaphore.h</div></div>
</div><!--header-->
<div class="contents">
<a href="semaphore_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 semaphore.h</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * @brief Thread synchronization based on Mutex.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * @author SciresM &amp; Kevoot</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> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &quot;<a class="code" href="mutex_8h.html">mutex.h</a>&quot;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &quot;<a class="code" href="condvar_8h.html">condvar.h</a>&quot;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"></span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment">/// Semaphore structure.</span></div>
<div class="foldopen" id="foldopen00013" data-start="{" data-end="};">
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="structSemaphore.html"> 13</a></span><span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structSemaphore.html">Semaphore</a></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span>{</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="structSemaphore.html#a58d1de265eea9c1737b9d00a0f1cb85e"> 15</a></span> <a class="code hl_typedef" href="condvar_8h.html#aae8dd0591cb6fe4a1077118947220f55">CondVar</a> <a class="code hl_variable" href="structSemaphore.html#a58d1de265eea9c1737b9d00a0f1cb85e">condvar</a>; <span class="comment">///&lt; Condition variable object.</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="structSemaphore.html#a6a8cf19bce5a0f126ee0280a836a2d55"> 16</a></span> <a class="code hl_typedef" href="mutex_8h.html#a2d649c880d4330dc891cda67837eb897">Mutex</a> <a class="code hl_variable" href="structSemaphore.html#a6a8cf19bce5a0f126ee0280a836a2d55">mutex</a>; <span class="comment">///&lt; Mutex object.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="structSemaphore.html#ab4ea5daa18bcbc2eb9e93b1f95b15db7"> 17</a></span> <a class="code hl_typedef" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> <a class="code hl_variable" href="structSemaphore.html#ab4ea5daa18bcbc2eb9e93b1f95b15db7">count</a>; <span class="comment">///&lt; Internal counter.</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span>} <a class="code hl_struct" href="structSemaphore.html">Semaphore</a>;</div>
</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment"></span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment">/**</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment"> * @brief Initializes a semaphore and its internal counter.</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment"> * @param s Semaphore object.</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment"> * @param initial_count initial value for internal counter (typically the # of free resources).</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="comment"> */</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="semaphore_8h.html#acc3585d7e0aaa4ca8b95321dc638fcf9"> 25</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="semaphore_8h.html#acc3585d7e0aaa4ca8b95321dc638fcf9">semaphoreInit</a>(<a class="code hl_struct" href="structSemaphore.html">Semaphore</a> *s, <a class="code hl_typedef" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> initial_count);</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="comment"></span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="comment">/**</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment"> * @brief Increments the Semaphore to allow other threads to continue.</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment"> * @param s Semaphore object.</span></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"><a class="line" href="semaphore_8h.html#a5a5384a10c64d23211c388b18a9e114a"> 31</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="semaphore_8h.html#a5a5384a10c64d23211c388b18a9e114a">semaphoreSignal</a>(<a class="code hl_struct" href="structSemaphore.html">Semaphore</a> *s);</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment"></span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment">/**</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment"> * @brief Decrements Semaphore and waits if 0.</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="comment"> * @param s Semaphore object.</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="semaphore_8h.html#a5ad05e570f1a4fe64219f282795c016b"> 37</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="semaphore_8h.html#a5ad05e570f1a4fe64219f282795c016b">semaphoreWait</a>(<a class="code hl_struct" href="structSemaphore.html">Semaphore</a> *s);</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 Attempts to get lock without waiting.</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="comment"> * @param s Semaphore object.</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment"> * @return true if no wait and successful lock, false otherwise.</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="semaphore_8h.html#a4a50b81a6d719096449f7f6f2e9f728c"> 44</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="semaphore_8h.html#a4a50b81a6d719096449f7f6f2e9f728c">semaphoreTryWait</a>(<a class="code hl_struct" href="structSemaphore.html">Semaphore</a> *s);</div>
<div class="ttc" id="acondvar_8h_html"><div class="ttname"><a href="condvar_8h.html">condvar.h</a></div><div class="ttdoc">Condition variable synchronization primitive.</div></div>
<div class="ttc" id="acondvar_8h_html_aae8dd0591cb6fe4a1077118947220f55"><div class="ttname"><a href="condvar_8h.html#aae8dd0591cb6fe4a1077118947220f55">CondVar</a></div><div class="ttdeci">u32 CondVar</div><div class="ttdoc">Condition variable.</div><div class="ttdef"><b>Definition</b> condvar.h:13</div></div>
<div class="ttc" id="amutex_8h_html"><div class="ttname"><a href="mutex_8h.html">mutex.h</a></div><div class="ttdoc">Mutex synchronization primitive.</div></div>
<div class="ttc" id="amutex_8h_html_a2d649c880d4330dc891cda67837eb897"><div class="ttname"><a href="mutex_8h.html#a2d649c880d4330dc891cda67837eb897">Mutex</a></div><div class="ttdeci">_LOCK_T Mutex</div><div class="ttdoc">Mutex datatype, defined in newlib.</div><div class="ttdef"><b>Definition</b> mutex.h:12</div></div>
<div class="ttc" id="asemaphore_8h_html_a4a50b81a6d719096449f7f6f2e9f728c"><div class="ttname"><a href="semaphore_8h.html#a4a50b81a6d719096449f7f6f2e9f728c">semaphoreTryWait</a></div><div class="ttdeci">bool semaphoreTryWait(Semaphore *s)</div><div class="ttdoc">Attempts to get lock without waiting.</div></div>
<div class="ttc" id="asemaphore_8h_html_a5a5384a10c64d23211c388b18a9e114a"><div class="ttname"><a href="semaphore_8h.html#a5a5384a10c64d23211c388b18a9e114a">semaphoreSignal</a></div><div class="ttdeci">void semaphoreSignal(Semaphore *s)</div><div class="ttdoc">Increments the Semaphore to allow other threads to continue.</div></div>
<div class="ttc" id="asemaphore_8h_html_a5ad05e570f1a4fe64219f282795c016b"><div class="ttname"><a href="semaphore_8h.html#a5ad05e570f1a4fe64219f282795c016b">semaphoreWait</a></div><div class="ttdeci">void semaphoreWait(Semaphore *s)</div><div class="ttdoc">Decrements Semaphore and waits if 0.</div></div>
<div class="ttc" id="asemaphore_8h_html_acc3585d7e0aaa4ca8b95321dc638fcf9"><div class="ttname"><a href="semaphore_8h.html#acc3585d7e0aaa4ca8b95321dc638fcf9">semaphoreInit</a></div><div class="ttdeci">void semaphoreInit(Semaphore *s, u64 initial_count)</div><div class="ttdoc">Initializes a semaphore and its internal counter.</div></div>
<div class="ttc" id="astructSemaphore_html"><div class="ttname"><a href="structSemaphore.html">Semaphore</a></div><div class="ttdoc">Semaphore structure.</div><div class="ttdef"><b>Definition</b> semaphore.h:14</div></div>
<div class="ttc" id="astructSemaphore_html_a58d1de265eea9c1737b9d00a0f1cb85e"><div class="ttname"><a href="structSemaphore.html#a58d1de265eea9c1737b9d00a0f1cb85e">Semaphore::condvar</a></div><div class="ttdeci">CondVar condvar</div><div class="ttdoc">Condition variable object.</div><div class="ttdef"><b>Definition</b> semaphore.h:15</div></div>
<div class="ttc" id="astructSemaphore_html_a6a8cf19bce5a0f126ee0280a836a2d55"><div class="ttname"><a href="structSemaphore.html#a6a8cf19bce5a0f126ee0280a836a2d55">Semaphore::mutex</a></div><div class="ttdeci">Mutex mutex</div><div class="ttdoc">Mutex object.</div><div class="ttdef"><b>Definition</b> semaphore.h:16</div></div>
<div class="ttc" id="astructSemaphore_html_ab4ea5daa18bcbc2eb9e93b1f95b15db7"><div class="ttname"><a href="structSemaphore.html#ab4ea5daa18bcbc2eb9e93b1f95b15db7">Semaphore::count</a></div><div class="ttdeci">u64 count</div><div class="ttdoc">Internal counter.</div><div class="ttdef"><b>Definition</b> semaphore.h:17</div></div>
<div class="ttc" id="atypes_8h_html_a3f7e2bcbb0b4c338f3c4f6c937cd4234"><div class="ttname"><a href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a></div><div class="ttdeci">uint64_t u64</div><div class="ttdoc">64-bit unsigned integer.</div><div class="ttdef"><b>Definition</b> types.h:22</div></div>
</div><!-- fragment --></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