blob: 3e5d6109eb98dbb1ea7d06c589550407b08c7927 [file] [log] [blame]
<!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>mxnet: /work/mxnet/3rdparty/dmlc-core/include/dmlc/thread_group.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.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>
<!-- 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">thread_group.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="thread__group_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="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#ifndef DMLC_THREAD_GROUP_H_</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#define DMLC_THREAD_GROUP_H_</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160; </div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="concurrentqueue_8h.html">dmlc/concurrentqueue.h</a>&gt;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="blockingconcurrentqueue_8h.html">dmlc/blockingconcurrentqueue.h</a>&gt;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &lt;dmlc/logging.h&gt;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &lt;mutex&gt;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &lt;utility&gt;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &lt;set&gt;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &lt;thread&gt;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &lt;unordered_set&gt;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &lt;unordered_map&gt;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#if defined(DMLC_USE_CXX14) || __cplusplus &gt; 201103L </span><span class="comment">/* C++14 */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &lt;shared_mutex&gt;</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;condition_variable&gt;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#ifdef __linux__</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &lt;unistd.h&gt;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &lt;sys/syscall.h&gt;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacedmlc.html">dmlc</a> {</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classdmlc_1_1ManualEvent.html"> 34</a></span>&#160;<span class="keyword">class </span><a class="code" href="classdmlc_1_1ManualEvent.html">ManualEvent</a> {</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classdmlc_1_1ManualEvent.html#a9f1f6aefdf6df4f3b27845234f598583"> 36</a></span>&#160; <a class="code" href="classdmlc_1_1ManualEvent.html#a9f1f6aefdf6df4f3b27845234f598583">ManualEvent</a>() : signaled_(false) {}</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; </div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classdmlc_1_1ManualEvent.html#a24af45c7c96d8b9421ed3337c5def886"> 42</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classdmlc_1_1ManualEvent.html#a24af45c7c96d8b9421ed3337c5def886">wait</a>() {</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; std::unique_lock&lt;std::mutex&gt; <a class="code" href="namespacemxnet_1_1common_1_1cuda_1_1rtc.html#aef7cd83e7f0216b689f5f9d4191d9f8b">lock</a>(mutex_);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordflow">if</span> (!signaled_) {</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; condition_variable_.wait(<a class="code" href="namespacemxnet_1_1common_1_1cuda_1_1rtc.html#aef7cd83e7f0216b689f5f9d4191d9f8b">lock</a>);</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"> 47</span>&#160; }</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classdmlc_1_1ManualEvent.html#aabdf6964cb72222e04fecfd9ffb9875e"> 52</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classdmlc_1_1ManualEvent.html#aabdf6964cb72222e04fecfd9ffb9875e">signal</a>() {</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; signaled_ = <span class="keyword">true</span>;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; std::unique_lock&lt;std::mutex&gt; lk(mutex_);</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; condition_variable_.notify_all();</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; }</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; </div>
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="classdmlc_1_1ManualEvent.html#ad1c15c34d3b237dd878aaa9f6ca31f16"> 61</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classdmlc_1_1ManualEvent.html#ad1c15c34d3b237dd878aaa9f6ca31f16">reset</a>() {</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; std::unique_lock&lt;std::mutex&gt; lk(mutex_);</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; signaled_ = <span class="keyword">false</span>;</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; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; std::mutex mutex_;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; std::condition_variable condition_variable_;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; std::atomic&lt;bool&gt; signaled_;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;};</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;<span class="preprocessor">#if defined(DMLC_USE_CXX14) || __cplusplus &gt; 201103L </span><span class="comment">/* C++14 */</span><span class="preprocessor"></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="keyword">using</span> <a class="code" href="namespacedmlc.html#a34fec5df74dfed6c51540a1fcf5bae54">SharedMutex</a> = std::shared_timed_mutex;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;<span class="keyword">using</span> <a class="code" href="namespacedmlc.html#aad58a9dfecc6e970348c217de29bb916">WriteLock</a> = std::unique_lock&lt;SharedMutex&gt;;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="keyword">using</span> <a class="code" href="namespacedmlc.html#a591cc4d1980f6074fbc450bcf9d40876">ReadLock</a> = std::shared_lock&lt;SharedMutex&gt;;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; </div>
<div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="namespacedmlc.html#a34fec5df74dfed6c51540a1fcf5bae54"> 84</a></span>&#160;<span class="keyword">using</span> <a class="code" href="namespacedmlc.html#a34fec5df74dfed6c51540a1fcf5bae54">SharedMutex</a> = std::recursive_mutex;</div>
<div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="namespacedmlc.html#aad58a9dfecc6e970348c217de29bb916"> 86</a></span>&#160;<span class="keyword">using</span> <a class="code" href="namespacedmlc.html#aad58a9dfecc6e970348c217de29bb916">WriteLock</a> = std::unique_lock&lt;SharedMutex&gt;;</div>
<div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="namespacedmlc.html#a591cc4d1980f6074fbc450bcf9d40876"> 88</a></span>&#160;<span class="keyword">using</span> <a class="code" href="namespacedmlc.html#a591cc4d1980f6074fbc450bcf9d40876">ReadLock</a> = std::unique_lock&lt;SharedMutex&gt;;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; </div>
<div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="classdmlc_1_1ThreadGroup.html"> 95</a></span>&#160;<span class="keyword">class </span><a class="code" href="classdmlc_1_1ThreadGroup.html">ThreadGroup</a> {</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00101"></a><span class="lineno"><a class="line" href="classdmlc_1_1ThreadGroup_1_1Thread.html"> 101</a></span>&#160; <span class="keyword">class </span><a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html">Thread</a> {</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a15a7156eee217ef17010947a83632150"> 104</a></span>&#160; <span class="keyword">using</span> <a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a15a7156eee217ef17010947a83632150">SharedPtr</a> = std::shared_ptr&lt;Thread&gt;;</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; </div>
<div class="line"><a name="l00112"></a><span class="lineno"><a class="line" href="classdmlc_1_1ThreadGroup_1_1Thread.html#af418c16d46e4adc424a84c68a44e0c0b"> 112</a></span>&#160; <a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#af418c16d46e4adc424a84c68a44e0c0b">Thread</a>(std::string threadName, <a class="code" href="classdmlc_1_1ThreadGroup.html">ThreadGroup</a> *owner, std::thread *thrd = <span class="keyword">nullptr</span>)</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; : name_(<a class="code" href="namespacestd.html">std</a>::move(threadName))</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; , thread_(thrd)</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; , ready_event_(<a class="code" href="namespacestd.html">std</a>::make_shared&lt;<a class="code" href="classdmlc_1_1ManualEvent.html">ManualEvent</a>&gt;())</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; , start_event_(<a class="code" href="namespacestd.html">std</a>::make_shared&lt;<a class="code" href="classdmlc_1_1ManualEvent.html">ManualEvent</a>&gt;())</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; , owner_(owner)</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; , shutdown_requested_(false)</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; , auto_remove_(false) {</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; CHECK_NOTNULL(owner);</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; }</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; </div>
<div class="line"><a name="l00126"></a><span class="lineno"><a class="line" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a25667e2d229f416bd324bfc7d28ad47d"> 126</a></span>&#160; <span class="keyword">virtual</span> <a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a25667e2d229f416bd324bfc7d28ad47d">~Thread</a>() {</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; <span class="keyword">const</span> <span class="keywordtype">bool</span> self_delete = <a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a95bee6cfb44fa0added840e1c42ff7f1">is_current_thread</a>();</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; <span class="keywordflow">if</span> (!self_delete) {</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; <a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a0dee1f2d880507a322c28bf2c29bfaee">request_shutdown</a>();</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; internal_join(<span class="keyword">true</span>);</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; <a class="code" href="namespacedmlc.html#aad58a9dfecc6e970348c217de29bb916">WriteLock</a> guard(thread_mutex_);</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; <span class="keywordflow">if</span> (thread_.load()) {</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; std::thread *thrd = thread_.load();</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; thread_ = <span class="keyword">nullptr</span>;</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; <span class="keywordflow">if</span> (self_delete) {</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; thrd-&gt;detach();</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; }</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; <span class="keyword">delete</span> thrd;</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; }</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; }</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; </div>
<div class="line"><a name="l00149"></a><span class="lineno"><a class="line" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a34db4d633ab7229256211a7f3690b823"> 149</a></span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a34db4d633ab7229256211a7f3690b823">name</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; <span class="keywordflow">return</span> name_.c_str();</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"> 152</span>&#160; </div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> StartFunction, <span class="keyword">typename</span> ...Args&gt;</div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#aba557e3155a2e29664f761a3cf3b9cd5">launch</a>(std::shared_ptr&lt;Thread&gt; pThis,</div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; <span class="keywordtype">bool</span> autoRemove,</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160; StartFunction start_function,</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; Args ...args);</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160; </div>
<div class="line"><a name="l00177"></a><span class="lineno"><a class="line" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a95bee6cfb44fa0added840e1c42ff7f1"> 177</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a95bee6cfb44fa0added840e1c42ff7f1">is_current_thread</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160; <a class="code" href="namespacedmlc.html#a591cc4d1980f6074fbc450bcf9d40876">ReadLock</a> guard(thread_mutex_);</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160; <span class="keywordflow">return</span> thread_.load() ? (thread_.load()-&gt;get_id() == std::this_thread::get_id()) : <span class="keyword">false</span>;</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="l00187"></a><span class="lineno"><a class="line" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a0dee1f2d880507a322c28bf2c29bfaee"> 187</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a0dee1f2d880507a322c28bf2c29bfaee">request_shutdown</a>() {</div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; shutdown_requested_ = <span class="keyword">true</span>;</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160; }</div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160; </div>
<div class="line"><a name="l00197"></a><span class="lineno"><a class="line" href="classdmlc_1_1ThreadGroup_1_1Thread.html#aa880e5707af1df23523142850f36dc45"> 197</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#aa880e5707af1df23523142850f36dc45">is_shutdown_requested</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160; <span class="keywordflow">return</span> shutdown_requested_.load();</div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160; }</div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160; </div>
<div class="line"><a name="l00207"></a><span class="lineno"><a class="line" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a16c4ff5126f01989d26d0170476c76ff"> 207</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a16c4ff5126f01989d26d0170476c76ff">is_auto_remove</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>&#160; <span class="keywordflow">return</span> auto_remove_;</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; </div>
<div class="line"><a name="l00216"></a><span class="lineno"><a class="line" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a9637c66d37e0d39397784e35e8c0921a"> 216</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a9637c66d37e0d39397784e35e8c0921a">make_joinable</a>() {</div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>&#160; auto_remove_ = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span>&#160; }</div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>&#160; </div>
<div class="line"><a name="l00224"></a><span class="lineno"><a class="line" href="classdmlc_1_1ThreadGroup_1_1Thread.html#abff81204caa69efd85052b6be5af5281"> 224</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#abff81204caa69efd85052b6be5af5281">joinable</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>&#160; <span class="keywordflow">if</span> (thread_.load()) {</div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160; CHECK_EQ(auto_remove_, <span class="keyword">false</span>);</div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>&#160; <span class="comment">// be checked by searching the group or exit event.</span></div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>&#160; <span class="keywordflow">return</span> thread_.load()-&gt;joinable();</div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span>&#160; }</div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span>&#160; }</div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span>&#160; </div>
<div class="line"><a name="l00237"></a><span class="lineno"><a class="line" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a7e13b559e8afc0e933ca7c6e7fe004e3"> 237</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a7e13b559e8afc0e933ca7c6e7fe004e3">join</a>() {</div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span>&#160; internal_join(<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="l00245"></a><span class="lineno"><a class="line" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a0aad366a57a4553a1beb3af637071cc0"> 245</a></span>&#160; std::thread::id <a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a0aad366a57a4553a1beb3af637071cc0">get_id</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span>&#160; <span class="keywordflow">return</span> thread_.load()-&gt;get_id();</div>
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span>&#160; }</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; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span>&#160; <span class="keywordtype">void</span> internal_join(<span class="keywordtype">bool</span> auto_remove_ok) {</div>
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span>&#160; <a class="code" href="namespacedmlc.html#a591cc4d1980f6074fbc450bcf9d40876">ReadLock</a> guard(thread_mutex_);</div>
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span>&#160; <span class="comment">// should be careful calling (or any function externally) this when in</span></div>
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span>&#160; <span class="comment">// auto-remove mode</span></div>
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span>&#160; <span class="keywordflow">if</span> (thread_.load() &amp;&amp; thread_.load()-&gt;get_id() != std::thread::id()) {</div>
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span>&#160; std::thread::id someId;</div>
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span>&#160; <span class="keywordflow">if</span> (!auto_remove_ok) {</div>
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span>&#160; CHECK_EQ(auto_remove_, <span class="keyword">false</span>);</div>
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span>&#160; }</div>
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span>&#160; CHECK_NOTNULL(thread_.load());</div>
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span>&#160; <span class="keywordflow">if</span> (thread_.load()-&gt;joinable()) {</div>
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span>&#160; thread_.load()-&gt;join();</div>
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span>&#160; } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span>&#160; LOG(WARNING) &lt;&lt; <span class="stringliteral">&quot;Thread &quot;</span> &lt;&lt; name_ &lt;&lt; <span class="stringliteral">&quot; ( &quot;</span></div>
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span>&#160; &lt;&lt; thread_.load()-&gt;get_id() &lt;&lt; <span class="stringliteral">&quot; ) not joinable&quot;</span>;</div>
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span>&#160; }</div>
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span>&#160; }</div>
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span>&#160; }</div>
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span>&#160; </div>
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> StartFunction, <span class="keyword">typename</span> ...Args&gt;</div>
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span>&#160; <span class="keyword">static</span> <span class="keywordtype">int</span> entry_and_exit_f(std::shared_ptr&lt;Thread&gt; pThis,</div>
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span>&#160; StartFunction start_function,</div>
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span>&#160; Args... args);</div>
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span>&#160; std::string name_;</div>
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span>&#160; <span class="keyword">mutable</span> <a class="code" href="namespacedmlc.html#a34fec5df74dfed6c51540a1fcf5bae54">SharedMutex</a> thread_mutex_;</div>
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span>&#160; std::atomic&lt;std::thread *&gt; thread_;</div>
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span>&#160; std::shared_ptr&lt;ManualEvent&gt; ready_event_;</div>
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span>&#160; std::shared_ptr&lt;ManualEvent&gt; start_event_;</div>
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span>&#160; <a class="code" href="classdmlc_1_1ThreadGroup.html#a0aeac26faab3e0608181a59a1e6726c6">ThreadGroup</a> *owner_;</div>
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span>&#160; std::atomic&lt;bool&gt; shutdown_requested_;</div>
<div class="line"><a name="l00304"></a><span class="lineno"> 304</span>&#160; std::atomic&lt;bool&gt; auto_remove_;</div>
<div class="line"><a name="l00305"></a><span class="lineno"> 305</span>&#160; };</div>
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span>&#160; </div>
<div class="line"><a name="l00310"></a><span class="lineno"><a class="line" href="classdmlc_1_1ThreadGroup.html#a0aeac26faab3e0608181a59a1e6726c6"> 310</a></span>&#160; <span class="keyword">inline</span> <a class="code" href="classdmlc_1_1ThreadGroup.html#a0aeac26faab3e0608181a59a1e6726c6">ThreadGroup</a>()</div>
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span>&#160; : evEmpty_(<a class="code" href="namespacestd.html">std</a>::make_shared&lt;<a class="code" href="classdmlc_1_1ManualEvent.html">ManualEvent</a>&gt;()) {</div>
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span>&#160; evEmpty_-&gt;signal(); <span class="comment">// Starts out empty</span></div>
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span>&#160; }</div>
<div class="line"><a name="l00314"></a><span class="lineno"> 314</span>&#160; </div>
<div class="line"><a name="l00319"></a><span class="lineno"><a class="line" href="classdmlc_1_1ThreadGroup.html#ac4a88fba4560dbbba3efac98e6d0f347"> 319</a></span>&#160; <span class="keyword">virtual</span> <a class="code" href="classdmlc_1_1ThreadGroup.html#ac4a88fba4560dbbba3efac98e6d0f347">~ThreadGroup</a>() {</div>
<div class="line"><a name="l00320"></a><span class="lineno"> 320</span>&#160; <a class="code" href="classdmlc_1_1ThreadGroup.html#a988dc9800999fc4648c7ba32c70c6aa0">request_shutdown_all</a>();</div>
<div class="line"><a name="l00321"></a><span class="lineno"> 321</span>&#160; <a class="code" href="classdmlc_1_1ThreadGroup.html#a286490cd78a1b60c85051bd9cb3e15d8">join_all</a>();</div>
<div class="line"><a name="l00322"></a><span class="lineno"> 322</span>&#160; }</div>
<div class="line"><a name="l00323"></a><span class="lineno"> 323</span>&#160; </div>
<div class="line"><a name="l00330"></a><span class="lineno"><a class="line" href="classdmlc_1_1ThreadGroup.html#adfa40c047642d4b9969782274e8b8280"> 330</a></span>&#160; <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classdmlc_1_1ThreadGroup.html#adfa40c047642d4b9969782274e8b8280">is_this_thread_in</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00331"></a><span class="lineno"> 331</span>&#160; std::thread::id <span class="keywordtype">id</span> = std::this_thread::get_id();</div>
<div class="line"><a name="l00332"></a><span class="lineno"> 332</span>&#160; <a class="code" href="namespacedmlc.html#a591cc4d1980f6074fbc450bcf9d40876">ReadLock</a> guard(m_);</div>
<div class="line"><a name="l00333"></a><span class="lineno"> 333</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">auto</span> it = threads_.begin(), end = threads_.end(); it != end; ++it) {</div>
<div class="line"><a name="l00334"></a><span class="lineno"> 334</span>&#160; std::shared_ptr&lt;Thread&gt; thrd = *it;</div>
<div class="line"><a name="l00335"></a><span class="lineno"> 335</span>&#160; <span class="keywordflow">if</span> (thrd-&gt;get_id() == <span class="keywordtype">id</span>)</div>
<div class="line"><a name="l00336"></a><span class="lineno"> 336</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00337"></a><span class="lineno"> 337</span>&#160; }</div>
<div class="line"><a name="l00338"></a><span class="lineno"> 338</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00339"></a><span class="lineno"> 339</span>&#160; }</div>
<div class="line"><a name="l00340"></a><span class="lineno"> 340</span>&#160; </div>
<div class="line"><a name="l00346"></a><span class="lineno"><a class="line" href="classdmlc_1_1ThreadGroup.html#aa0118655398fe78cf9faa466b043536f"> 346</a></span>&#160; <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classdmlc_1_1ThreadGroup.html#aa0118655398fe78cf9faa466b043536f">is_thread_in</a>(std::shared_ptr&lt;Thread&gt; thrd)<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00347"></a><span class="lineno"> 347</span>&#160; <span class="keywordflow">if</span> (thrd) {</div>
<div class="line"><a name="l00348"></a><span class="lineno"> 348</span>&#160; std::thread::id <span class="keywordtype">id</span> = thrd-&gt;get_id();</div>
<div class="line"><a name="l00349"></a><span class="lineno"> 349</span>&#160; <a class="code" href="namespacedmlc.html#a591cc4d1980f6074fbc450bcf9d40876">ReadLock</a> guard(m_);</div>
<div class="line"><a name="l00350"></a><span class="lineno"> 350</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">auto</span> it = threads_.begin(), end = threads_.end(); it != end; ++it) {</div>
<div class="line"><a name="l00351"></a><span class="lineno"> 351</span>&#160; std::shared_ptr&lt;Thread&gt; thrd = *it;</div>
<div class="line"><a name="l00352"></a><span class="lineno"> 352</span>&#160; <span class="keywordflow">if</span> (thrd-&gt;get_id() == <span class="keywordtype">id</span>)</div>
<div class="line"><a name="l00353"></a><span class="lineno"> 353</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00354"></a><span class="lineno"> 354</span>&#160; }</div>
<div class="line"><a name="l00355"></a><span class="lineno"> 355</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00356"></a><span class="lineno"> 356</span>&#160; } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00357"></a><span class="lineno"> 357</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00358"></a><span class="lineno"> 358</span>&#160; }</div>
<div class="line"><a name="l00359"></a><span class="lineno"> 359</span>&#160; }</div>
<div class="line"><a name="l00360"></a><span class="lineno"> 360</span>&#160; </div>
<div class="line"><a name="l00366"></a><span class="lineno"><a class="line" href="classdmlc_1_1ThreadGroup.html#a2ab75ab28197f8951705f6afe713c31a"> 366</a></span>&#160; <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classdmlc_1_1ThreadGroup.html#a2ab75ab28197f8951705f6afe713c31a">add_thread</a>(std::shared_ptr&lt;Thread&gt; thrd) {</div>
<div class="line"><a name="l00367"></a><span class="lineno"> 367</span>&#160; <span class="keywordflow">if</span> (thrd) {</div>
<div class="line"><a name="l00368"></a><span class="lineno"> 368</span>&#160; <a class="code" href="namespacedmlc.html#aad58a9dfecc6e970348c217de29bb916">WriteLock</a> guard(m_);</div>
<div class="line"><a name="l00369"></a><span class="lineno"> 369</span>&#160; <span class="keyword">auto</span> iter = name_to_thread_.find(thrd-&gt;name());</div>
<div class="line"><a name="l00370"></a><span class="lineno"> 370</span>&#160; <span class="keywordflow">if</span> (iter == name_to_thread_.end()) {</div>
<div class="line"><a name="l00371"></a><span class="lineno"> 371</span>&#160; name_to_thread_.emplace(std::make_pair(thrd-&gt;name(), thrd));</div>
<div class="line"><a name="l00372"></a><span class="lineno"> 372</span>&#160; CHECK_EQ(threads_.insert(thrd).second, <span class="keyword">true</span>);</div>
<div class="line"><a name="l00373"></a><span class="lineno"> 373</span>&#160; evEmpty_-&gt;reset();</div>
<div class="line"><a name="l00374"></a><span class="lineno"> 374</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00375"></a><span class="lineno"> 375</span>&#160; }</div>
<div class="line"><a name="l00376"></a><span class="lineno"> 376</span>&#160; }</div>
<div class="line"><a name="l00377"></a><span class="lineno"> 377</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00378"></a><span class="lineno"> 378</span>&#160; }</div>
<div class="line"><a name="l00379"></a><span class="lineno"> 379</span>&#160; </div>
<div class="line"><a name="l00385"></a><span class="lineno"><a class="line" href="classdmlc_1_1ThreadGroup.html#a67e34b5c574fc168ed9f62cf17de3729"> 385</a></span>&#160; <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classdmlc_1_1ThreadGroup.html#a67e34b5c574fc168ed9f62cf17de3729">remove_thread</a>(std::shared_ptr&lt;Thread&gt; thrd) {</div>
<div class="line"><a name="l00386"></a><span class="lineno"> 386</span>&#160; <span class="keywordflow">if</span> (thrd) {</div>
<div class="line"><a name="l00387"></a><span class="lineno"> 387</span>&#160; <a class="code" href="namespacedmlc.html#aad58a9dfecc6e970348c217de29bb916">WriteLock</a> guard(m_);</div>
<div class="line"><a name="l00388"></a><span class="lineno"> 388</span>&#160; <span class="keyword">auto</span> iter = threads_.find(thrd);</div>
<div class="line"><a name="l00389"></a><span class="lineno"> 389</span>&#160; <span class="keywordflow">if</span> (iter != threads_.end()) {</div>
<div class="line"><a name="l00390"></a><span class="lineno"> 390</span>&#160; name_to_thread_.erase(thrd-&gt;name());</div>
<div class="line"><a name="l00391"></a><span class="lineno"> 391</span>&#160; threads_.erase(iter);</div>
<div class="line"><a name="l00392"></a><span class="lineno"> 392</span>&#160; <span class="keywordflow">if</span> (threads_.empty()) {</div>
<div class="line"><a name="l00393"></a><span class="lineno"> 393</span>&#160; evEmpty_-&gt;signal();</div>
<div class="line"><a name="l00394"></a><span class="lineno"> 394</span>&#160; }</div>
<div class="line"><a name="l00395"></a><span class="lineno"> 395</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00396"></a><span class="lineno"> 396</span>&#160; }</div>
<div class="line"><a name="l00397"></a><span class="lineno"> 397</span>&#160; }</div>
<div class="line"><a name="l00398"></a><span class="lineno"> 398</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00399"></a><span class="lineno"> 399</span>&#160; }</div>
<div class="line"><a name="l00400"></a><span class="lineno"> 400</span>&#160; </div>
<div class="line"><a name="l00406"></a><span class="lineno"><a class="line" href="classdmlc_1_1ThreadGroup.html#a286490cd78a1b60c85051bd9cb3e15d8"> 406</a></span>&#160; <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classdmlc_1_1ThreadGroup.html#a286490cd78a1b60c85051bd9cb3e15d8">join_all</a>() {</div>
<div class="line"><a name="l00407"></a><span class="lineno"> 407</span>&#160; CHECK_EQ(!<a class="code" href="classdmlc_1_1ThreadGroup.html#adfa40c047642d4b9969782274e8b8280">is_this_thread_in</a>(), <span class="keyword">true</span>);</div>
<div class="line"><a name="l00408"></a><span class="lineno"> 408</span>&#160; <span class="keywordflow">do</span> {</div>
<div class="line"><a name="l00409"></a><span class="lineno"> 409</span>&#160; std::unique_lock&lt;std::mutex&gt; lk(join_all_mtx_);</div>
<div class="line"><a name="l00410"></a><span class="lineno"> 410</span>&#160; std::unordered_set&lt;std::shared_ptr&lt;Thread&gt;&gt; working_set;</div>
<div class="line"><a name="l00411"></a><span class="lineno"> 411</span>&#160; {</div>
<div class="line"><a name="l00412"></a><span class="lineno"> 412</span>&#160; <a class="code" href="namespacedmlc.html#a591cc4d1980f6074fbc450bcf9d40876">ReadLock</a> guard(m_);</div>
<div class="line"><a name="l00413"></a><span class="lineno"> 413</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">auto</span> iter = threads_.begin(), e_iter = threads_.end(); iter != e_iter; ++iter) {</div>
<div class="line"><a name="l00414"></a><span class="lineno"> 414</span>&#160; <span class="keywordflow">if</span> (!(*iter)-&gt;is_auto_remove()) {</div>
<div class="line"><a name="l00415"></a><span class="lineno"> 415</span>&#160; working_set.emplace(*iter);</div>
<div class="line"><a name="l00416"></a><span class="lineno"> 416</span>&#160; }</div>
<div class="line"><a name="l00417"></a><span class="lineno"> 417</span>&#160; }</div>
<div class="line"><a name="l00418"></a><span class="lineno"> 418</span>&#160; }</div>
<div class="line"><a name="l00419"></a><span class="lineno"> 419</span>&#160; <span class="comment">// Where possible, prefer to do a proper join rather than simply waiting for empty</span></div>
<div class="line"><a name="l00420"></a><span class="lineno"> 420</span>&#160; <span class="comment">// (easier to troubleshoot)</span></div>
<div class="line"><a name="l00421"></a><span class="lineno"> 421</span>&#160; <span class="keywordflow">while</span> (!working_set.empty()) {</div>
<div class="line"><a name="l00422"></a><span class="lineno"> 422</span>&#160; std::shared_ptr&lt;Thread&gt; thrd;</div>
<div class="line"><a name="l00423"></a><span class="lineno"> 423</span>&#160; thrd = *working_set.begin();</div>
<div class="line"><a name="l00424"></a><span class="lineno"> 424</span>&#160; <span class="keywordflow">if</span> (thrd-&gt;joinable()) {</div>
<div class="line"><a name="l00425"></a><span class="lineno"> 425</span>&#160; thrd-&gt;join();</div>
<div class="line"><a name="l00426"></a><span class="lineno"> 426</span>&#160; }</div>
<div class="line"><a name="l00427"></a><span class="lineno"> 427</span>&#160; <a class="code" href="classdmlc_1_1ThreadGroup.html#a67e34b5c574fc168ed9f62cf17de3729">remove_thread</a>(thrd);</div>
<div class="line"><a name="l00428"></a><span class="lineno"> 428</span>&#160; working_set.erase(working_set.begin());</div>
<div class="line"><a name="l00429"></a><span class="lineno"> 429</span>&#160; thrd.reset();</div>
<div class="line"><a name="l00430"></a><span class="lineno"> 430</span>&#160; }</div>
<div class="line"><a name="l00431"></a><span class="lineno"> 431</span>&#160; <span class="comment">// Wait for auto-remove threads (if any) to complete</span></div>
<div class="line"><a name="l00432"></a><span class="lineno"> 432</span>&#160; } <span class="keywordflow">while</span> (0);</div>
<div class="line"><a name="l00433"></a><span class="lineno"> 433</span>&#160; evEmpty_-&gt;wait();</div>
<div class="line"><a name="l00434"></a><span class="lineno"> 434</span>&#160; CHECK_EQ(threads_.size(), 0);</div>
<div class="line"><a name="l00435"></a><span class="lineno"> 435</span>&#160; }</div>
<div class="line"><a name="l00436"></a><span class="lineno"> 436</span>&#160; </div>
<div class="line"><a name="l00441"></a><span class="lineno"><a class="line" href="classdmlc_1_1ThreadGroup.html#a988dc9800999fc4648c7ba32c70c6aa0"> 441</a></span>&#160; <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classdmlc_1_1ThreadGroup.html#a988dc9800999fc4648c7ba32c70c6aa0">request_shutdown_all</a>(<span class="keyword">const</span> <span class="keywordtype">bool</span> make_all_joinable = <span class="keyword">true</span>) {</div>
<div class="line"><a name="l00442"></a><span class="lineno"> 442</span>&#160; std::unique_lock&lt;std::mutex&gt; lk(join_all_mtx_);</div>
<div class="line"><a name="l00443"></a><span class="lineno"> 443</span>&#160; <a class="code" href="namespacedmlc.html#a591cc4d1980f6074fbc450bcf9d40876">ReadLock</a> guard(m_);</div>
<div class="line"><a name="l00444"></a><span class="lineno"> 444</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">auto</span> &amp;thread : threads_) {</div>
<div class="line"><a name="l00445"></a><span class="lineno"> 445</span>&#160; <span class="keywordflow">if</span> (make_all_joinable) {</div>
<div class="line"><a name="l00446"></a><span class="lineno"> 446</span>&#160; thread-&gt;make_joinable();</div>
<div class="line"><a name="l00447"></a><span class="lineno"> 447</span>&#160; }</div>
<div class="line"><a name="l00448"></a><span class="lineno"> 448</span>&#160; thread-&gt;request_shutdown();</div>
<div class="line"><a name="l00449"></a><span class="lineno"> 449</span>&#160; }</div>
<div class="line"><a name="l00450"></a><span class="lineno"> 450</span>&#160; }</div>
<div class="line"><a name="l00451"></a><span class="lineno"> 451</span>&#160; </div>
<div class="line"><a name="l00456"></a><span class="lineno"><a class="line" href="classdmlc_1_1ThreadGroup.html#a934c49ff2a4193d723a728e8e47cabe1"> 456</a></span>&#160; <span class="keyword">inline</span> <span class="keywordtype">size_t</span> <a class="code" href="classdmlc_1_1ThreadGroup.html#a934c49ff2a4193d723a728e8e47cabe1">size</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00457"></a><span class="lineno"> 457</span>&#160; <a class="code" href="namespacedmlc.html#a591cc4d1980f6074fbc450bcf9d40876">ReadLock</a> guard(m_);</div>
<div class="line"><a name="l00458"></a><span class="lineno"> 458</span>&#160; <span class="keywordflow">return</span> threads_.size();</div>
<div class="line"><a name="l00459"></a><span class="lineno"> 459</span>&#160; }</div>
<div class="line"><a name="l00460"></a><span class="lineno"> 460</span>&#160; </div>
<div class="line"><a name="l00465"></a><span class="lineno"><a class="line" href="classdmlc_1_1ThreadGroup.html#a96121f267e7498ff1ec208b0a19c1a40"> 465</a></span>&#160; <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classdmlc_1_1ThreadGroup.html#a96121f267e7498ff1ec208b0a19c1a40">empty</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00466"></a><span class="lineno"> 466</span>&#160; <a class="code" href="namespacedmlc.html#a591cc4d1980f6074fbc450bcf9d40876">ReadLock</a> guard(m_);</div>
<div class="line"><a name="l00467"></a><span class="lineno"> 467</span>&#160; <span class="keywordflow">return</span> threads_.size() == 0;</div>
<div class="line"><a name="l00468"></a><span class="lineno"> 468</span>&#160; }</div>
<div class="line"><a name="l00469"></a><span class="lineno"> 469</span>&#160; </div>
<div class="line"><a name="l00485"></a><span class="lineno"> 485</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> StartFunction, <span class="keyword">typename</span> ThreadType = Thread, <span class="keyword">typename</span> ...Args&gt;</div>
<div class="line"><a name="l00486"></a><span class="lineno"><a class="line" href="classdmlc_1_1ThreadGroup.html#a24822f55ba9f87c5cd6e1014c0543cc0"> 486</a></span>&#160; <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classdmlc_1_1ThreadGroup.html#a24822f55ba9f87c5cd6e1014c0543cc0">create</a>(<span class="keyword">const</span> std::string &amp;threadName,</div>
<div class="line"><a name="l00487"></a><span class="lineno"> 487</span>&#160; <span class="keywordtype">bool</span> auto_remove,</div>
<div class="line"><a name="l00488"></a><span class="lineno"> 488</span>&#160; StartFunction start_function,</div>
<div class="line"><a name="l00489"></a><span class="lineno"> 489</span>&#160; Args... args) {</div>
<div class="line"><a name="l00490"></a><span class="lineno"> 490</span>&#160; <span class="keyword">typename</span> ThreadType::SharedPtr newThread(<span class="keyword">new</span> ThreadType(threadName, <span class="keyword">this</span>));</div>
<div class="line"><a name="l00491"></a><span class="lineno"> 491</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#aba557e3155a2e29664f761a3cf3b9cd5">Thread::launch</a>(newThread, auto_remove, start_function, args...);</div>
<div class="line"><a name="l00492"></a><span class="lineno"> 492</span>&#160; }</div>
<div class="line"><a name="l00493"></a><span class="lineno"> 493</span>&#160; </div>
<div class="line"><a name="l00499"></a><span class="lineno"><a class="line" href="classdmlc_1_1ThreadGroup.html#a92d21f23342f63ffd19402424ba62bd2"> 499</a></span>&#160; <span class="keyword">inline</span> std::shared_ptr&lt;Thread&gt; <a class="code" href="classdmlc_1_1ThreadGroup.html#a92d21f23342f63ffd19402424ba62bd2">thread_by_name</a>(<span class="keyword">const</span> std::string&amp; name) {</div>
<div class="line"><a name="l00500"></a><span class="lineno"> 500</span>&#160; <a class="code" href="namespacedmlc.html#a591cc4d1980f6074fbc450bcf9d40876">ReadLock</a> guard(m_);</div>
<div class="line"><a name="l00501"></a><span class="lineno"> 501</span>&#160; <span class="keyword">auto</span> iter = name_to_thread_.find(name);</div>
<div class="line"><a name="l00502"></a><span class="lineno"> 502</span>&#160; <span class="keywordflow">if</span> (iter != name_to_thread_.end()) {</div>
<div class="line"><a name="l00503"></a><span class="lineno"> 503</span>&#160; <span class="keywordflow">return</span> iter-&gt;second;</div>
<div class="line"><a name="l00504"></a><span class="lineno"> 504</span>&#160; }</div>
<div class="line"><a name="l00505"></a><span class="lineno"> 505</span>&#160; <span class="keywordflow">return</span> <span class="keyword">nullptr</span>;</div>
<div class="line"><a name="l00506"></a><span class="lineno"> 506</span>&#160; }</div>
<div class="line"><a name="l00507"></a><span class="lineno"> 507</span>&#160; </div>
<div class="line"><a name="l00508"></a><span class="lineno"> 508</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00510"></a><span class="lineno"> 510</span>&#160; <span class="keyword">mutable</span> <a class="code" href="namespacedmlc.html#a34fec5df74dfed6c51540a1fcf5bae54">SharedMutex</a> m_;</div>
<div class="line"><a name="l00512"></a><span class="lineno"> 512</span>&#160; <span class="keyword">mutable</span> std::mutex join_all_mtx_;</div>
<div class="line"><a name="l00514"></a><span class="lineno"> 514</span>&#160; std::unordered_set&lt;std::shared_ptr&lt;Thread&gt;&gt; threads_;</div>
<div class="line"><a name="l00516"></a><span class="lineno"> 516</span>&#160; std::shared_ptr&lt;ManualEvent&gt; evEmpty_;</div>
<div class="line"><a name="l00518"></a><span class="lineno"> 518</span>&#160; std::unordered_map&lt;std::string, std::shared_ptr&lt;Thread&gt;&gt; name_to_thread_;</div>
<div class="line"><a name="l00519"></a><span class="lineno"> 519</span>&#160;};</div>
<div class="line"><a name="l00520"></a><span class="lineno"> 520</span>&#160; </div>
<div class="line"><a name="l00527"></a><span class="lineno"> 527</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> ObjectType, ObjectType quit_item&gt;</div>
<div class="line"><a name="l00528"></a><span class="lineno"><a class="line" href="classdmlc_1_1BlockingQueueThread.html"> 528</a></span>&#160;<span class="keyword">class </span><a class="code" href="classdmlc_1_1BlockingQueueThread.html">BlockingQueueThread</a> : <span class="keyword">public</span> <a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html">ThreadGroup::Thread</a> {</div>
<div class="line"><a name="l00529"></a><span class="lineno"> 529</span>&#160; <span class="keyword">using</span> <a class="code" href="classdmlc_1_1BlockingQueueThread.html">BQT</a> = <a class="code" href="classdmlc_1_1BlockingQueueThread.html">BlockingQueueThread&lt;ObjectType, quit_item&gt;</a>;</div>
<div class="line"><a name="l00530"></a><span class="lineno"> 530</span>&#160; </div>
<div class="line"><a name="l00531"></a><span class="lineno"> 531</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00538"></a><span class="lineno"><a class="line" href="classdmlc_1_1BlockingQueueThread.html#a9c7c49eeb905f04d25944f942e27c63a"> 538</a></span>&#160; <a class="code" href="classdmlc_1_1BlockingQueueThread.html#a9c7c49eeb905f04d25944f942e27c63a">BlockingQueueThread</a>(<span class="keyword">const</span> std::string&amp; <a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a34db4d633ab7229256211a7f3690b823">name</a>,</div>
<div class="line"><a name="l00539"></a><span class="lineno"> 539</span>&#160; <a class="code" href="classdmlc_1_1ThreadGroup.html">dmlc::ThreadGroup</a> *owner,</div>
<div class="line"><a name="l00540"></a><span class="lineno"> 540</span>&#160; std::thread *thrd = <span class="keyword">nullptr</span>)</div>
<div class="line"><a name="l00541"></a><span class="lineno"> 541</span>&#160; : <a class="code" href="classdmlc_1_1ThreadGroup.html">ThreadGroup</a>::<a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#af418c16d46e4adc424a84c68a44e0c0b">Thread</a>(<a class="code" href="namespacestd.html">std</a>::move(<a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a34db4d633ab7229256211a7f3690b823">name</a>), owner, thrd)</div>
<div class="line"><a name="l00542"></a><span class="lineno"> 542</span>&#160; , shutdown_in_progress_(false) {</div>
<div class="line"><a name="l00543"></a><span class="lineno"> 543</span>&#160; }</div>
<div class="line"><a name="l00544"></a><span class="lineno"> 544</span>&#160; </div>
<div class="line"><a name="l00545"></a><span class="lineno"> 545</span>&#160; </div>
<div class="line"><a name="l00549"></a><span class="lineno"><a class="line" href="classdmlc_1_1BlockingQueueThread.html#ad6a1139602a954047e4c07f6e44a5e47"> 549</a></span>&#160; <a class="code" href="classdmlc_1_1BlockingQueueThread.html#ad6a1139602a954047e4c07f6e44a5e47">~BlockingQueueThread</a>()<span class="keyword"> override </span>{</div>
<div class="line"><a name="l00550"></a><span class="lineno"> 550</span>&#160; <span class="comment">// Call to parent first because we don&#39;t want to wait for the queue to empty</span></div>
<div class="line"><a name="l00551"></a><span class="lineno"> 551</span>&#160; <a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a0dee1f2d880507a322c28bf2c29bfaee">ThreadGroup::Thread::request_shutdown</a>();</div>
<div class="line"><a name="l00552"></a><span class="lineno"> 552</span>&#160; <a class="code" href="classdmlc_1_1BlockingQueueThread.html#a2db37aa339c11da94a0ce81f52d2d5c7">request_shutdown</a>();</div>
<div class="line"><a name="l00553"></a><span class="lineno"> 553</span>&#160; }</div>
<div class="line"><a name="l00554"></a><span class="lineno"> 554</span>&#160; </div>
<div class="line"><a name="l00562"></a><span class="lineno"><a class="line" href="classdmlc_1_1BlockingQueueThread.html#a2db37aa339c11da94a0ce81f52d2d5c7"> 562</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classdmlc_1_1BlockingQueueThread.html#a2db37aa339c11da94a0ce81f52d2d5c7">request_shutdown</a>()<span class="keyword"> override </span>{</div>
<div class="line"><a name="l00563"></a><span class="lineno"> 563</span>&#160; shutdown_in_progress_ = <span class="keyword">true</span>;</div>
<div class="line"><a name="l00564"></a><span class="lineno"> 564</span>&#160; <span class="keywordflow">while</span> (queue_-&gt;size_approx() &gt; 0 &amp;&amp; !<a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#aa880e5707af1df23523142850f36dc45">ThreadGroup::Thread::is_shutdown_requested</a>()) {</div>
<div class="line"><a name="l00565"></a><span class="lineno"> 565</span>&#160; std::this_thread::sleep_for(std::chrono::milliseconds(1));</div>
<div class="line"><a name="l00566"></a><span class="lineno"> 566</span>&#160; }</div>
<div class="line"><a name="l00567"></a><span class="lineno"> 567</span>&#160; <a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a0dee1f2d880507a322c28bf2c29bfaee">ThreadGroup::Thread::request_shutdown</a>();</div>
<div class="line"><a name="l00568"></a><span class="lineno"> 568</span>&#160; queue_-&gt;enqueue(quit_item);</div>
<div class="line"><a name="l00569"></a><span class="lineno"> 569</span>&#160; }</div>
<div class="line"><a name="l00570"></a><span class="lineno"> 570</span>&#160; </div>
<div class="line"><a name="l00575"></a><span class="lineno"><a class="line" href="classdmlc_1_1BlockingQueueThread.html#ab35b71aeadb50884b8ac273de30ba306"> 575</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classdmlc_1_1BlockingQueueThread.html#ab35b71aeadb50884b8ac273de30ba306">enqueue</a>(<span class="keyword">const</span> ObjectType&amp; item) {</div>
<div class="line"><a name="l00576"></a><span class="lineno"> 576</span>&#160; <span class="keywordflow">if</span> (!shutdown_in_progress_) {</div>
<div class="line"><a name="l00577"></a><span class="lineno"> 577</span>&#160; queue_-&gt;enqueue(item);</div>
<div class="line"><a name="l00578"></a><span class="lineno"> 578</span>&#160; }</div>
<div class="line"><a name="l00579"></a><span class="lineno"> 579</span>&#160; }</div>
<div class="line"><a name="l00580"></a><span class="lineno"> 580</span>&#160; </div>
<div class="line"><a name="l00585"></a><span class="lineno"><a class="line" href="classdmlc_1_1BlockingQueueThread.html#a31100f23c0701bf1d9d64d8676eb6bf8"> 585</a></span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="classdmlc_1_1BlockingQueueThread.html#a31100f23c0701bf1d9d64d8676eb6bf8">size_approx</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> queue_-&gt;size_approx(); }</div>
<div class="line"><a name="l00586"></a><span class="lineno"> 586</span>&#160; </div>
<div class="line"><a name="l00597"></a><span class="lineno"> 597</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> SecondaryFunction&gt;</div>
<div class="line"><a name="l00598"></a><span class="lineno"><a class="line" href="classdmlc_1_1BlockingQueueThread.html#a1265e3383d5cbf06ec24d415de194159"> 598</a></span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classdmlc_1_1BlockingQueueThread.html#a1265e3383d5cbf06ec24d415de194159">launch_run</a>(std::shared_ptr&lt;BQT&gt; pThis,</div>
<div class="line"><a name="l00599"></a><span class="lineno"> 599</span>&#160; SecondaryFunction secondary_function) {</div>
<div class="line"><a name="l00600"></a><span class="lineno"> 600</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#aba557e3155a2e29664f761a3cf3b9cd5">ThreadGroup::Thread::launch</a>(pThis, <span class="keyword">true</span>, [](std::shared_ptr&lt;BQT&gt; pThis,</div>
<div class="line"><a name="l00601"></a><span class="lineno"> 601</span>&#160; SecondaryFunction secondary_function) {</div>
<div class="line"><a name="l00602"></a><span class="lineno"> 602</span>&#160; <span class="keywordflow">return</span> pThis-&gt;run(secondary_function);</div>
<div class="line"><a name="l00603"></a><span class="lineno"> 603</span>&#160; },</div>
<div class="line"><a name="l00604"></a><span class="lineno"> 604</span>&#160; pThis, secondary_function);</div>
<div class="line"><a name="l00605"></a><span class="lineno"> 605</span>&#160; }</div>
<div class="line"><a name="l00606"></a><span class="lineno"> 606</span>&#160; </div>
<div class="line"><a name="l00613"></a><span class="lineno"> 613</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> OnItemFunction&gt;</div>
<div class="line"><a name="l00614"></a><span class="lineno"><a class="line" href="classdmlc_1_1BlockingQueueThread.html#aa936269ba93556a380b32f49df6a1829"> 614</a></span>&#160; <span class="keyword">inline</span> <span class="keywordtype">int</span> <a class="code" href="classdmlc_1_1BlockingQueueThread.html#aa936269ba93556a380b32f49df6a1829">run</a>(OnItemFunction on_item_function) {</div>
<div class="line"><a name="l00615"></a><span class="lineno"> 615</span>&#160; <span class="keywordtype">int</span> rc = 0;</div>
<div class="line"><a name="l00616"></a><span class="lineno"> 616</span>&#160; <span class="keywordflow">do</span> {</div>
<div class="line"><a name="l00617"></a><span class="lineno"> 617</span>&#160; ObjectType item;</div>
<div class="line"><a name="l00618"></a><span class="lineno"> 618</span>&#160; queue_-&gt;wait_dequeue(item);</div>
<div class="line"><a name="l00619"></a><span class="lineno"> 619</span>&#160; <span class="keywordflow">if</span> (item == quit_item) {</div>
<div class="line"><a name="l00620"></a><span class="lineno"> 620</span>&#160; <span class="keywordflow">break</span>;</div>
<div class="line"><a name="l00621"></a><span class="lineno"> 621</span>&#160; }</div>
<div class="line"><a name="l00622"></a><span class="lineno"> 622</span>&#160; rc = on_item_function(item);</div>
<div class="line"><a name="l00623"></a><span class="lineno"> 623</span>&#160; <span class="keywordflow">if</span> (rc) {</div>
<div class="line"><a name="l00624"></a><span class="lineno"> 624</span>&#160; <span class="keywordflow">break</span>;</div>
<div class="line"><a name="l00625"></a><span class="lineno"> 625</span>&#160; }</div>
<div class="line"><a name="l00626"></a><span class="lineno"> 626</span>&#160; } <span class="keywordflow">while</span> (<span class="keyword">true</span>);</div>
<div class="line"><a name="l00627"></a><span class="lineno"> 627</span>&#160; <span class="keywordflow">return</span> rc;</div>
<div class="line"><a name="l00628"></a><span class="lineno"> 628</span>&#160; }</div>
<div class="line"><a name="l00629"></a><span class="lineno"> 629</span>&#160; </div>
<div class="line"><a name="l00630"></a><span class="lineno"> 630</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00632"></a><span class="lineno"> 632</span>&#160; std::shared_ptr&lt;dmlc::moodycamel::BlockingConcurrentQueue&lt;ObjectType&gt;&gt; queue_ =</div>
<div class="line"><a name="l00633"></a><span class="lineno"> 633</span>&#160; std::make_shared&lt;dmlc::moodycamel::BlockingConcurrentQueue&lt;ObjectType&gt;&gt;();</div>
<div class="line"><a name="l00635"></a><span class="lineno"> 635</span>&#160; std::atomic&lt;bool&gt; shutdown_in_progress_;</div>
<div class="line"><a name="l00636"></a><span class="lineno"> 636</span>&#160;};</div>
<div class="line"><a name="l00637"></a><span class="lineno"> 637</span>&#160; </div>
<div class="line"><a name="l00642"></a><span class="lineno"> 642</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> Duration&gt;</div>
<div class="line"><a name="l00643"></a><span class="lineno"><a class="line" href="classdmlc_1_1TimerThread.html"> 643</a></span>&#160;<span class="keyword">class </span><a class="code" href="classdmlc_1_1TimerThread.html">TimerThread</a> : <span class="keyword">public</span> <a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html">ThreadGroup::Thread</a> {</div>
<div class="line"><a name="l00644"></a><span class="lineno"> 644</span>&#160; <span class="keyword">using</span> <a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#aa880e5707af1df23523142850f36dc45">ThreadGroup::Thread::is_shutdown_requested</a>;</div>
<div class="line"><a name="l00645"></a><span class="lineno"> 645</span>&#160; </div>
<div class="line"><a name="l00646"></a><span class="lineno"> 646</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00652"></a><span class="lineno"><a class="line" href="classdmlc_1_1TimerThread.html#a54dc803653b7202f0aa4fc65b387eaea"> 652</a></span>&#160; <a class="code" href="classdmlc_1_1TimerThread.html#a54dc803653b7202f0aa4fc65b387eaea">TimerThread</a>(<span class="keyword">const</span> std::string&amp; <a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a34db4d633ab7229256211a7f3690b823">name</a>, <a class="code" href="classdmlc_1_1ThreadGroup.html">ThreadGroup</a> *owner)</div>
<div class="line"><a name="l00653"></a><span class="lineno"> 653</span>&#160; : <a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#af418c16d46e4adc424a84c68a44e0c0b">Thread</a>(<a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a34db4d633ab7229256211a7f3690b823">name</a>, owner) {</div>
<div class="line"><a name="l00654"></a><span class="lineno"> 654</span>&#160; }</div>
<div class="line"><a name="l00655"></a><span class="lineno"> 655</span>&#160; </div>
<div class="line"><a name="l00659"></a><span class="lineno"><a class="line" href="classdmlc_1_1TimerThread.html#a6240348c133cae9033439bc1cfda0d5d"> 659</a></span>&#160; <a class="code" href="classdmlc_1_1TimerThread.html#a6240348c133cae9033439bc1cfda0d5d">~TimerThread</a>()<span class="keyword"> override </span>{</div>
<div class="line"><a name="l00660"></a><span class="lineno"> 660</span>&#160; <a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#a0dee1f2d880507a322c28bf2c29bfaee">request_shutdown</a>();</div>
<div class="line"><a name="l00661"></a><span class="lineno"> 661</span>&#160; }</div>
<div class="line"><a name="l00662"></a><span class="lineno"> 662</span>&#160; </div>
<div class="line"><a name="l00673"></a><span class="lineno"> 673</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> SecondaryFunction&gt;</div>
<div class="line"><a name="l00674"></a><span class="lineno"><a class="line" href="classdmlc_1_1TimerThread.html#a0803f0c18898e6740a841dcd29412b52"> 674</a></span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classdmlc_1_1TimerThread.html#a0803f0c18898e6740a841dcd29412b52">launch_run</a>(std::shared_ptr&lt;<a class="code" href="classdmlc_1_1TimerThread.html">TimerThread&lt;Duration&gt;</a>&gt; pThis,</div>
<div class="line"><a name="l00675"></a><span class="lineno"> 675</span>&#160; SecondaryFunction secondary_function) {</div>
<div class="line"><a name="l00676"></a><span class="lineno"> 676</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#aba557e3155a2e29664f761a3cf3b9cd5">ThreadGroup::Thread::launch</a>(pThis, <span class="keyword">true</span>, [](std::shared_ptr&lt;<a class="code" href="classdmlc_1_1TimerThread.html">TimerThread&lt;Duration&gt;</a>&gt; pThis,</div>
<div class="line"><a name="l00677"></a><span class="lineno"> 677</span>&#160; SecondaryFunction secondary_function) {</div>
<div class="line"><a name="l00678"></a><span class="lineno"> 678</span>&#160; <span class="keywordflow">return</span> pThis-&gt;run(secondary_function);</div>
<div class="line"><a name="l00679"></a><span class="lineno"> 679</span>&#160; },</div>
<div class="line"><a name="l00680"></a><span class="lineno"> 680</span>&#160; pThis, secondary_function);</div>
<div class="line"><a name="l00681"></a><span class="lineno"> 681</span>&#160; }</div>
<div class="line"><a name="l00682"></a><span class="lineno"> 682</span>&#160; </div>
<div class="line"><a name="l00692"></a><span class="lineno"> 692</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Function&gt;</div>
<div class="line"><a name="l00693"></a><span class="lineno"><a class="line" href="classdmlc_1_1TimerThread.html#a70a66d054f9d82fdf2c69d981af4cdce"> 693</a></span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classdmlc_1_1TimerThread.html#a70a66d054f9d82fdf2c69d981af4cdce">start</a>(std::shared_ptr&lt;TimerThread&gt; timer_thread,</div>
<div class="line"><a name="l00694"></a><span class="lineno"> 694</span>&#160; Duration duration,</div>
<div class="line"><a name="l00695"></a><span class="lineno"> 695</span>&#160; Function <span class="keyword">function</span>) {</div>
<div class="line"><a name="l00696"></a><span class="lineno"> 696</span>&#160; timer_thread-&gt;duration_ = duration;</div>
<div class="line"><a name="l00697"></a><span class="lineno"> 697</span>&#160; <a class="code" href="classdmlc_1_1TimerThread.html#a0803f0c18898e6740a841dcd29412b52">launch_run</a>(timer_thread, <span class="keyword">function</span>);</div>
<div class="line"><a name="l00698"></a><span class="lineno"> 698</span>&#160; }</div>
<div class="line"><a name="l00699"></a><span class="lineno"> 699</span>&#160; </div>
<div class="line"><a name="l00706"></a><span class="lineno"> 706</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> OnTimerFunction&gt;</div>
<div class="line"><a name="l00707"></a><span class="lineno"><a class="line" href="classdmlc_1_1TimerThread.html#a3290c611d98f9301c3174a8453714ecb"> 707</a></span>&#160; <span class="keyword">inline</span> <span class="keywordtype">int</span> <a class="code" href="classdmlc_1_1TimerThread.html#a3290c611d98f9301c3174a8453714ecb">run</a>(OnTimerFunction on_timer_function) {</div>
<div class="line"><a name="l00708"></a><span class="lineno"> 708</span>&#160; <span class="keywordtype">int</span> rc = 0;</div>
<div class="line"><a name="l00709"></a><span class="lineno"> 709</span>&#160; <span class="keywordflow">while</span> (!<a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#aa880e5707af1df23523142850f36dc45">is_shutdown_requested</a>()) {</div>
<div class="line"><a name="l00710"></a><span class="lineno"> 710</span>&#160; std::this_thread::sleep_for(duration_);</div>
<div class="line"><a name="l00711"></a><span class="lineno"> 711</span>&#160; <span class="keywordflow">if</span> (!<a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#aa880e5707af1df23523142850f36dc45">is_shutdown_requested</a>()) {</div>
<div class="line"><a name="l00712"></a><span class="lineno"> 712</span>&#160; rc = on_timer_function();</div>
<div class="line"><a name="l00713"></a><span class="lineno"> 713</span>&#160; }</div>
<div class="line"><a name="l00714"></a><span class="lineno"> 714</span>&#160; }</div>
<div class="line"><a name="l00715"></a><span class="lineno"> 715</span>&#160; <span class="keywordflow">return</span> rc;</div>
<div class="line"><a name="l00716"></a><span class="lineno"> 716</span>&#160; }</div>
<div class="line"><a name="l00717"></a><span class="lineno"> 717</span>&#160; </div>
<div class="line"><a name="l00718"></a><span class="lineno"> 718</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00719"></a><span class="lineno"> 719</span>&#160; Duration duration_;</div>
<div class="line"><a name="l00720"></a><span class="lineno"> 720</span>&#160;};</div>
<div class="line"><a name="l00721"></a><span class="lineno"> 721</span>&#160; </div>
<div class="line"><a name="l00722"></a><span class="lineno"> 722</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00723"></a><span class="lineno"> 723</span>&#160;<span class="comment"> * Inline functions - see declarations for usage</span></div>
<div class="line"><a name="l00724"></a><span class="lineno"> 724</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00725"></a><span class="lineno"> 725</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> StartFunction, <span class="keyword">typename</span> ...Args&gt;</div>
<div class="line"><a name="l00726"></a><span class="lineno"> 726</span>&#160;<span class="keyword">inline</span> <span class="keywordtype">int</span> ThreadGroup::Thread::entry_and_exit_f(std::shared_ptr&lt;Thread&gt; pThis,</div>
<div class="line"><a name="l00727"></a><span class="lineno"> 727</span>&#160; StartFunction start_function,</div>
<div class="line"><a name="l00728"></a><span class="lineno"> 728</span>&#160; Args... args) {</div>
<div class="line"><a name="l00729"></a><span class="lineno"> 729</span>&#160; <span class="keywordtype">int</span> rc;</div>
<div class="line"><a name="l00730"></a><span class="lineno"> 730</span>&#160; <span class="keywordflow">if</span> (pThis) {</div>
<div class="line"><a name="l00731"></a><span class="lineno"> 731</span>&#160; <span class="comment">// Signal launcher that we&#39;re up and running</span></div>
<div class="line"><a name="l00732"></a><span class="lineno"> 732</span>&#160; pThis-&gt;ready_event_-&gt;signal();</div>
<div class="line"><a name="l00733"></a><span class="lineno"> 733</span>&#160; <span class="comment">// Wait for launcher to be ready for us to start</span></div>
<div class="line"><a name="l00734"></a><span class="lineno"> 734</span>&#160; pThis-&gt;start_event_-&gt;wait();</div>
<div class="line"><a name="l00735"></a><span class="lineno"> 735</span>&#160; <span class="comment">// Reset start_event_ for possible reuse</span></div>
<div class="line"><a name="l00736"></a><span class="lineno"> 736</span>&#160; pThis-&gt;start_event_-&gt;reset(); <span class="comment">// Reset in case it needs to be reused</span></div>
<div class="line"><a name="l00737"></a><span class="lineno"> 737</span>&#160; <span class="comment">// If we haven&#39;t been requested to shut down prematurely, then run the desired function</span></div>
<div class="line"><a name="l00738"></a><span class="lineno"> 738</span>&#160; <span class="keywordflow">if</span> (!pThis-&gt;is_shutdown_requested()) {</div>
<div class="line"><a name="l00739"></a><span class="lineno"> 739</span>&#160; rc = start_function(args...);</div>
<div class="line"><a name="l00740"></a><span class="lineno"> 740</span>&#160; } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00741"></a><span class="lineno"> 741</span>&#160; rc = -1;</div>
<div class="line"><a name="l00742"></a><span class="lineno"> 742</span>&#160; }</div>
<div class="line"><a name="l00743"></a><span class="lineno"> 743</span>&#160; <span class="comment">// If we&#39;re set up as auto-remove, then remove this thread from the thread group</span></div>
<div class="line"><a name="l00744"></a><span class="lineno"> 744</span>&#160; <span class="keywordflow">if</span> (pThis-&gt;is_auto_remove()) {</div>
<div class="line"><a name="l00745"></a><span class="lineno"> 745</span>&#160; pThis-&gt;owner_-&gt;remove_thread(pThis);</div>
<div class="line"><a name="l00746"></a><span class="lineno"> 746</span>&#160; }</div>
<div class="line"><a name="l00747"></a><span class="lineno"> 747</span>&#160; <span class="comment">// Release this thread shared pinter. May or may not be the last reference.</span></div>
<div class="line"><a name="l00748"></a><span class="lineno"> 748</span>&#160; pThis.reset();</div>
<div class="line"><a name="l00749"></a><span class="lineno"> 749</span>&#160; } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00750"></a><span class="lineno"> 750</span>&#160; LOG(ERROR) &lt;&lt; <span class="stringliteral">&quot;Null pThis thread pointer&quot;</span>;</div>
<div class="line"><a name="l00751"></a><span class="lineno"> 751</span>&#160; rc = EINVAL;</div>
<div class="line"><a name="l00752"></a><span class="lineno"> 752</span>&#160; }</div>
<div class="line"><a name="l00753"></a><span class="lineno"> 753</span>&#160; <span class="keywordflow">return</span> rc;</div>
<div class="line"><a name="l00754"></a><span class="lineno"> 754</span>&#160;}</div>
<div class="line"><a name="l00755"></a><span class="lineno"> 755</span>&#160; </div>
<div class="line"><a name="l00756"></a><span class="lineno"> 756</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> StartFunction, <span class="keyword">typename</span> ...Args&gt;</div>
<div class="line"><a name="l00757"></a><span class="lineno"><a class="line" href="classdmlc_1_1ThreadGroup_1_1Thread.html#aba557e3155a2e29664f761a3cf3b9cd5"> 757</a></span>&#160;<span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classdmlc_1_1ThreadGroup_1_1Thread.html#aba557e3155a2e29664f761a3cf3b9cd5">ThreadGroup::Thread::launch</a>(std::shared_ptr&lt;Thread&gt; pThis,</div>
<div class="line"><a name="l00758"></a><span class="lineno"> 758</span>&#160; <span class="keywordtype">bool</span> autoRemove,</div>
<div class="line"><a name="l00759"></a><span class="lineno"> 759</span>&#160; StartFunction start_function,</div>
<div class="line"><a name="l00760"></a><span class="lineno"> 760</span>&#160; Args ...args) {</div>
<div class="line"><a name="l00761"></a><span class="lineno"> 761</span>&#160; <a class="code" href="namespacedmlc.html#aad58a9dfecc6e970348c217de29bb916">WriteLock</a> guard(pThis-&gt;thread_mutex_);</div>
<div class="line"><a name="l00762"></a><span class="lineno"> 762</span>&#160; CHECK_EQ(!pThis-&gt;thread_.load(), <span class="keyword">true</span>);</div>
<div class="line"><a name="l00763"></a><span class="lineno"> 763</span>&#160; CHECK_NOTNULL(pThis-&gt;owner_);</div>
<div class="line"><a name="l00764"></a><span class="lineno"> 764</span>&#160; <span class="comment">// Set auto remove</span></div>
<div class="line"><a name="l00765"></a><span class="lineno"> 765</span>&#160; pThis-&gt;auto_remove_ = autoRemove;</div>
<div class="line"><a name="l00766"></a><span class="lineno"> 766</span>&#160; <span class="comment">// Create the actual stl thread object</span></div>
<div class="line"><a name="l00767"></a><span class="lineno"> 767</span>&#160; pThis-&gt;thread_ = <span class="keyword">new</span> std::thread(Thread::template entry_and_exit_f&lt;</div>
<div class="line"><a name="l00768"></a><span class="lineno"> 768</span>&#160; StartFunction, Args...&gt;,</div>
<div class="line"><a name="l00769"></a><span class="lineno"> 769</span>&#160; pThis,</div>
<div class="line"><a name="l00770"></a><span class="lineno"> 770</span>&#160; start_function,</div>
<div class="line"><a name="l00771"></a><span class="lineno"> 771</span>&#160; args...);</div>
<div class="line"><a name="l00772"></a><span class="lineno"> 772</span>&#160; <span class="comment">// Attempt to add the thread to the thread group (after started, since in case</span></div>
<div class="line"><a name="l00773"></a><span class="lineno"> 773</span>&#160; <span class="comment">// something goes wrong, there&#39;s not a zombie thread in the thread group)</span></div>
<div class="line"><a name="l00774"></a><span class="lineno"> 774</span>&#160; <span class="keywordflow">if</span> (!pThis-&gt;owner_-&gt;add_thread(pThis)) {</div>
<div class="line"><a name="l00775"></a><span class="lineno"> 775</span>&#160; pThis-&gt;request_shutdown();</div>
<div class="line"><a name="l00776"></a><span class="lineno"> 776</span>&#160; LOG(ERROR) &lt;&lt; <span class="stringliteral">&quot;Duplicate thread name within the same thread group is not allowed&quot;</span>;</div>
<div class="line"><a name="l00777"></a><span class="lineno"> 777</span>&#160; }</div>
<div class="line"><a name="l00778"></a><span class="lineno"> 778</span>&#160; <span class="comment">// Wait for the thread to spin up</span></div>
<div class="line"><a name="l00779"></a><span class="lineno"> 779</span>&#160; pThis-&gt;ready_event_-&gt;wait();</div>
<div class="line"><a name="l00780"></a><span class="lineno"> 780</span>&#160; <span class="comment">// Signal the thgread to continue (it will check its shutdown status)</span></div>
<div class="line"><a name="l00781"></a><span class="lineno"> 781</span>&#160; pThis-&gt;start_event_-&gt;signal();</div>
<div class="line"><a name="l00782"></a><span class="lineno"> 782</span>&#160; <span class="comment">// Return if successful</span></div>
<div class="line"><a name="l00783"></a><span class="lineno"> 783</span>&#160; <span class="keywordflow">return</span> pThis-&gt;thread_.load() != <span class="keyword">nullptr</span>;</div>
<div class="line"><a name="l00784"></a><span class="lineno"> 784</span>&#160;}</div>
<div class="line"><a name="l00785"></a><span class="lineno"> 785</span>&#160; </div>
<div class="line"><a name="l00796"></a><span class="lineno"> 796</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> Duration, <span class="keyword">typename</span> TimerFunction&gt;</div>
<div class="line"><a name="l00797"></a><span class="lineno"><a class="line" href="namespacedmlc.html#a3af1c5a5f5dd3a6741693071f85d67ce"> 797</a></span>&#160;<span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="namespacedmlc.html#a3af1c5a5f5dd3a6741693071f85d67ce">CreateTimer</a>(<span class="keyword">const</span> std::string&amp; timer_name,</div>
<div class="line"><a name="l00798"></a><span class="lineno"> 798</span>&#160; <span class="keyword">const</span> Duration&amp; duration,</div>
<div class="line"><a name="l00799"></a><span class="lineno"> 799</span>&#160; <a class="code" href="classdmlc_1_1ThreadGroup.html">ThreadGroup</a> *owner,</div>
<div class="line"><a name="l00800"></a><span class="lineno"> 800</span>&#160; TimerFunction timer_function) {</div>
<div class="line"><a name="l00801"></a><span class="lineno"> 801</span>&#160; std::shared_ptr&lt;dmlc::TimerThread&lt;Duration&gt;&gt; timer_thread =</div>
<div class="line"><a name="l00802"></a><span class="lineno"> 802</span>&#160; std::make_shared&lt;dmlc::TimerThread&lt;Duration&gt;&gt;(timer_name, owner);</div>
<div class="line"><a name="l00803"></a><span class="lineno"> 803</span>&#160; <a class="code" href="classdmlc_1_1TimerThread.html#a70a66d054f9d82fdf2c69d981af4cdce">dmlc::TimerThread&lt;Duration&gt;::start</a>(timer_thread, duration, timer_function);</div>
<div class="line"><a name="l00804"></a><span class="lineno"> 804</span>&#160; <span class="keywordflow">return</span> timer_thread != <span class="keyword">nullptr</span>;</div>
<div class="line"><a name="l00805"></a><span class="lineno"> 805</span>&#160;}</div>
<div class="line"><a name="l00806"></a><span class="lineno"> 806</span>&#160;} <span class="comment">// namespace dmlc</span></div>
<div class="line"><a name="l00807"></a><span class="lineno"> 807</span>&#160; </div>
<div class="line"><a name="l00808"></a><span class="lineno"> 808</span>&#160;<span class="preprocessor">#endif // DMLC_THREAD_GROUP_H_</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassdmlc_1_1TimerThread_html"><div class="ttname"><a href="classdmlc_1_1TimerThread.html">dmlc::TimerThread</a></div><div class="ttdoc">Managed timer thread.</div><div class="ttdef"><b>Definition:</b> thread_group.h:643</div></div>
<div class="ttc" id="aclassdmlc_1_1ThreadGroup_1_1Thread_html_a0aad366a57a4553a1beb3af637071cc0"><div class="ttname"><a href="classdmlc_1_1ThreadGroup_1_1Thread.html#a0aad366a57a4553a1beb3af637071cc0">dmlc::ThreadGroup::Thread::get_id</a></div><div class="ttdeci">std::thread::id get_id() const</div><div class="ttdoc">Get this thread's id.</div><div class="ttdef"><b>Definition:</b> thread_group.h:245</div></div>
<div class="ttc" id="aclassdmlc_1_1BlockingQueueThread_html_ad6a1139602a954047e4c07f6e44a5e47"><div class="ttname"><a href="classdmlc_1_1BlockingQueueThread.html#ad6a1139602a954047e4c07f6e44a5e47">dmlc::BlockingQueueThread::~BlockingQueueThread</a></div><div class="ttdeci">~BlockingQueueThread() override</div><div class="ttdoc">Destructor.</div><div class="ttdef"><b>Definition:</b> thread_group.h:549</div></div>
<div class="ttc" id="aclassdmlc_1_1ThreadGroup_1_1Thread_html_a7e13b559e8afc0e933ca7c6e7fe004e3"><div class="ttname"><a href="classdmlc_1_1ThreadGroup_1_1Thread.html#a7e13b559e8afc0e933ca7c6e7fe004e3">dmlc::ThreadGroup::Thread::join</a></div><div class="ttdeci">void join()</div><div class="ttdoc">Thread join.</div><div class="ttdef"><b>Definition:</b> thread_group.h:237</div></div>
<div class="ttc" id="anamespacedmlc_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="ablockingconcurrentqueue_8h_html"><div class="ttname"><a href="blockingconcurrentqueue_8h.html">blockingconcurrentqueue.h</a></div></div>
<div class="ttc" id="aclassdmlc_1_1ThreadGroup_html_ac4a88fba4560dbbba3efac98e6d0f347"><div class="ttname"><a href="classdmlc_1_1ThreadGroup.html#ac4a88fba4560dbbba3efac98e6d0f347">dmlc::ThreadGroup::~ThreadGroup</a></div><div class="ttdeci">virtual ~ThreadGroup()</div><div class="ttdoc">Destructor, perform cleanup. All child threads will be exited when this destructor completes.</div><div class="ttdef"><b>Definition:</b> thread_group.h:319</div></div>
<div class="ttc" id="aclassdmlc_1_1BlockingQueueThread_html"><div class="ttname"><a href="classdmlc_1_1BlockingQueueThread.html">dmlc::BlockingQueueThread</a></div><div class="ttdoc">Blocking queue thread class.</div><div class="ttdef"><b>Definition:</b> thread_group.h:528</div></div>
<div class="ttc" id="aclassdmlc_1_1BlockingQueueThread_html_a2db37aa339c11da94a0ce81f52d2d5c7"><div class="ttname"><a href="classdmlc_1_1BlockingQueueThread.html#a2db37aa339c11da94a0ce81f52d2d5c7">dmlc::BlockingQueueThread::request_shutdown</a></div><div class="ttdeci">void request_shutdown() override</div><div class="ttdoc">Signal the thread that a shutdown is desired.</div><div class="ttdef"><b>Definition:</b> thread_group.h:562</div></div>
<div class="ttc" id="aclassdmlc_1_1ThreadGroup_1_1Thread_html_a25667e2d229f416bd324bfc7d28ad47d"><div class="ttname"><a href="classdmlc_1_1ThreadGroup_1_1Thread.html#a25667e2d229f416bd324bfc7d28ad47d">dmlc::ThreadGroup::Thread::~Thread</a></div><div class="ttdeci">virtual ~Thread()</div><div class="ttdoc">Destructor with cleanup.</div><div class="ttdef"><b>Definition:</b> thread_group.h:126</div></div>
<div class="ttc" id="aclassdmlc_1_1ManualEvent_html_ad1c15c34d3b237dd878aaa9f6ca31f16"><div class="ttname"><a href="classdmlc_1_1ManualEvent.html#ad1c15c34d3b237dd878aaa9f6ca31f16">dmlc::ManualEvent::reset</a></div><div class="ttdeci">void reset()</div><div class="ttdoc">Manually reset this object's state to unsignaled (wait() will block)</div><div class="ttdef"><b>Definition:</b> thread_group.h:61</div></div>
<div class="ttc" id="aclassdmlc_1_1ThreadGroup_html_aa0118655398fe78cf9faa466b043536f"><div class="ttname"><a href="classdmlc_1_1ThreadGroup.html#aa0118655398fe78cf9faa466b043536f">dmlc::ThreadGroup::is_thread_in</a></div><div class="ttdeci">bool is_thread_in(std::shared_ptr&lt; Thread &gt; thrd) const</div><div class="ttdoc">Check if the current thread is a member of this ThreadGroup.</div><div class="ttdef"><b>Definition:</b> thread_group.h:346</div></div>
<div class="ttc" id="aclassdmlc_1_1ThreadGroup_1_1Thread_html_aba557e3155a2e29664f761a3cf3b9cd5"><div class="ttname"><a href="classdmlc_1_1ThreadGroup_1_1Thread.html#aba557e3155a2e29664f761a3cf3b9cd5">dmlc::ThreadGroup::Thread::launch</a></div><div class="ttdeci">static bool launch(std::shared_ptr&lt; Thread &gt; pThis, bool autoRemove, StartFunction start_function, Args ...args)</div><div class="ttdoc">Launch the given Thread object.</div><div class="ttdef"><b>Definition:</b> thread_group.h:757</div></div>
<div class="ttc" id="aclassdmlc_1_1TimerThread_html_a3290c611d98f9301c3174a8453714ecb"><div class="ttname"><a href="classdmlc_1_1TimerThread.html#a3290c611d98f9301c3174a8453714ecb">dmlc::TimerThread::run</a></div><div class="ttdeci">int run(OnTimerFunction on_timer_function)</div><div class="ttdoc">Internal timer execution function.</div><div class="ttdef"><b>Definition:</b> thread_group.h:707</div></div>
<div class="ttc" id="aclassdmlc_1_1ThreadGroup_html"><div class="ttname"><a href="classdmlc_1_1ThreadGroup.html">dmlc::ThreadGroup</a></div><div class="ttdoc">Thread lifecycle management group.</div><div class="ttdef"><b>Definition:</b> thread_group.h:95</div></div>
<div class="ttc" id="aclassdmlc_1_1ThreadGroup_1_1Thread_html_aa880e5707af1df23523142850f36dc45"><div class="ttname"><a href="classdmlc_1_1ThreadGroup_1_1Thread.html#aa880e5707af1df23523142850f36dc45">dmlc::ThreadGroup::Thread::is_shutdown_requested</a></div><div class="ttdeci">virtual bool is_shutdown_requested() const</div><div class="ttdoc">Check whether shutdown has been requested (request_shutdown() was called)</div><div class="ttdef"><b>Definition:</b> thread_group.h:197</div></div>
<div class="ttc" id="aclassdmlc_1_1ThreadGroup_html_a24822f55ba9f87c5cd6e1014c0543cc0"><div class="ttname"><a href="classdmlc_1_1ThreadGroup.html#a24822f55ba9f87c5cd6e1014c0543cc0">dmlc::ThreadGroup::create</a></div><div class="ttdeci">bool create(const std::string &amp;threadName, bool auto_remove, StartFunction start_function, Args... args)</div><div class="ttdoc">Create and launch a new Thread object which will be owned by this ThreadGroup.</div><div class="ttdef"><b>Definition:</b> thread_group.h:486</div></div>
<div class="ttc" id="aclassdmlc_1_1ThreadGroup_1_1Thread_html"><div class="ttname"><a href="classdmlc_1_1ThreadGroup_1_1Thread.html">dmlc::ThreadGroup::Thread</a></div><div class="ttdoc">Lifecycle-managed thread (used by ThreadGroup)</div><div class="ttdef"><b>Definition:</b> thread_group.h:101</div></div>
<div class="ttc" id="aclassdmlc_1_1ThreadGroup_html_a67e34b5c574fc168ed9f62cf17de3729"><div class="ttname"><a href="classdmlc_1_1ThreadGroup.html#a67e34b5c574fc168ed9f62cf17de3729">dmlc::ThreadGroup::remove_thread</a></div><div class="ttdeci">bool remove_thread(std::shared_ptr&lt; Thread &gt; thrd)</div><div class="ttdoc">Remove a Thread object from this thread group.</div><div class="ttdef"><b>Definition:</b> thread_group.h:385</div></div>
<div class="ttc" id="anamespacemxnet_1_1common_1_1cuda_1_1rtc_html_aef7cd83e7f0216b689f5f9d4191d9f8b"><div class="ttname"><a href="namespacemxnet_1_1common_1_1cuda_1_1rtc.html#aef7cd83e7f0216b689f5f9d4191d9f8b">mxnet::common::cuda::rtc::lock</a></div><div class="ttdeci">std::mutex lock</div></div>
<div class="ttc" id="aclassdmlc_1_1ManualEvent_html"><div class="ttname"><a href="classdmlc_1_1ManualEvent.html">dmlc::ManualEvent</a></div><div class="ttdoc">Simple manual-reset event gate which remains open after signalled.</div><div class="ttdef"><b>Definition:</b> thread_group.h:34</div></div>
<div class="ttc" id="aclassdmlc_1_1BlockingQueueThread_html_a9c7c49eeb905f04d25944f942e27c63a"><div class="ttname"><a href="classdmlc_1_1BlockingQueueThread.html#a9c7c49eeb905f04d25944f942e27c63a">dmlc::BlockingQueueThread::BlockingQueueThread</a></div><div class="ttdeci">BlockingQueueThread(const std::string &amp;name, dmlc::ThreadGroup *owner, std::thread *thrd=nullptr)</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> thread_group.h:538</div></div>
<div class="ttc" id="aclassdmlc_1_1BlockingQueueThread_html_aa936269ba93556a380b32f49df6a1829"><div class="ttname"><a href="classdmlc_1_1BlockingQueueThread.html#aa936269ba93556a380b32f49df6a1829">dmlc::BlockingQueueThread::run</a></div><div class="ttdeci">int run(OnItemFunction on_item_function)</div><div class="ttdoc">Thread's main queue processing function.</div><div class="ttdef"><b>Definition:</b> thread_group.h:614</div></div>
<div class="ttc" id="aclassdmlc_1_1ThreadGroup_1_1Thread_html_a34db4d633ab7229256211a7f3690b823"><div class="ttname"><a href="classdmlc_1_1ThreadGroup_1_1Thread.html#a34db4d633ab7229256211a7f3690b823">dmlc::ThreadGroup::Thread::name</a></div><div class="ttdeci">const char * name() const</div><div class="ttdoc">Name of the thread.</div><div class="ttdef"><b>Definition:</b> thread_group.h:149</div></div>
<div class="ttc" id="aclassdmlc_1_1ThreadGroup_1_1Thread_html_a95bee6cfb44fa0added840e1c42ff7f1"><div class="ttname"><a href="classdmlc_1_1ThreadGroup_1_1Thread.html#a95bee6cfb44fa0added840e1c42ff7f1">dmlc::ThreadGroup::Thread::is_current_thread</a></div><div class="ttdeci">bool is_current_thread() const</div><div class="ttdoc">Check if this class represents the currently running thread (self)</div><div class="ttdef"><b>Definition:</b> thread_group.h:177</div></div>
<div class="ttc" id="aclassdmlc_1_1ThreadGroup_html_a934c49ff2a4193d723a728e8e47cabe1"><div class="ttname"><a href="classdmlc_1_1ThreadGroup.html#a934c49ff2a4193d723a728e8e47cabe1">dmlc::ThreadGroup::size</a></div><div class="ttdeci">size_t size() const</div><div class="ttdoc">Return the number of threads in this thread group.</div><div class="ttdef"><b>Definition:</b> thread_group.h:456</div></div>
<div class="ttc" id="aclassdmlc_1_1BlockingQueueThread_html_ab35b71aeadb50884b8ac273de30ba306"><div class="ttname"><a href="classdmlc_1_1BlockingQueueThread.html#ab35b71aeadb50884b8ac273de30ba306">dmlc::BlockingQueueThread::enqueue</a></div><div class="ttdeci">void enqueue(const ObjectType &amp;item)</div><div class="ttdoc">Enqueue and item.</div><div class="ttdef"><b>Definition:</b> thread_group.h:575</div></div>
<div class="ttc" id="anamespacedmlc_html_a34fec5df74dfed6c51540a1fcf5bae54"><div class="ttname"><a href="namespacedmlc.html#a34fec5df74dfed6c51540a1fcf5bae54">dmlc::SharedMutex</a></div><div class="ttdeci">std::recursive_mutex SharedMutex</div><div class="ttdoc">Standard mutex for C++ &lt; 14.</div><div class="ttdef"><b>Definition:</b> thread_group.h:84</div></div>
<div class="ttc" id="aclassdmlc_1_1ThreadGroup_html_a92d21f23342f63ffd19402424ba62bd2"><div class="ttname"><a href="classdmlc_1_1ThreadGroup.html#a92d21f23342f63ffd19402424ba62bd2">dmlc::ThreadGroup::thread_by_name</a></div><div class="ttdeci">std::shared_ptr&lt; Thread &gt; thread_by_name(const std::string &amp;name)</div><div class="ttdoc">Lookup Thread object by name.</div><div class="ttdef"><b>Definition:</b> thread_group.h:499</div></div>
<div class="ttc" id="aclassdmlc_1_1ThreadGroup_1_1Thread_html_a15a7156eee217ef17010947a83632150"><div class="ttname"><a href="classdmlc_1_1ThreadGroup_1_1Thread.html#a15a7156eee217ef17010947a83632150">dmlc::ThreadGroup::Thread::SharedPtr</a></div><div class="ttdeci">std::shared_ptr&lt; Thread &gt; SharedPtr</div><div class="ttdoc">Shared pointer type for readability.</div><div class="ttdef"><b>Definition:</b> thread_group.h:104</div></div>
<div class="ttc" id="aclassdmlc_1_1TimerThread_html_a70a66d054f9d82fdf2c69d981af4cdce"><div class="ttname"><a href="classdmlc_1_1TimerThread.html#a70a66d054f9d82fdf2c69d981af4cdce">dmlc::TimerThread::start</a></div><div class="ttdeci">static void start(std::shared_ptr&lt; TimerThread &gt; timer_thread, Duration duration, Function function)</div><div class="ttdoc">Start a given timer thread.</div><div class="ttdef"><b>Definition:</b> thread_group.h:693</div></div>
<div class="ttc" id="anamespacedmlc_html_a3af1c5a5f5dd3a6741693071f85d67ce"><div class="ttname"><a href="namespacedmlc.html#a3af1c5a5f5dd3a6741693071f85d67ce">dmlc::CreateTimer</a></div><div class="ttdeci">bool CreateTimer(const std::string &amp;timer_name, const Duration &amp;duration, ThreadGroup *owner, TimerFunction timer_function)</div><div class="ttdoc">Utility function to easily create a timer.</div><div class="ttdef"><b>Definition:</b> thread_group.h:797</div></div>
<div class="ttc" id="anamespacedmlc_html_a591cc4d1980f6074fbc450bcf9d40876"><div class="ttname"><a href="namespacedmlc.html#a591cc4d1980f6074fbc450bcf9d40876">dmlc::ReadLock</a></div><div class="ttdeci">std::unique_lock&lt; SharedMutex &gt; ReadLock</div><div class="ttdoc">Standard unique lock for C++ &lt; 14.</div><div class="ttdef"><b>Definition:</b> thread_group.h:88</div></div>
<div class="ttc" id="aclassdmlc_1_1ThreadGroup_1_1Thread_html_af418c16d46e4adc424a84c68a44e0c0b"><div class="ttname"><a href="classdmlc_1_1ThreadGroup_1_1Thread.html#af418c16d46e4adc424a84c68a44e0c0b">dmlc::ThreadGroup::Thread::Thread</a></div><div class="ttdeci">Thread(std::string threadName, ThreadGroup *owner, std::thread *thrd=nullptr)</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> thread_group.h:112</div></div>
<div class="ttc" id="aclassdmlc_1_1ThreadGroup_html_adfa40c047642d4b9969782274e8b8280"><div class="ttname"><a href="classdmlc_1_1ThreadGroup.html#adfa40c047642d4b9969782274e8b8280">dmlc::ThreadGroup::is_this_thread_in</a></div><div class="ttdeci">bool is_this_thread_in() const</div><div class="ttdoc">Check if the current thread a member if this ThreadGroup.</div><div class="ttdef"><b>Definition:</b> thread_group.h:330</div></div>
<div class="ttc" id="anamespacedmlc_html_aad58a9dfecc6e970348c217de29bb916"><div class="ttname"><a href="namespacedmlc.html#aad58a9dfecc6e970348c217de29bb916">dmlc::WriteLock</a></div><div class="ttdeci">std::unique_lock&lt; SharedMutex &gt; WriteLock</div><div class="ttdoc">Standard unique lock for C++ &lt; 14.</div><div class="ttdef"><b>Definition:</b> thread_group.h:86</div></div>
<div class="ttc" id="aclassdmlc_1_1ThreadGroup_html_a2ab75ab28197f8951705f6afe713c31a"><div class="ttname"><a href="classdmlc_1_1ThreadGroup.html#a2ab75ab28197f8951705f6afe713c31a">dmlc::ThreadGroup::add_thread</a></div><div class="ttdeci">bool add_thread(std::shared_ptr&lt; Thread &gt; thrd)</div><div class="ttdoc">Add a Thread object to this thread group.</div><div class="ttdef"><b>Definition:</b> thread_group.h:366</div></div>
<div class="ttc" id="aclassdmlc_1_1BlockingQueueThread_html_a31100f23c0701bf1d9d64d8676eb6bf8"><div class="ttname"><a href="classdmlc_1_1BlockingQueueThread.html#a31100f23c0701bf1d9d64d8676eb6bf8">dmlc::BlockingQueueThread::size_approx</a></div><div class="ttdeci">size_t size_approx() const</div><div class="ttdoc">Get the approximate size of the queue.</div><div class="ttdef"><b>Definition:</b> thread_group.h:585</div></div>
<div class="ttc" id="aclassdmlc_1_1TimerThread_html_a0803f0c18898e6740a841dcd29412b52"><div class="ttname"><a href="classdmlc_1_1TimerThread.html#a0803f0c18898e6740a841dcd29412b52">dmlc::TimerThread::launch_run</a></div><div class="ttdeci">static bool launch_run(std::shared_ptr&lt; TimerThread&lt; Duration &gt;&gt; pThis, SecondaryFunction secondary_function)</div><div class="ttdoc">Launch to the 'run' function which will, in turn, call the class' 'run' function, passing it the give...</div><div class="ttdef"><b>Definition:</b> thread_group.h:674</div></div>
<div class="ttc" id="aclassdmlc_1_1BlockingQueueThread_html_a1265e3383d5cbf06ec24d415de194159"><div class="ttname"><a href="classdmlc_1_1BlockingQueueThread.html#a1265e3383d5cbf06ec24d415de194159">dmlc::BlockingQueueThread::launch_run</a></div><div class="ttdeci">static bool launch_run(std::shared_ptr&lt; BQT &gt; pThis, SecondaryFunction secondary_function)</div><div class="ttdoc">Launch to the 'run' function which will, in turn, call the class' 'run' function, passing it the give...</div><div class="ttdef"><b>Definition:</b> thread_group.h:598</div></div>
<div class="ttc" id="aclassdmlc_1_1ThreadGroup_html_a96121f267e7498ff1ec208b0a19c1a40"><div class="ttname"><a href="classdmlc_1_1ThreadGroup.html#a96121f267e7498ff1ec208b0a19c1a40">dmlc::ThreadGroup::empty</a></div><div class="ttdeci">bool empty() const</div><div class="ttdoc">Check if the ThreadGroup is empty.</div><div class="ttdef"><b>Definition:</b> thread_group.h:465</div></div>
<div class="ttc" id="aclassdmlc_1_1ManualEvent_html_a9f1f6aefdf6df4f3b27845234f598583"><div class="ttname"><a href="classdmlc_1_1ManualEvent.html#a9f1f6aefdf6df4f3b27845234f598583">dmlc::ManualEvent::ManualEvent</a></div><div class="ttdeci">ManualEvent()</div><div class="ttdef"><b>Definition:</b> thread_group.h:36</div></div>
<div class="ttc" id="anamespacestd_html"><div class="ttname"><a href="namespacestd.html">std</a></div><div class="ttdef"><b>Definition:</b> optional.h:251</div></div>
<div class="ttc" id="aclassdmlc_1_1ThreadGroup_1_1Thread_html_abff81204caa69efd85052b6be5af5281"><div class="ttname"><a href="classdmlc_1_1ThreadGroup_1_1Thread.html#abff81204caa69efd85052b6be5af5281">dmlc::ThreadGroup::Thread::joinable</a></div><div class="ttdeci">bool joinable() const</div><div class="ttdoc">Check whether the thread is joinable.</div><div class="ttdef"><b>Definition:</b> thread_group.h:224</div></div>
<div class="ttc" id="aclassdmlc_1_1TimerThread_html_a6240348c133cae9033439bc1cfda0d5d"><div class="ttname"><a href="classdmlc_1_1TimerThread.html#a6240348c133cae9033439bc1cfda0d5d">dmlc::TimerThread::~TimerThread</a></div><div class="ttdeci">~TimerThread() override</div><div class="ttdoc">Destructor.</div><div class="ttdef"><b>Definition:</b> thread_group.h:659</div></div>
<div class="ttc" id="aclassdmlc_1_1TimerThread_html_a54dc803653b7202f0aa4fc65b387eaea"><div class="ttname"><a href="classdmlc_1_1TimerThread.html#a54dc803653b7202f0aa4fc65b387eaea">dmlc::TimerThread::TimerThread</a></div><div class="ttdeci">TimerThread(const std::string &amp;name, ThreadGroup *owner)</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> thread_group.h:652</div></div>
<div class="ttc" id="aclassdmlc_1_1ManualEvent_html_a24af45c7c96d8b9421ed3337c5def886"><div class="ttname"><a href="classdmlc_1_1ManualEvent.html#a24af45c7c96d8b9421ed3337c5def886">dmlc::ManualEvent::wait</a></div><div class="ttdeci">void wait()</div><div class="ttdoc">Wait for the object to become signaled. If the object is already in the signaled state and reset() ha...</div><div class="ttdef"><b>Definition:</b> thread_group.h:42</div></div>
<div class="ttc" id="aclassdmlc_1_1ThreadGroup_1_1Thread_html_a0dee1f2d880507a322c28bf2c29bfaee"><div class="ttname"><a href="classdmlc_1_1ThreadGroup_1_1Thread.html#a0dee1f2d880507a322c28bf2c29bfaee">dmlc::ThreadGroup::Thread::request_shutdown</a></div><div class="ttdeci">virtual void request_shutdown()</div><div class="ttdoc">Signal to this thread that a thread shutdown/exit is requested.</div><div class="ttdef"><b>Definition:</b> thread_group.h:187</div></div>
<div class="ttc" id="aclassdmlc_1_1ThreadGroup_html_a286490cd78a1b60c85051bd9cb3e15d8"><div class="ttname"><a href="classdmlc_1_1ThreadGroup.html#a286490cd78a1b60c85051bd9cb3e15d8">dmlc::ThreadGroup::join_all</a></div><div class="ttdeci">void join_all()</div><div class="ttdoc">Join all threads in this ThreadGroup.</div><div class="ttdef"><b>Definition:</b> thread_group.h:406</div></div>
<div class="ttc" id="aclassdmlc_1_1ThreadGroup_html_a0aeac26faab3e0608181a59a1e6726c6"><div class="ttname"><a href="classdmlc_1_1ThreadGroup.html#a0aeac26faab3e0608181a59a1e6726c6">dmlc::ThreadGroup::ThreadGroup</a></div><div class="ttdeci">ThreadGroup()</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> thread_group.h:310</div></div>
<div class="ttc" id="aclassdmlc_1_1ThreadGroup_html_a988dc9800999fc4648c7ba32c70c6aa0"><div class="ttname"><a href="classdmlc_1_1ThreadGroup.html#a988dc9800999fc4648c7ba32c70c6aa0">dmlc::ThreadGroup::request_shutdown_all</a></div><div class="ttdeci">void request_shutdown_all(const bool make_all_joinable=true)</div><div class="ttdoc">Call request_shutdown() on all threads in this ThreadGroup.</div><div class="ttdef"><b>Definition:</b> thread_group.h:441</div></div>
<div class="ttc" id="aclassdmlc_1_1ThreadGroup_1_1Thread_html_a16c4ff5126f01989d26d0170476c76ff"><div class="ttname"><a href="classdmlc_1_1ThreadGroup_1_1Thread.html#a16c4ff5126f01989d26d0170476c76ff">dmlc::ThreadGroup::Thread::is_auto_remove</a></div><div class="ttdeci">bool is_auto_remove() const</div><div class="ttdoc">Check whether the thread is set to auto-remove itself from the ThreadGroup owner when exiting.</div><div class="ttdef"><b>Definition:</b> thread_group.h:207</div></div>
<div class="ttc" id="aconcurrentqueue_8h_html"><div class="ttname"><a href="concurrentqueue_8h.html">concurrentqueue.h</a></div></div>
<div class="ttc" id="aclassdmlc_1_1ThreadGroup_1_1Thread_html_a9637c66d37e0d39397784e35e8c0921a"><div class="ttname"><a href="classdmlc_1_1ThreadGroup_1_1Thread.html#a9637c66d37e0d39397784e35e8c0921a">dmlc::ThreadGroup::Thread::make_joinable</a></div><div class="ttdeci">void make_joinable()</div><div class="ttdoc">Make the thread joinable (by removing the auto_remove flag)</div><div class="ttdef"><b>Definition:</b> thread_group.h:216</div></div>
<div class="ttc" id="aclassdmlc_1_1ManualEvent_html_aabdf6964cb72222e04fecfd9ffb9875e"><div class="ttname"><a href="classdmlc_1_1ManualEvent.html#aabdf6964cb72222e04fecfd9ffb9875e">dmlc::ManualEvent::signal</a></div><div class="ttdeci">void signal()</div><div class="ttdoc">Set this object's state to signaled (wait() will release or pass through)</div><div class="ttdef"><b>Definition:</b> thread_group.h:52</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 03:47:39 for mxnet 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>