Google Git
Sign in
apache / mxnet-site / d5c5a235eef72f64ccaf224b834a20ef3287469b / . / versions / 1.9.1 / api / cpp / docs / api / concurrency_8h_source.html
blob: 58d1d4024242791453a2bf62f3bc698992d786fa [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mxnet: /work/mxnet/3rdparty/dmlc-core/include/dmlc/concurrency.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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">mxnet
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_8cab8f464681f7cc51cee77e79a434cd.html">3rdparty</a></li><li class="navelem"><a class="el" href="dir_82e31a22178767beedddc7597fd1ecb6.html">dmlc-core</a></li><li class="navelem"><a class="el" href="dir_7dd5b88db83ff474628c03c453739a90.html">include</a></li><li class="navelem"><a class="el" href="dir_e30967e3ab51f65ad4b50dd298ccf4e7.html">dmlc</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">concurrency.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="concurrency_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#ifndef DMLC_CONCURRENCY_H_</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#define DMLC_CONCURRENCY_H_</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// this code depends on c++11</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#if DMLC_USE_CXX11</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &lt;atomic&gt;</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &lt;deque&gt;</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &lt;queue&gt;</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &lt;mutex&gt;</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &lt;utility&gt;</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &lt;condition_variable&gt;</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h.html">dmlc/base.h</a>&quot;</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacedmlc.html">dmlc</a> {</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classdmlc_1_1Spinlock.html"> 25</a></span>&#160;<span class="keyword">class </span><a class="code" href="classdmlc_1_1Spinlock.html">Spinlock</a> {</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#ifdef _MSC_VER</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <a class="code" href="classdmlc_1_1Spinlock.html#a0a84833ade90ba85e17219a6c892cfec">Spinlock</a>() {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; lock_.clear();</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; }</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#else</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#if defined(__clang__)</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#pragma clang diagnostic push</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#pragma clang diagnostic ignored &quot;-Wbraced-scalar-init&quot;</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">#endif // defined(__clang__)</span></div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classdmlc_1_1Spinlock.html#a0a84833ade90ba85e17219a6c892cfec"> 36</a></span>&#160; <a class="code" href="classdmlc_1_1Spinlock.html#a0a84833ade90ba85e17219a6c892cfec">Spinlock</a>() : lock_(ATOMIC_FLAG_INIT) {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; }</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="preprocessor">#if defined(__clang__)</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="preprocessor">#pragma clang diagnostic pop</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="preprocessor">#endif // defined(__clang__)</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <a class="code" href="classdmlc_1_1Spinlock.html#a7f7f0b06965a3d5ee97cca39b33b72a8">~Spinlock</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classdmlc_1_1Spinlock.html#ac18746d90b20c0cef20c3443f448adf8">lock</a>() noexcept(<span class="keyword">true</span>);</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classdmlc_1_1Spinlock.html#a4838f60a973007f28abd5e2eb6a5be8a">unlock</a>() noexcept(<span class="keyword">true</span>);</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; std::atomic_flag lock_;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; DISALLOW_COPY_AND_ASSIGN(<a class="code" href="classdmlc_1_1Spinlock.html">Spinlock</a>);</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;};</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="namespacedmlc.html#aa9dd9270ccf6f3442c9d9af5300fb2cf"> 61</a></span>&#160;<span class="keyword">enum class</span> <a class="code" href="namespacedmlc.html#aa9dd9270ccf6f3442c9d9af5300fb2cf">ConcurrentQueueType</a> {</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <a class="code" href="namespacedmlc.html#aa9dd9270ccf6f3442c9d9af5300fb2cfa5a986096cebd351a04b4720be719ec8c">kFIFO</a>,</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <a class="code" href="namespacedmlc.html#aa9dd9270ccf6f3442c9d9af5300fb2cfa140635f78446d3b7e16e1bed1772e754">kPriority</a></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;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T,</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <a class="code" href="namespacedmlc.html#aa9dd9270ccf6f3442c9d9af5300fb2cf">ConcurrentQueueType</a> type = <a class="code" href="namespacedmlc.html#aa9dd9270ccf6f3442c9d9af5300fb2cfa5a986096cebd351a04b4720be719ec8c">ConcurrentQueueType::kFIFO</a>&gt;</div><div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="classdmlc_1_1ConcurrentBlockingQueue.html"> 73</a></span>&#160;<span class="keyword">class </span><a class="code" href="classdmlc_1_1ConcurrentBlockingQueue.html">ConcurrentBlockingQueue</a> {</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="classdmlc_1_1ConcurrentBlockingQueue.html">ConcurrentBlockingQueue</a>();</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; ~<a class="code" href="classdmlc_1_1ConcurrentBlockingQueue.html">ConcurrentBlockingQueue</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> E&gt;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordtype">void</span> Push(E&amp;&amp; e, <span class="keywordtype">int</span> priority = 0);</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> E&gt;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keywordtype">void</span> PushFront(E&amp;&amp; e, <span class="keywordtype">int</span> priority = 0);</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <span class="keywordtype">bool</span> Pop(T* rv);</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <span class="keywordtype">void</span> SignalForKill();</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <span class="keywordtype">size_t</span> Size();</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; <span class="keyword">struct </span>Entry {</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; T data;</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; <span class="keywordtype">int</span> priority;</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; <span class="keyword">inline</span> <span class="keywordtype">bool</span> operator&lt;(<span class="keyword">const</span> Entry &amp;b)<span class="keyword"> const </span>{</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; <span class="keywordflow">return</span> priority &lt; b.priority;</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; }</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; };</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; std::mutex mutex_;</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; std::condition_variable cv_;</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; std::atomic&lt;bool&gt; exit_now_;</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; <span class="keywordtype">int</span> nwait_consumer_;</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; <span class="comment">// a priority queue</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; std::vector&lt;Entry&gt; priority_queue_;</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; <span class="comment">// a FIFO queue</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; std::deque&lt;T&gt; fifo_queue_;</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; <a class="code" href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h.html#a26529ca54834a4418b46b4a8430f678b">DISALLOW_COPY_AND_ASSIGN</a>(<a class="code" href="classdmlc_1_1ConcurrentBlockingQueue.html">ConcurrentBlockingQueue</a>);</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;};</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160;</div><div class="line"><a name="l00147"></a><span class="lineno"><a class="line" href="classdmlc_1_1Spinlock.html#ac18746d90b20c0cef20c3443f448adf8"> 147</a></span>&#160;<span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classdmlc_1_1Spinlock.html#ac18746d90b20c0cef20c3443f448adf8">Spinlock::lock</a>() noexcept(true) {</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; <span class="keywordflow">while</span> (lock_.test_and_set(std::memory_order_acquire)) {</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; }</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;}</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;</div><div class="line"><a name="l00152"></a><span class="lineno"><a class="line" href="classdmlc_1_1Spinlock.html#a4838f60a973007f28abd5e2eb6a5be8a"> 152</a></span>&#160;<span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classdmlc_1_1Spinlock.html#a4838f60a973007f28abd5e2eb6a5be8a">Spinlock::unlock</a>() noexcept(true) {</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; lock_.clear(std::memory_order_release);</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160;}</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160;</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, ConcurrentQueueType type&gt;</div><div class="line"><a name="l00157"></a><span class="lineno"><a class="line" href="classdmlc_1_1ConcurrentBlockingQueue.html#a835ab07cb02d61059eb1bb937fde3550"> 157</a></span>&#160;<a class="code" href="classdmlc_1_1ConcurrentBlockingQueue.html#a835ab07cb02d61059eb1bb937fde3550">ConcurrentBlockingQueue&lt;T, type&gt;::ConcurrentBlockingQueue</a>()</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; : exit_now_{<span class="keyword">false</span>}, nwait_consumer_{0} {}</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160;</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, ConcurrentQueueType type&gt;</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> E&gt;</div><div class="line"><a name="l00162"></a><span class="lineno"><a class="line" href="classdmlc_1_1ConcurrentBlockingQueue.html#a7d462648c0dba8e495e1efaacff6a75a"> 162</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classdmlc_1_1ConcurrentBlockingQueue.html#a7d462648c0dba8e495e1efaacff6a75a">ConcurrentBlockingQueue&lt;T, type&gt;::Push</a>(E&amp;&amp; e, <span class="keywordtype">int</span> priority) {</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; static_assert(std::is_same&lt;<span class="keyword">typename</span> std::remove_cv&lt;</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; <span class="keyword">typename</span> std::remove_reference&lt;E&gt;::type&gt;::type,</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; T&gt;::value,</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; <span class="stringliteral">&quot;Types must match.&quot;</span>);</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; <span class="keywordtype">bool</span> notify;</div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; {</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; std::lock_guard&lt;std::mutex&gt; lock{mutex_};</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160; <span class="keywordflow">if</span> (type == <a class="code" href="namespacedmlc.html#aa9dd9270ccf6f3442c9d9af5300fb2cfa5a986096cebd351a04b4720be719ec8c">ConcurrentQueueType::kFIFO</a>) {</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; fifo_queue_.emplace_back(std::forward&lt;E&gt;(e));</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160; notify = nwait_consumer_ != 0;</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160; } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160; Entry entry;</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160; entry.data = std::move(e);</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160; entry.priority = priority;</div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160; priority_queue_.push_back(std::move(entry));</div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160; std::push_heap(priority_queue_.begin(), priority_queue_.end());</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160; notify = nwait_consumer_ != 0;</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160; }</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160; }</div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160; <span class="keywordflow">if</span> (notify) cv_.notify_one();</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160;}</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160;</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, ConcurrentQueueType type&gt;</div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> E&gt;</div><div class="line"><a name="l00187"></a><span class="lineno"><a class="line" href="classdmlc_1_1ConcurrentBlockingQueue.html#a9ae71ca4d6890a788e162521afb446d8"> 187</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classdmlc_1_1ConcurrentBlockingQueue.html#a9ae71ca4d6890a788e162521afb446d8">ConcurrentBlockingQueue&lt;T, type&gt;::PushFront</a>(E&amp;&amp; e, <span class="keywordtype">int</span> priority) {</div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; static_assert(std::is_same&lt;<span class="keyword">typename</span> std::remove_cv&lt;</div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160; <span class="keyword">typename</span> std::remove_reference&lt;E&gt;::type&gt;::type,</div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160; T&gt;::value,</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160; <span class="stringliteral">&quot;Types must match.&quot;</span>);</div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160; <span class="keywordtype">bool</span> notify;</div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160; {</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160; std::lock_guard&lt;std::mutex&gt; lock{mutex_};</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160; <span class="keywordflow">if</span> (type == <a class="code" href="namespacedmlc.html#aa9dd9270ccf6f3442c9d9af5300fb2cfa5a986096cebd351a04b4720be719ec8c">ConcurrentQueueType::kFIFO</a>) {</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160; fifo_queue_.emplace_front(std::forward&lt;E&gt;(e));</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160; notify = nwait_consumer_ != 0;</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160; } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160; Entry entry;</div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160; entry.data = std::move(e);</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160; entry.priority = priority;</div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160; priority_queue_.push_back(std::move(entry));</div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160; std::push_heap(priority_queue_.begin(), priority_queue_.end());</div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160; notify = nwait_consumer_ != 0;</div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160; }</div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span>&#160; }</div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160; <span class="keywordflow">if</span> (notify) cv_.notify_one();</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span>&#160;}</div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span>&#160;</div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, ConcurrentQueueType type&gt;</div><div class="line"><a name="l00211"></a><span class="lineno"><a class="line" href="classdmlc_1_1ConcurrentBlockingQueue.html#afb8bbf0d5ec39d22b9a3d7c86a649c86"> 211</a></span>&#160;<span class="keywordtype">bool</span> <a class="code" href="classdmlc_1_1ConcurrentBlockingQueue.html#afb8bbf0d5ec39d22b9a3d7c86a649c86">ConcurrentBlockingQueue&lt;T, type&gt;::Pop</a>(T* rv) {</div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span>&#160; std::unique_lock&lt;std::mutex&gt; lock{mutex_};</div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span>&#160; <span class="keywordflow">if</span> (type == <a class="code" href="namespacedmlc.html#aa9dd9270ccf6f3442c9d9af5300fb2cfa5a986096cebd351a04b4720be719ec8c">ConcurrentQueueType::kFIFO</a>) {</div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span>&#160; ++nwait_consumer_;</div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span>&#160; cv_.wait(lock, [<span class="keyword">this</span>] {</div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span>&#160; <span class="keywordflow">return</span> !fifo_queue_.empty() || exit_now_.load();</div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span>&#160; });</div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span>&#160; --nwait_consumer_;</div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span>&#160; <span class="keywordflow">if</span> (!exit_now_.load()) {</div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span>&#160; *rv = std::move(fifo_queue_.front());</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span>&#160; fifo_queue_.pop_front();</div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span>&#160; } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span>&#160; }</div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160; } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span>&#160; ++nwait_consumer_;</div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span>&#160; cv_.wait(lock, [<span class="keyword">this</span>] {</div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span>&#160; <span class="keywordflow">return</span> !priority_queue_.empty() || exit_now_.load();</div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span>&#160; });</div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span>&#160; --nwait_consumer_;</div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span>&#160; <span class="keywordflow">if</span> (!exit_now_.load()) {</div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span>&#160; std::pop_heap(priority_queue_.begin(), priority_queue_.end());</div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span>&#160; *rv = std::move(priority_queue_.back().data);</div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span>&#160; priority_queue_.pop_back();</div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span>&#160; } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span>&#160; }</div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span>&#160; }</div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span>&#160;}</div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span>&#160;</div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, ConcurrentQueueType type&gt;</div><div class="line"><a name="l00244"></a><span class="lineno"><a class="line" href="classdmlc_1_1ConcurrentBlockingQueue.html#aadedf3f04b1cacb7dd2b834d91447427"> 244</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classdmlc_1_1ConcurrentBlockingQueue.html#aadedf3f04b1cacb7dd2b834d91447427">ConcurrentBlockingQueue&lt;T, type&gt;::SignalForKill</a>() {</div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span>&#160; {</div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span>&#160; std::lock_guard&lt;std::mutex&gt; lock{mutex_};</div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span>&#160; exit_now_.store(<span class="keyword">true</span>);</div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span>&#160; }</div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span>&#160; cv_.notify_all();</div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span>&#160;}</div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span>&#160;</div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, ConcurrentQueueType type&gt;</div><div class="line"><a name="l00253"></a><span class="lineno"><a class="line" href="classdmlc_1_1ConcurrentBlockingQueue.html#aadeb49c6b5bb73d6c5865cc053f5d2f3"> 253</a></span>&#160;<span class="keywordtype">size_t</span> <a class="code" href="classdmlc_1_1ConcurrentBlockingQueue.html#aadeb49c6b5bb73d6c5865cc053f5d2f3">ConcurrentBlockingQueue&lt;T, type&gt;::Size</a>() {</div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span>&#160; std::lock_guard&lt;std::mutex&gt; lock{mutex_};</div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span>&#160; <span class="keywordflow">if</span> (type == <a class="code" href="namespacedmlc.html#aa9dd9270ccf6f3442c9d9af5300fb2cfa5a986096cebd351a04b4720be719ec8c">ConcurrentQueueType::kFIFO</a>) {</div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span>&#160; <span class="keywordflow">return</span> fifo_queue_.size();</div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span>&#160; } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span>&#160; <span class="keywordflow">return</span> priority_queue_.size();</div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span>&#160; }</div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span>&#160;}</div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span>&#160;} <span class="comment">// namespace dmlc</span></div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span>&#160;<span class="preprocessor">#endif // DMLC_USE_CXX11</span></div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span>&#160;<span class="preprocessor">#endif // DMLC_CONCURRENCY_H_</span></div><div class="ttc" id="classdmlc_1_1Spinlock_html_ac18746d90b20c0cef20c3443f448adf8"><div class="ttname"><a href="classdmlc_1_1Spinlock.html#ac18746d90b20c0cef20c3443f448adf8">dmlc::Spinlock::lock</a></div><div class="ttdeci">void lock() noexcept(true)</div><div class="ttdoc">Acquire lock. </div><div class="ttdef"><b>Definition:</b> concurrency.h:147</div></div>
<div class="ttc" id="classdmlc_1_1ConcurrentBlockingQueue_html_afb8bbf0d5ec39d22b9a3d7c86a649c86"><div class="ttname"><a href="classdmlc_1_1ConcurrentBlockingQueue.html#afb8bbf0d5ec39d22b9a3d7c86a649c86">dmlc::ConcurrentBlockingQueue::Pop</a></div><div class="ttdeci">bool Pop(T *rv)</div><div class="ttdoc">Pop element from the queue. </div><div class="ttdef"><b>Definition:</b> concurrency.h:211</div></div>
<div class="ttc" id="classdmlc_1_1ConcurrentBlockingQueue_html_a835ab07cb02d61059eb1bb937fde3550"><div class="ttname"><a href="classdmlc_1_1ConcurrentBlockingQueue.html#a835ab07cb02d61059eb1bb937fde3550">dmlc::ConcurrentBlockingQueue::ConcurrentBlockingQueue</a></div><div class="ttdeci">ConcurrentBlockingQueue()</div><div class="ttdef"><b>Definition:</b> concurrency.h:157</div></div>
<div class="ttc" id="namespacedmlc_html_aa9dd9270ccf6f3442c9d9af5300fb2cfa140635f78446d3b7e16e1bed1772e754"><div class="ttname"><a href="namespacedmlc.html#aa9dd9270ccf6f3442c9d9af5300fb2cfa140635f78446d3b7e16e1bed1772e754">dmlc::ConcurrentQueueType::kPriority</a></div><div class="ttdoc">queue with priority </div></div>
<div class="ttc" id="classdmlc_1_1ConcurrentBlockingQueue_html_aadeb49c6b5bb73d6c5865cc053f5d2f3"><div class="ttname"><a href="classdmlc_1_1ConcurrentBlockingQueue.html#aadeb49c6b5bb73d6c5865cc053f5d2f3">dmlc::ConcurrentBlockingQueue::Size</a></div><div class="ttdeci">size_t Size()</div><div class="ttdoc">Get the size of the queue. </div><div class="ttdef"><b>Definition:</b> concurrency.h:253</div></div>
<div class="ttc" id="namespacedmlc_html_aa9dd9270ccf6f3442c9d9af5300fb2cf"><div class="ttname"><a href="namespacedmlc.html#aa9dd9270ccf6f3442c9d9af5300fb2cf">dmlc::ConcurrentQueueType</a></div><div class="ttdeci">ConcurrentQueueType</div><div class="ttdoc">type of concurrent queue </div><div class="ttdef"><b>Definition:</b> concurrency.h:61</div></div>
<div class="ttc" id="classdmlc_1_1Spinlock_html_a4838f60a973007f28abd5e2eb6a5be8a"><div class="ttname"><a href="classdmlc_1_1Spinlock.html#a4838f60a973007f28abd5e2eb6a5be8a">dmlc::Spinlock::unlock</a></div><div class="ttdeci">void unlock() noexcept(true)</div><div class="ttdoc">Release lock. </div><div class="ttdef"><b>Definition:</b> concurrency.h:152</div></div>
<div class="ttc" id="classdmlc_1_1ConcurrentBlockingQueue_html_a7d462648c0dba8e495e1efaacff6a75a"><div class="ttname"><a href="classdmlc_1_1ConcurrentBlockingQueue.html#a7d462648c0dba8e495e1efaacff6a75a">dmlc::ConcurrentBlockingQueue::Push</a></div><div class="ttdeci">void Push(E &amp;&amp;e, int priority=0)</div><div class="ttdoc">Push element to the end of the queue. </div><div class="ttdef"><b>Definition:</b> concurrency.h:162</div></div>
<div class="ttc" id="classdmlc_1_1Spinlock_html_a7f7f0b06965a3d5ee97cca39b33b72a8"><div class="ttname"><a href="classdmlc_1_1Spinlock.html#a7f7f0b06965a3d5ee97cca39b33b72a8">dmlc::Spinlock::~Spinlock</a></div><div class="ttdeci">~Spinlock()=default</div></div>
<div class="ttc" id="classdmlc_1_1ConcurrentBlockingQueue_html_aadedf3f04b1cacb7dd2b834d91447427"><div class="ttname"><a href="classdmlc_1_1ConcurrentBlockingQueue.html#aadedf3f04b1cacb7dd2b834d91447427">dmlc::ConcurrentBlockingQueue::SignalForKill</a></div><div class="ttdeci">void SignalForKill()</div><div class="ttdoc">Signal the queue for destruction. </div><div class="ttdef"><b>Definition:</b> concurrency.h:244</div></div>
<div class="ttc" id="namespacedmlc_html"><div class="ttname"><a href="namespacedmlc.html">dmlc</a></div><div class="ttdoc">namespace for dmlc </div><div class="ttdef"><b>Definition:</b> array_view.h:12</div></div>
<div class="ttc" id="3rdparty_2dmlc-core_2include_2dmlc_2base_8h_html_a26529ca54834a4418b46b4a8430f678b"><div class="ttname"><a href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h.html#a26529ca54834a4418b46b4a8430f678b">DISALLOW_COPY_AND_ASSIGN</a></div><div class="ttdeci">#define DISALLOW_COPY_AND_ASSIGN(T)</div><div class="ttdoc">Disable copy constructor and assignment operator. </div><div class="ttdef"><b>Definition:</b> base.h:174</div></div>
<div class="ttc" id="classdmlc_1_1ConcurrentBlockingQueue_html_a9ae71ca4d6890a788e162521afb446d8"><div class="ttname"><a href="classdmlc_1_1ConcurrentBlockingQueue.html#a9ae71ca4d6890a788e162521afb446d8">dmlc::ConcurrentBlockingQueue::PushFront</a></div><div class="ttdeci">void PushFront(E &amp;&amp;e, int priority=0)</div><div class="ttdoc">Push element to the front of the queue. Only works for FIFO queue. For priority queue it is the same ...</div><div class="ttdef"><b>Definition:</b> concurrency.h:187</div></div>
<div class="ttc" id="classdmlc_1_1Spinlock_html_a0a84833ade90ba85e17219a6c892cfec"><div class="ttname"><a href="classdmlc_1_1Spinlock.html#a0a84833ade90ba85e17219a6c892cfec">dmlc::Spinlock::Spinlock</a></div><div class="ttdeci">Spinlock()</div><div class="ttdef"><b>Definition:</b> concurrency.h:36</div></div>
<div class="ttc" id="3rdparty_2dmlc-core_2include_2dmlc_2base_8h_html"><div class="ttname"><a href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h.html">base.h</a></div></div>
<div class="ttc" id="classdmlc_1_1Spinlock_html"><div class="ttname"><a href="classdmlc_1_1Spinlock.html">dmlc::Spinlock</a></div><div class="ttdoc">Simple userspace spinlock implementation. </div><div class="ttdef"><b>Definition:</b> concurrency.h:25</div></div>
<div class="ttc" id="classdmlc_1_1ConcurrentBlockingQueue_html"><div class="ttname"><a href="classdmlc_1_1ConcurrentBlockingQueue.html">dmlc::ConcurrentBlockingQueue</a></div><div class="ttdoc">Cocurrent blocking queue. </div><div class="ttdef"><b>Definition:</b> concurrency.h:73</div></div>
<div class="ttc" id="namespacedmlc_html_aa9dd9270ccf6f3442c9d9af5300fb2cfa5a986096cebd351a04b4720be719ec8c"><div class="ttname"><a href="namespacedmlc.html#aa9dd9270ccf6f3442c9d9af5300fb2cfa5a986096cebd351a04b4720be719ec8c">dmlc::ConcurrentQueueType::kFIFO</a></div><div class="ttdoc">FIFO queue. </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 00:58:41 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>