mirror of
https://github.com/switchbrew/libnx.git
synced 2025-06-21 04:22:50 +02:00
133 lines
12 KiB
HTML
133 lines
12 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/barrier.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"> 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&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&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&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">barrier.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="barrier_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 barrier.h</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * @brief Multi-threading Barrier</span></div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * @author tatehaga</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><span class="preprocessor">#include "<a class="code" href="mutex_8h.html">mutex.h</a>"</span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include "<a class="code" href="condvar_8h.html">condvar.h</a>"</span></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">/// Barrier structure.</span></div>
|
|
<div class="foldopen" id="foldopen00012" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="structBarrier.html"> 12</a></span><span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structBarrier.html">Barrier</a> {</div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="structBarrier.html#a5da27132f46badbfe624f87f794c86eb"> 13</a></span> <a class="code hl_typedef" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> <a class="code hl_variable" href="structBarrier.html#a5da27132f46badbfe624f87f794c86eb">count</a>; <span class="comment">///< Number of threads to reach the barrier.</span></div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="structBarrier.html#a956d4371005f216a2183066f9590fdc3"> 14</a></span> <a class="code hl_typedef" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> <a class="code hl_variable" href="structBarrier.html#a956d4371005f216a2183066f9590fdc3">total</a>; <span class="comment">///< Number of threads to wait on.</span></div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <a class="code hl_typedef" href="mutex_8h.html#a2d649c880d4330dc891cda67837eb897">Mutex</a> mutex;</div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> <a class="code hl_typedef" href="condvar_8h.html#aae8dd0591cb6fe4a1077118947220f55">CondVar</a> condvar;</div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span>} <a class="code hl_struct" href="structBarrier.html">Barrier</a>;</div>
|
|
</div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"></span> </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"> * @brief Initializes a barrier and the number of threads to wait on.</span></div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment"> * @param b Barrier object.</span></div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment"> * @param thread_count Initial value for the number of threads the barrier must wait for.</span></div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="barrier_8h.html#a807691f9f0a35b34c44706a1bc5437f0"> 24</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="barrier_8h.html#a807691f9f0a35b34c44706a1bc5437f0">barrierInit</a>(<a class="code hl_struct" href="structBarrier.html">Barrier</a> *b, <a class="code hl_typedef" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> thread_count);</div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment"></span> </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"> * @brief Forces threads to wait until all threads have called barrierWait.</span></div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment"> * @param b Barrier object.</span></div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="barrier_8h.html#a51bb52b30e28ec5a469e50bf99011cdd"> 30</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="barrier_8h.html#a51bb52b30e28ec5a469e50bf99011cdd">barrierWait</a>(<a class="code hl_struct" href="structBarrier.html">Barrier</a> *b);</div>
|
|
<div class="ttc" id="abarrier_8h_html_a51bb52b30e28ec5a469e50bf99011cdd"><div class="ttname"><a href="barrier_8h.html#a51bb52b30e28ec5a469e50bf99011cdd">barrierWait</a></div><div class="ttdeci">void barrierWait(Barrier *b)</div><div class="ttdoc">Forces threads to wait until all threads have called barrierWait.</div></div>
|
|
<div class="ttc" id="abarrier_8h_html_a807691f9f0a35b34c44706a1bc5437f0"><div class="ttname"><a href="barrier_8h.html#a807691f9f0a35b34c44706a1bc5437f0">barrierInit</a></div><div class="ttdeci">void barrierInit(Barrier *b, u64 thread_count)</div><div class="ttdoc">Initializes a barrier and the number of threads to wait on.</div></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="astructBarrier_html"><div class="ttname"><a href="structBarrier.html">Barrier</a></div><div class="ttdoc">Barrier structure.</div><div class="ttdef"><b>Definition</b> barrier.h:12</div></div>
|
|
<div class="ttc" id="astructBarrier_html_a5da27132f46badbfe624f87f794c86eb"><div class="ttname"><a href="structBarrier.html#a5da27132f46badbfe624f87f794c86eb">Barrier::count</a></div><div class="ttdeci">u64 count</div><div class="ttdoc">Number of threads to reach the barrier.</div><div class="ttdef"><b>Definition</b> barrier.h:13</div></div>
|
|
<div class="ttc" id="astructBarrier_html_a956d4371005f216a2183066f9590fdc3"><div class="ttname"><a href="structBarrier.html#a956d4371005f216a2183066f9590fdc3">Barrier::total</a></div><div class="ttdeci">u64 total</div><div class="ttdoc">Number of threads to wait on.</div><div class="ttdef"><b>Definition</b> barrier.h:14</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 <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>
|