Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ComputeLibrary / 975dfe175e3d7c62c27598b1c0e8e77ed90df463 / . / documentation / barrier_8hpp_source.xhtml
blob: 7d1d6e5b46c8f25d2ddca01022e0273f4938ee52 [file] [log] [blame]
Jenkins975dfe12019-09-02 11:47:54 +0100[diff] [blame^]1<!-- HTML header for doxygen 1.8.15-->
2<!-- Remember to use version doxygen 1.8.15 +-->
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml">
5<head>
6<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
7<meta http-equiv="X-UA-Compatible" content="IE=9"/>
8<meta name="generator" content="Doxygen 1.8.15"/>
9<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
10<title>Compute Library: src/core/NEON/kernels/arm_gemm/barrier.hpp Source File</title>
11<link href="tabs.css" rel="stylesheet" type="text/css"/>
12<script type="text/javascript" src="jquery.js"></script>
13<script type="text/javascript" src="dynsections.js"></script>
14<link href="navtree.css" rel="stylesheet" type="text/css"/>
15<script type="text/javascript" src="resize.js"></script>
16<script type="text/javascript" src="navtreedata.js"></script>
17<script type="text/javascript" src="navtree.js"></script>
18<script type="text/javascript">
19/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
20 $(document).ready(initResizable);
21/* @license-end */</script>
22<link href="search/search.css" rel="stylesheet" type="text/css"/>
23<script type="text/javascript" src="search/searchdata.js"></script>
24<script type="text/javascript" src="search/search.js"></script>
25<script type="text/x-mathjax-config">
26 MathJax.Hub.Config({
27 extensions: ["tex2jax.js"],
28 jax: ["input/TeX","output/HTML-CSS"],
29});
30</script><script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
31<link href="doxygen.css" rel="stylesheet" type="text/css" />
32<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
33</head>
34<body>
35<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
36<div id="titlearea">
37<table cellspacing="0" cellpadding="0">
38 <tbody>
39 <tr style="height: 56px;">
40 <img alt="Compute Library" src="https://raw.githubusercontent.com/ARM-software/ComputeLibrary/gh-pages/ACL_logo.png" style="max-width: 100%;margin-top: 15px;margin-left: 10px"/>
41 <td style="padding-left: 0.5em;">
42 <div id="projectname">
43 &#160;<span id="projectnumber">19.08</span>
44 </div>
45 </td>
46 </tr>
47 </tbody>
48</table>
49</div>
50<!-- end header part -->
51<!-- Generated by Doxygen 1.8.15 -->
52<script type="text/javascript">
53/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
54var searchBox = new SearchBox("searchBox", "search",false,'Search');
55/* @license-end */
56</script>
57<script type="text/javascript" src="menudata.js"></script>
58<script type="text/javascript" src="menu.js"></script>
59<script type="text/javascript">
60/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
61$(function() {
62 initMenu('',true,false,'search.php','Search');
63 $(document).ready(function() { init_search(); });
64});
65/* @license-end */</script>
66<div id="main-nav"></div>
67</div><!-- top -->
68<div id="side-nav" class="ui-resizable side-nav-resizable">
69 <div id="nav-tree">
70 <div id="nav-tree-contents">
71 <div id="nav-sync" class="sync"></div>
72 </div>
73 </div>
74 <div id="splitbar" style="-moz-user-select:none;"
75 class="ui-resizable-handle">
76 </div>
77</div>
78<script type="text/javascript">
79/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
80$(document).ready(function(){initNavTree('barrier_8hpp_source.xhtml','');});
81/* @license-end */
82</script>
83<div id="doc-content">
84<!-- window showing the filter options -->
85<div id="MSearchSelectWindow"
86 onmouseover="return searchBox.OnSearchSelectShow()"
87 onmouseout="return searchBox.OnSearchSelectHide()"
88 onkeydown="return searchBox.OnSearchSelectKey(event)">
89</div>
90
91<!-- iframe showing the search results (closed by default) -->
92<div id="MSearchResultsWindow">
93<iframe src="javascript:void(0)" frameborder="0"
94 name="MSearchResults" id="MSearchResults">
95</iframe>
96</div>
97
98<div class="header">
99 <div class="headertitle">
100<div class="title">barrier.hpp</div> </div>
101</div><!--header-->
102<div class="contents">
103<a href="barrier_8hpp.xhtml">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Copyright (c) 2019 ARM Limited.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * SPDX-License-Identifier: MIT</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * of this software and associated documentation files (the &quot;Software&quot;), to</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * deal in the Software without restriction, including without limitation the</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * sell copies of the Software, and to permit persons to whom the Software is</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * furnished to do so, subject to the following conditions:</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * The above copyright notice and this permission notice shall be included in all</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * copies or substantial portions of the Software.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment"> * SOFTWARE.</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#ifndef NO_MULTI_THREADING</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &lt;atomic&gt;</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="namespacearm__gemm.xhtml"> 30</a></span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacearm__gemm.xhtml">arm_gemm</a> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classarm__gemm_1_1barrier.xhtml"> 32</a></span>&#160;<span class="keyword">class </span><a class="code" href="classarm__gemm_1_1barrier.xhtml">barrier</a> {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> m_threads;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; std::atomic&lt;unsigned int&gt; m_waiters;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; std::atomic&lt;unsigned int&gt; m_leavers;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classarm__gemm_1_1barrier.xhtml#a90c5729c7709dc787ce1d6abbff830e4"> 40</a></span>&#160; <a class="code" href="classarm__gemm_1_1barrier.xhtml#a90c5729c7709dc787ce1d6abbff830e4">barrier</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> threads) : m_threads(threads), m_waiters(0), m_leavers(0) { }</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="comment">/* This isn&#39;t safe if any thread is waiting... */</span></div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classarm__gemm_1_1barrier.xhtml#ad74688f775864e33d4b751cc1317beec"> 43</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classarm__gemm_1_1barrier.xhtml#ad74688f775864e33d4b751cc1317beec">set_nthreads</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nthreads) {</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; m_threads = nthreads;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; }</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classarm__gemm_1_1barrier.xhtml#ab3a1638fb79fab8886ce5aaccf9d4f7e"> 47</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classarm__gemm_1_1barrier.xhtml#ab3a1638fb79fab8886ce5aaccf9d4f7e">arrive_and_wait</a>() {</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; m_waiters++;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keywordflow">while</span> (m_waiters != m_threads) {</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; ; <span class="comment">/* spin */</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; }</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> v = m_leavers.fetch_add(1);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keywordflow">if</span> (v == (m_threads - 1)) {</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; m_waiters -= m_threads;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; m_leavers = 0;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordflow">while</span> (m_leavers &gt; 0) {</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; ; <span class="comment">/* spin */</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; }</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; }</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; }</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;};</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;} <span class="comment">// namespace arm_gemm</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<span class="preprocessor">#else</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacearm__gemm.xhtml">arm_gemm</a> {</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="keyword">class </span>barrier {</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <a class="code" href="classarm__gemm_1_1barrier.xhtml#a90c5729c7709dc787ce1d6abbff830e4">barrier</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>) { }</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classarm__gemm_1_1barrier.xhtml#ab3a1638fb79fab8886ce5aaccf9d4f7e">arrive_and_wait</a>() { }</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classarm__gemm_1_1barrier.xhtml#ad74688f775864e33d4b751cc1317beec">set_nthreads</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> ) { }</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;};</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;} <span class="comment">// namespace arm_gemm</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="classarm__gemm_1_1barrier_xhtml_a90c5729c7709dc787ce1d6abbff830e4"><div class="ttname"><a href="classarm__gemm_1_1barrier.xhtml#a90c5729c7709dc787ce1d6abbff830e4">arm_gemm::barrier::barrier</a></div><div class="ttdeci">barrier(unsigned int threads)</div><div class="ttdef"><b>Definition:</b> <a href="barrier_8hpp_source.xhtml#l00040">barrier.hpp:40</a></div></div>
104<div class="ttc" id="namespacearm__gemm_xhtml"><div class="ttname"><a href="namespacearm__gemm.xhtml">arm_gemm</a></div><div class="ttdef"><b>Definition:</b> <a href="barrier_8hpp_source.xhtml#l00030">barrier.hpp:30</a></div></div>
105<div class="ttc" id="classarm__gemm_1_1barrier_xhtml_ab3a1638fb79fab8886ce5aaccf9d4f7e"><div class="ttname"><a href="classarm__gemm_1_1barrier.xhtml#ab3a1638fb79fab8886ce5aaccf9d4f7e">arm_gemm::barrier::arrive_and_wait</a></div><div class="ttdeci">void arrive_and_wait()</div><div class="ttdef"><b>Definition:</b> <a href="barrier_8hpp_source.xhtml#l00047">barrier.hpp:47</a></div></div>
106<div class="ttc" id="classarm__gemm_1_1barrier_xhtml_ad74688f775864e33d4b751cc1317beec"><div class="ttname"><a href="classarm__gemm_1_1barrier.xhtml#ad74688f775864e33d4b751cc1317beec">arm_gemm::barrier::set_nthreads</a></div><div class="ttdeci">void set_nthreads(unsigned int nthreads)</div><div class="ttdef"><b>Definition:</b> <a href="barrier_8hpp_source.xhtml#l00043">barrier.hpp:43</a></div></div>
107<div class="ttc" id="classarm__gemm_1_1barrier_xhtml"><div class="ttname"><a href="classarm__gemm_1_1barrier.xhtml">arm_gemm::barrier</a></div><div class="ttdef"><b>Definition:</b> <a href="barrier_8hpp_source.xhtml#l00032">barrier.hpp:32</a></div></div>
108</div><!-- fragment --></div><!-- contents -->
109</div><!-- doc-content -->
110<!-- start footer part -->
111<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
112 <ul>
113 <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.xhtml">src</a></li><li class="navelem"><a class="el" href="dir_aebb8dcc11953d78e620bbef0b9e2183.xhtml">core</a></li><li class="navelem"><a class="el" href="dir_d91e1966cc57df4f49d1e07be7697713.xhtml">NEON</a></li><li class="navelem"><a class="el" href="dir_1ce938f580a6f304b99685e2c1dd19db.xhtml">kernels</a></li><li class="navelem"><a class="el" href="dir_9847dd9cb7a28e46201717fa7336cf62.xhtml">arm_gemm</a></li><li class="navelem"><a class="el" href="barrier_8hpp.xhtml">barrier.hpp</a></li>
114 <li class="footer">Generated on Mon Sep 2 2019 11:47:22 for Compute Library by
115 <a href="http://www.doxygen.org/index.html">
116 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
117 </ul>
118</div>
119</body>
120</html>