1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
<!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/DeviceUtils.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/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">DeviceUtils.h</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"> * Copyright (c) 2015-present, Facebook, Inc.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * All rights reserved.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This source code is licensed under the BSD+Patents license found in the</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * LICENSE file in the root directory of this source tree.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// Copyright 2004-present Facebook. All Rights Reserved.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor"></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> <span class="preprocessor">#include <cuda_runtime.h></span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <cublas_v2.h></span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <vector></span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">namespace </span>faiss { <span class="keyword">namespace </span>gpu {</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"></span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">/// Returns the current thread-local GPU device</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"></span><span class="keywordtype">int</span> getCurrentDevice();</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"></span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">/// Sets the current thread-local GPU device</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span><span class="keywordtype">void</span> setCurrentDevice(<span class="keywordtype">int</span> device);</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"></span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">/// Returns the number of available GPU devices</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"></span><span class="keywordtype">int</span> getNumDevices();</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"></span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">/// Synchronizes the CPU against all devices (equivalent to</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">/// cudaDeviceSynchronize for each device)</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"></span><span class="keywordtype">void</span> synchronizeAllDevices();</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"></span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">/// Returns a cached cudaDeviceProp for the given device</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"></span><span class="keyword">const</span> cudaDeviceProp& getDeviceProperties(<span class="keywordtype">int</span> device);</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"></span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">/// Returns the cached cudaDeviceProp for the current device</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"></span><span class="keyword">const</span> cudaDeviceProp& getCurrentDeviceProperties();</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"></span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">/// Returns the maximum number of threads available for the given GPU</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">/// device</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"></span><span class="keywordtype">int</span> getMaxThreads(<span class="keywordtype">int</span> device);</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"></span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">/// Equivalent to getMaxThreads(getCurrentDevice())</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"></span><span class="keywordtype">int</span> getMaxThreadsCurrentDevice();</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"></span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">/// Returns the maximum smem available for the given GPU device</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"></span><span class="keywordtype">size_t</span> getMaxSharedMemPerBlock(<span class="keywordtype">int</span> device);</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"></span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment">/// Equivalent to getMaxSharedMemPerBlock(getCurrentDevice())</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"></span><span class="keywordtype">size_t</span> getMaxSharedMemPerBlockCurrentDevice();</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"></span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">/// For a given pointer, returns whether or not it is located on</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">/// a device (deviceId >= 0) or the host (-1).</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"></span><span class="keywordtype">int</span> getDeviceForAddress(<span class="keyword">const</span> <span class="keywordtype">void</span>* p);</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"></span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment">/// Does the given device support full unified memory sharing host</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment">/// memory?</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"></span><span class="keywordtype">bool</span> getFullUnifiedMemSupport(<span class="keywordtype">int</span> device);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"></span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">/// Equivalent to getFullUnifiedMemSupport(getCurrentDevice())</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"></span><span class="keywordtype">bool</span> getFullUnifiedMemSupportCurrentDevice();</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"></span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment">/// RAII object to set the current device, and restore the previous</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment">/// device upon destruction</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1DeviceScope.html"> 65</a></span> <span class="comment"></span><span class="keyword">class </span><a class="code" href="classfaiss_1_1gpu_1_1DeviceScope.html">DeviceScope</a> {</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">explicit</span> <a class="code" href="classfaiss_1_1gpu_1_1DeviceScope.html">DeviceScope</a>(<span class="keywordtype">int</span> device);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  ~<a class="code" href="classfaiss_1_1gpu_1_1DeviceScope.html">DeviceScope</a>();</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">private</span>:</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordtype">int</span> prevDevice_;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> };</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"></span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment">/// RAII object to manage a cublasHandle_t</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1CublasHandleScope.html"> 75</a></span> <span class="comment"></span><span class="keyword">class </span><a class="code" href="classfaiss_1_1gpu_1_1CublasHandleScope.html">CublasHandleScope</a> {</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <a class="code" href="classfaiss_1_1gpu_1_1CublasHandleScope.html">CublasHandleScope</a>();</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  ~<a class="code" href="classfaiss_1_1gpu_1_1CublasHandleScope.html">CublasHandleScope</a>();</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>  cublasHandle_t <span class="keyword">get</span>() { <span class="keywordflow">return</span> blasHandle_; }</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keyword">private</span>:</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  cublasHandle_t blasHandle_;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> };</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> <span class="comment">// RAII object to manage a cudaEvent_t</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1CudaEvent.html"> 87</a></span> <span class="keyword">class </span><a class="code" href="classfaiss_1_1gpu_1_1CudaEvent.html">CudaEvent</a> {</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">public</span>:<span class="comment"></span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> /// Creates an event and records it in this stream</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"></span> <span class="keyword">explicit</span> <a class="code" href="classfaiss_1_1gpu_1_1CudaEvent.html#af7f5fa36dbff9e6126c1b01218f147e1">CudaEvent</a>(cudaStream_t stream);</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <a class="code" href="classfaiss_1_1gpu_1_1CudaEvent.html#af7f5fa36dbff9e6126c1b01218f147e1">CudaEvent</a>(<span class="keyword">const</span> <a class="code" href="classfaiss_1_1gpu_1_1CudaEvent.html">CudaEvent</a>& event) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <a class="code" href="classfaiss_1_1gpu_1_1CudaEvent.html#af7f5fa36dbff9e6126c1b01218f147e1">CudaEvent</a>(<a class="code" href="classfaiss_1_1gpu_1_1CudaEvent.html">CudaEvent</a>&& event) noexcept;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  ~<a class="code" href="classfaiss_1_1gpu_1_1CudaEvent.html">CudaEvent</a>();</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keyword">inline</span> cudaEvent_t <span class="keyword">get</span>() { <span class="keywordflow">return</span> event_; }</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"></span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> /// Wait on this event in this stream</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1gpu_1_1CudaEvent.html#ad8968b298b95788c7679d7e5aa0571eb">streamWaitOnEvent</a>(cudaStream_t stream);</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"></span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> /// Have the CPU wait for the completion of this event</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1gpu_1_1CudaEvent.html#a9c85540093aaf87de80ece9f854e7c57">cpuWaitOnEvent</a>();</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <a class="code" href="classfaiss_1_1gpu_1_1CudaEvent.html">CudaEvent</a>& operator=(<a class="code" href="classfaiss_1_1gpu_1_1CudaEvent.html">CudaEvent</a>&& event) noexcept;</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <a class="code" href="classfaiss_1_1gpu_1_1CudaEvent.html">CudaEvent</a>& operator=(<a class="code" href="classfaiss_1_1gpu_1_1CudaEvent.html">CudaEvent</a>& event) = <span class="keyword">delete</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="keyword">private</span>:</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  cudaEvent_t event_;</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> };</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"></span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment">/// Wrapper to test return status of CUDA functions</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"></span><span class="preprocessor">#define CUDA_VERIFY(X) \</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="preprocessor"> do { \</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="preprocessor"> auto err__ = (X); \</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="preprocessor"> FAISS_ASSERT_FMT(err__ == cudaSuccess, "CUDA error %d", (int) err__); \</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="preprocessor"> } while (0)</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="preprocessor"></span><span class="comment"></span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment">/// Wrapper to synchronously probe for CUDA errors</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"></span><span class="comment">// #define FAISS_GPU_SYNC_ERROR 1</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="preprocessor">#ifdef FAISS_GPU_SYNC_ERROR</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="preprocessor"></span><span class="preprocessor">#define CUDA_TEST_ERROR() \</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="preprocessor"> do { \</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="preprocessor"> CUDA_VERIFY(cudaDeviceSynchronize()); \</span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="preprocessor"> } while (0)</span></div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="preprocessor"></span><span class="preprocessor">#else</span></div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="preprocessor"></span><span class="preprocessor">#define CUDA_TEST_ERROR() \</span></div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="preprocessor"> do { \</span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="preprocessor"> CUDA_VERIFY(cudaGetLastError()); \</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="preprocessor"> } while (0)</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="preprocessor"></span><span class="comment"></span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment">/// Call for a collection of streams to wait on</span></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">typename</span> L1, <span class="keyword">typename</span> L2></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="keywordtype">void</span> streamWaitBase(<span class="keyword">const</span> L1& listWaiting, <span class="keyword">const</span> L2& listWaitOn) {</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="comment">// For all the streams we are waiting on, create an event</span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  std::vector<cudaEvent_t> events;</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span>& stream : listWaitOn) {</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  cudaEvent_t event;</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  CUDA_VERIFY(cudaEventCreateWithFlags(&event, cudaEventDisableTiming));</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  CUDA_VERIFY(cudaEventRecord(event, stream));</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  events.push_back(event);</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  }</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="comment">// For all the streams that are waiting, issue a wait</span></div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span>& stream : listWaiting) {</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span>& event : events) {</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  CUDA_VERIFY(cudaStreamWaitEvent(stream, event, 0));</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  }</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  }</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span>& event : events) {</div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  CUDA_VERIFY(cudaEventDestroy(event));</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  }</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> }</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"></span></div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment">/// These versions allow usage of initializer_list as arguments, since</span></div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment">/// otherwise {...} doesn't have a type</span></div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">typename</span> L1></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="keywordtype">void</span> streamWait(<span class="keyword">const</span> L1& a,</div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="keyword">const</span> std::initializer_list<cudaStream_t>& b) {</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  streamWaitBase(a, b);</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> }</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> </div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="keyword">template</span> <<span class="keyword">typename</span> L2></div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="keywordtype">void</span> streamWait(<span class="keyword">const</span> std::initializer_list<cudaStream_t>& a,</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="keyword">const</span> L2& b) {</div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  streamWaitBase(a, b);</div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> }</div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> </div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> streamWait(<span class="keyword">const</span> std::initializer_list<cudaStream_t>& a,</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  <span class="keyword">const</span> std::initializer_list<cudaStream_t>& b) {</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  streamWaitBase(a, b);</div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> }</div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> </div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> } } <span class="comment">// namespace</span></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1CudaEvent_html_a9c85540093aaf87de80ece9f854e7c57"><div class="ttname"><a href="classfaiss_1_1gpu_1_1CudaEvent.html#a9c85540093aaf87de80ece9f854e7c57">faiss::gpu::CudaEvent::cpuWaitOnEvent</a></div><div class="ttdeci">void cpuWaitOnEvent()</div><div class="ttdoc">Have the CPU wait for the completion of this event. </div><div class="ttdef"><b>Definition:</b> <a href="DeviceUtils_8cpp_source.html#l00172">DeviceUtils.cpp:172</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1CudaEvent_html_ad8968b298b95788c7679d7e5aa0571eb"><div class="ttname"><a href="classfaiss_1_1gpu_1_1CudaEvent.html#ad8968b298b95788c7679d7e5aa0571eb">faiss::gpu::CudaEvent::streamWaitOnEvent</a></div><div class="ttdeci">void streamWaitOnEvent(cudaStream_t stream)</div><div class="ttdoc">Wait on this event in this stream. </div><div class="ttdef"><b>Definition:</b> <a href="DeviceUtils_8cpp_source.html#l00167">DeviceUtils.cpp:167</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1CudaEvent_html_af7f5fa36dbff9e6126c1b01218f147e1"><div class="ttname"><a href="classfaiss_1_1gpu_1_1CudaEvent.html#af7f5fa36dbff9e6126c1b01218f147e1">faiss::gpu::CudaEvent::CudaEvent</a></div><div class="ttdeci">CudaEvent(cudaStream_t stream)</div><div class="ttdoc">Creates an event and records it in this stream. </div><div class="ttdef"><b>Definition:</b> <a href="DeviceUtils_8cpp_source.html#l00141">DeviceUtils.cpp:141</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1DeviceScope_html"><div class="ttname"><a href="classfaiss_1_1gpu_1_1DeviceScope.html">faiss::gpu::DeviceScope</a></div><div class="ttdef"><b>Definition:</b> <a href="DeviceUtils_8h_source.html#l00065">DeviceUtils.h:65</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1CublasHandleScope_html"><div class="ttname"><a href="classfaiss_1_1gpu_1_1CublasHandleScope.html">faiss::gpu::CublasHandleScope</a></div><div class="ttdoc">RAII object to manage a cublasHandle_t. </div><div class="ttdef"><b>Definition:</b> <a href="DeviceUtils_8h_source.html#l00075">DeviceUtils.h:75</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1CudaEvent_html"><div class="ttname"><a href="classfaiss_1_1gpu_1_1CudaEvent.html">faiss::gpu::CudaEvent</a></div><div class="ttdef"><b>Definition:</b> <a href="DeviceUtils_8h_source.html#l00087">DeviceUtils.h:87</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>