<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Faiss: /data/users/matthijs/github_faiss/faiss/gpu/utils/WorkerThread.cpp 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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">Faiss
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a></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_6b3ae6988449b0834e9596fad5d75199.html">gpu</a></li><li class="navelem"><a class="el" href="dir_498271007b03b2a0521055e88776887b.html">utils</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">WorkerThread.cpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment"></span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright (c) 2015-present, Facebook, Inc.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * All rights reserved.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * This source code is licensed under the CC-by-NC license found in the</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * LICENSE file in the root directory of this source tree.</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// Copyright 2004-present Facebook. All Rights Reserved.</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include "WorkerThread.h"</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "../../FaissAssert.h"</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="keyword">namespace </span>faiss { <span class="keyword">namespace </span>gpu {</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> WorkerThread::WorkerThread() :</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  wantStop_(false) {</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  startThread();</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="comment">// Make sure that the thread has started before continuing</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  add([](){}).<span class="keyword">get</span>();</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> }</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1WorkerThread.html#ac1a9c44f38ea5345a650da04b032d41b"> 25</a></span> <a class="code" href="classfaiss_1_1gpu_1_1WorkerThread.html#ac1a9c44f38ea5345a650da04b032d41b">WorkerThread::~WorkerThread</a>() {</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <a class="code" href="classfaiss_1_1gpu_1_1WorkerThread.html#a68963d8c18822d7736c96e82367f2f12">stop</a>();</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <a class="code" href="classfaiss_1_1gpu_1_1WorkerThread.html#aa7fd80a803f543a2027ea74e81db677a">waitForThreadExit</a>();</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> }</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keywordtype">void</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> WorkerThread::startThread() {</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  thread_ = std::thread([<span class="keyword">this</span>](){ threadMain(); });</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> }</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keywordtype">void</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1WorkerThread.html#a68963d8c18822d7736c96e82367f2f12"> 36</a></span> <a class="code" href="classfaiss_1_1gpu_1_1WorkerThread.html#a68963d8c18822d7736c96e82367f2f12">WorkerThread::stop</a>() {</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  std::lock_guard<std::mutex> guard(mutex_);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  wantStop_ = <span class="keyword">true</span>;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  monitor_.notify_one();</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> }</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> std::future<bool></div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1WorkerThread.html#aeddb3e9911373019dbd04b7e8a9762cf"> 44</a></span> <a class="code" href="classfaiss_1_1gpu_1_1WorkerThread.html#aeddb3e9911373019dbd04b7e8a9762cf">WorkerThread::add</a>(std::function<<span class="keywordtype">void</span>()> f) {</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  std::lock_guard<std::mutex> guard(mutex_);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordflow">if</span> (wantStop_) {</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="comment">// The timer thread has been stopped, or we want to stop; we can't</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="comment">// schedule anything else</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  std::promise<bool> p;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">auto</span> fut = p.get_future();</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="comment">// did not execute</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  p.set_value(<span class="keyword">false</span>);</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordflow">return</span> fut;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  }</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">auto</span> pr = std::promise<bool>();</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">auto</span> fut = pr.get_future();</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  queue_.emplace_back(std::make_pair(std::move(f), std::move(pr)));</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="comment">// Wake up our thread</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  monitor_.notify_one();</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordflow">return</span> fut;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> }</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="keywordtype">void</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> WorkerThread::threadMain() {</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  threadLoop();</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="comment">// Call all pending tasks</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  FAISS_ASSERT(wantStop_);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span>& f : queue_) {</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  f.first();</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  f.second.set_value(<span class="keyword">true</span>);</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  }</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> }</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="keywordtype">void</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> WorkerThread::threadLoop() {</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordflow">while</span> (<span class="keyword">true</span>) {</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  std::pair<std::function<void()>, std::promise<bool>> data;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  {</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  std::unique_lock<std::mutex> lock(mutex_);</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordflow">while</span> (!wantStop_ && queue_.empty()) {</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  monitor_.wait(lock);</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  }</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordflow">if</span> (wantStop_) {</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  }</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  data = std::move(queue_.front());</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  queue_.pop_front();</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  }</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  data.first();</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  data.second.set_value(<span class="keyword">true</span>);</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  }</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> }</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="keywordtype">void</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1WorkerThread.html#aa7fd80a803f543a2027ea74e81db677a"> 107</a></span> <a class="code" href="classfaiss_1_1gpu_1_1WorkerThread.html#aa7fd80a803f543a2027ea74e81db677a">WorkerThread::waitForThreadExit</a>() {</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  thread_.join();</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  } <span class="keywordflow">catch</span> (...) {</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  }</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> }</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> } } <span class="comment">// namespace</span></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1WorkerThread_html_a68963d8c18822d7736c96e82367f2f12"><div class="ttname"><a href="classfaiss_1_1gpu_1_1WorkerThread.html#a68963d8c18822d7736c96e82367f2f12">faiss::gpu::WorkerThread::stop</a></div><div class="ttdeci">void stop()</div><div class="ttdoc">Request that the worker thread stop itself. </div><div class="ttdef"><b>Definition:</b> <a href="WorkerThread_8cpp_source.html#l00036">WorkerThread.cpp:36</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1WorkerThread_html_aeddb3e9911373019dbd04b7e8a9762cf"><div class="ttname"><a href="classfaiss_1_1gpu_1_1WorkerThread.html#aeddb3e9911373019dbd04b7e8a9762cf">faiss::gpu::WorkerThread::add</a></div><div class="ttdeci">std::future< bool > add(std::function< void()> f)</div><div class="ttdef"><b>Definition:</b> <a href="WorkerThread_8cpp_source.html#l00044">WorkerThread.cpp:44</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1WorkerThread_html_aa7fd80a803f543a2027ea74e81db677a"><div class="ttname"><a href="classfaiss_1_1gpu_1_1WorkerThread.html#aa7fd80a803f543a2027ea74e81db677a">faiss::gpu::WorkerThread::waitForThreadExit</a></div><div class="ttdeci">void waitForThreadExit()</div><div class="ttdef"><b>Definition:</b> <a href="WorkerThread_8cpp_source.html#l00107">WorkerThread.cpp:107</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1WorkerThread_html_ac1a9c44f38ea5345a650da04b032d41b"><div class="ttname"><a href="classfaiss_1_1gpu_1_1WorkerThread.html#ac1a9c44f38ea5345a650da04b032d41b">faiss::gpu::WorkerThread::~WorkerThread</a></div><div class="ttdeci">~WorkerThread()</div><div class="ttdef"><b>Definition:</b> <a href="WorkerThread_8cpp_source.html#l00025">WorkerThread.cpp:25</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>