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
<!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/StackDeviceMemory.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">StackDeviceMemory.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 "DeviceMemory.h"</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <list></span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <memory></span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <unordered_map></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">/// Device memory manager that provides temporary memory allocations</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">/// out of a region of memory</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1StackDeviceMemory.html"> 22</a></span> <span class="comment"></span><span class="keyword">class </span><a class="code" href="classfaiss_1_1gpu_1_1StackDeviceMemory.html">StackDeviceMemory</a> : <span class="keyword">public</span> <a class="code" href="classfaiss_1_1gpu_1_1DeviceMemory.html">DeviceMemory</a> {</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="keyword">public</span>:<span class="comment"></span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> /// Allocate a new region of memory that we manage</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"></span> <span class="keyword">explicit</span> <a class="code" href="classfaiss_1_1gpu_1_1StackDeviceMemory.html#a130f900c32ba91ae1f872c7ee506a93e">StackDeviceMemory</a>(<span class="keywordtype">int</span> device, <span class="keywordtype">size_t</span> allocPerDevice);</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"></span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> /// Manage a region of memory for a particular device, with or</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> /// without ownership</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"></span> <a class="code" href="classfaiss_1_1gpu_1_1StackDeviceMemory.html#a130f900c32ba91ae1f872c7ee506a93e">StackDeviceMemory</a>(<span class="keywordtype">int</span> device, <span class="keywordtype">void</span>* p, <span class="keywordtype">size_t</span> size, <span class="keywordtype">bool</span> isOwner);</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  ~<a class="code" href="classfaiss_1_1gpu_1_1StackDeviceMemory.html">StackDeviceMemory</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordtype">int</span> <a class="code" href="classfaiss_1_1gpu_1_1StackDeviceMemory.html#ab9dac6d8953630121f60fb804599f648">getDevice</a>() <span class="keyword">const override</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>  <a class="code" href="classfaiss_1_1gpu_1_1DeviceMemoryReservation.html">DeviceMemoryReservation</a> <a class="code" href="classfaiss_1_1gpu_1_1StackDeviceMemory.html#a9d9a5dcdb2d016cf00d14b8831db638b">getMemory</a>(cudaStream_t stream,</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordtype">size_t</span> size) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">size_t</span> <a class="code" href="classfaiss_1_1gpu_1_1StackDeviceMemory.html#a66e82485ab7a89be137f85a82ea94fd0">getSizeAvailable</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  std::string <a class="code" href="classfaiss_1_1gpu_1_1StackDeviceMemory.html#ae4fab99808556307b17241c45503a4b0">toString</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordtype">size_t</span> <a class="code" href="classfaiss_1_1gpu_1_1StackDeviceMemory.html#ad1659533968bccdb288b1682e7feb234">getHighWaterCudaMalloc</a>() <span class="keyword">const override</span>;</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>  <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordtype">void</span> returnAllocation(<a class="code" href="classfaiss_1_1gpu_1_1DeviceMemoryReservation.html">DeviceMemoryReservation</a>& m) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">protected</span>:<span class="comment"></span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> /// Previous allocation ranges and the streams for which</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> /// synchronization is required</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Range.html"> 48</a></span> <span class="comment"></span> <span class="keyword">struct </span><a class="code" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Range.html">Range</a> {</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">inline</span> <a class="code" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Range.html">Range</a>(<span class="keywordtype">char</span>* s, <span class="keywordtype">char</span>* e, cudaStream_t str) :</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  start_(s), end_(e), stream_(str) {</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  }</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">// References a memory range [start, end)</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">char</span>* start_;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">char</span>* end_;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  cudaStream_t stream_;</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> </div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html"> 59</a></span>  <span class="keyword">struct </span><a class="code" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html">Stack</a> {<span class="comment"></span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> /// Constructor that allocates memory via cudaMalloc</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"></span> <a class="code" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a783de9fc71cf57bf336c474f6155453d">Stack</a>(<span class="keywordtype">int</span> device, <span class="keywordtype">size_t</span> size);</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"> /// Constructor that references a pre-allocated region of memory</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"></span> <a class="code" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a783de9fc71cf57bf336c474f6155453d">Stack</a>(<span class="keywordtype">int</span> device, <span class="keywordtype">void</span>* p, <span class="keywordtype">size_t</span> size, <span class="keywordtype">bool</span> isOwner);</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  ~<a class="code" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html">Stack</a>();</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"></span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> /// Returns how much size is available for an allocation without</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> /// calling cudaMalloc</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"></span> <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#ac9fe1174255fedfee546bb5e37c12834">getSizeAvailable</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"></span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> /// Obtains an allocation; all allocations are guaranteed to be 16</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> /// byte aligned</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"></span> <span class="keywordtype">char</span>* <a class="code" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#ab45d128f288728df5baf03defd50cec7">getAlloc</a>(<span class="keywordtype">size_t</span> size, cudaStream_t stream);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"></span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> /// Returns an allocation</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a5c652c126c2bf37149995cdb9d46a382">returnAlloc</a>(<span class="keywordtype">char</span>* p, <span class="keywordtype">size_t</span> size, cudaStream_t stream);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"></span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> /// Returns the stack state</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"></span> std::string <a class="code" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a1c91f4d50ecb8bb659054227d32fb47b">toString</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"></span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> /// Returns the high-water mark of cudaMalloc activity</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"></span> <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a88e877d2b63d6e3d828a37462e780004">getHighWaterCudaMalloc</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"></span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> /// Device this allocation is on</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a0950e30ddd0008367a0fb109db9c01b9"> 85</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a0950e30ddd0008367a0fb109db9c01b9">device_</a>;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"></span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> /// Do we own our region of memory?</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a949014db795e0def2c257aa775993230"> 88</a></span> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a949014db795e0def2c257aa775993230">isOwner_</a>;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"></span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> /// Where our allocation begins and ends</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> /// [start_, end_) is valid</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#aed64654e7d498114fdd48a6f1cdb1aa2"> 92</a></span> <span class="comment"></span> <span class="keywordtype">char</span>* <a class="code" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#aed64654e7d498114fdd48a6f1cdb1aa2">start_</a>;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordtype">char</span>* end_;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"></span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> /// Total size end_ - start_</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a3df7ba513acd46aa69180585cb4e7aac"> 96</a></span> <span class="comment"></span> <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a3df7ba513acd46aa69180585cb4e7aac">size_</a>;</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"></span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> /// Stack head within [start, end)</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"><a class="line" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a140d3dc4577883704708ecca493813ff"> 99</a></span> <span class="comment"></span> <span class="keywordtype">char</span>* <a class="code" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a140d3dc4577883704708ecca493813ff">head_</a>;</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"></span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> /// List of previous last users of allocations on our stack, for</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> /// possible synchronization purposes</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a9fc42fbbe671faee41ea85a68bdb6b1e"> 103</a></span> <span class="comment"></span> std::list<Range> <a class="code" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a9fc42fbbe671faee41ea85a68bdb6b1e">lastUsers_</a>;</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"></span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> /// How much cudaMalloc memory is currently outstanding?</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a8cd6e71bd4d147dcc5a9db951bcbb075"> 106</a></span> <span class="comment"></span> <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a8cd6e71bd4d147dcc5a9db951bcbb075">mallocCurrent_</a>;</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"></span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> /// What's the high water mark in terms of memory used from the</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> /// temporary buffer?</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"><a class="line" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#aa05c1f4a5280fe723c9888937182df75"> 110</a></span> <span class="comment"></span> <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#aa05c1f4a5280fe723c9888937182df75">highWaterMemoryUsed_</a>;</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"></span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> /// What's the high water mark in terms of memory allocated via</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> /// cudaMalloc?</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"><a class="line" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a6536a4542048be713b5669ef8bcc5ff6"> 114</a></span> <span class="comment"></span> <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a6536a4542048be713b5669ef8bcc5ff6">highWaterMalloc_</a>;</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  };</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"></span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> /// Our device</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1StackDeviceMemory.html#ac54f49a3be6b7fe4f1fc70094075d875"> 118</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="classfaiss_1_1gpu_1_1StackDeviceMemory.html#ac54f49a3be6b7fe4f1fc70094075d875">device_</a>;</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"></span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> /// Memory stack</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1StackDeviceMemory.html#a323a632f397eaf3df3034595762c6a29"> 121</a></span> <span class="comment"></span> <a class="code" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html">Stack</a> <a class="code" href="classfaiss_1_1gpu_1_1StackDeviceMemory.html#a323a632f397eaf3df3034595762c6a29">stack_</a>;</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> };</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> } } <span class="comment">// namespace</span></div>
<div class="ttc" id="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack_html_a949014db795e0def2c257aa775993230"><div class="ttname"><a href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a949014db795e0def2c257aa775993230">faiss::gpu::StackDeviceMemory::Stack::isOwner_</a></div><div class="ttdeci">bool isOwner_</div><div class="ttdoc">Do we own our region of memory? </div><div class="ttdef"><b>Definition:</b> <a href="StackDeviceMemory_8h_source.html#l00088">StackDeviceMemory.h:88</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1StackDeviceMemory_html_a9d9a5dcdb2d016cf00d14b8831db638b"><div class="ttname"><a href="classfaiss_1_1gpu_1_1StackDeviceMemory.html#a9d9a5dcdb2d016cf00d14b8831db638b">faiss::gpu::StackDeviceMemory::getMemory</a></div><div class="ttdeci">DeviceMemoryReservation getMemory(cudaStream_t stream, size_t size) override</div><div class="ttdef"><b>Definition:</b> <a href="StackDeviceMemory_8cpp_source.html#l00200">StackDeviceMemory.cpp:200</a></div></div>
<div class="ttc" id="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack_html_a88e877d2b63d6e3d828a37462e780004"><div class="ttname"><a href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a88e877d2b63d6e3d828a37462e780004">faiss::gpu::StackDeviceMemory::Stack::getHighWaterCudaMalloc</a></div><div class="ttdeci">size_t getHighWaterCudaMalloc() const </div><div class="ttdoc">Returns the high-water mark of cudaMalloc activity. </div><div class="ttdef"><b>Definition:</b> <a href="StackDeviceMemory_8cpp_source.html#l00176">StackDeviceMemory.cpp:176</a></div></div>
<div class="ttc" id="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack_html_a3df7ba513acd46aa69180585cb4e7aac"><div class="ttname"><a href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a3df7ba513acd46aa69180585cb4e7aac">faiss::gpu::StackDeviceMemory::Stack::size_</a></div><div class="ttdeci">size_t size_</div><div class="ttdoc">Total size end_ - start_. </div><div class="ttdef"><b>Definition:</b> <a href="StackDeviceMemory_8h_source.html#l00096">StackDeviceMemory.h:96</a></div></div>
<div class="ttc" id="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack_html_a9fc42fbbe671faee41ea85a68bdb6b1e"><div class="ttname"><a href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a9fc42fbbe671faee41ea85a68bdb6b1e">faiss::gpu::StackDeviceMemory::Stack::lastUsers_</a></div><div class="ttdeci">std::list< Range > lastUsers_</div><div class="ttdef"><b>Definition:</b> <a href="StackDeviceMemory_8h_source.html#l00103">StackDeviceMemory.h:103</a></div></div>
<div class="ttc" id="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack_html_a783de9fc71cf57bf336c474f6155453d"><div class="ttname"><a href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a783de9fc71cf57bf336c474f6155453d">faiss::gpu::StackDeviceMemory::Stack::Stack</a></div><div class="ttdeci">Stack(int device, size_t size)</div><div class="ttdoc">Constructor that allocates memory via cudaMalloc. </div><div class="ttdef"><b>Definition:</b> <a href="StackDeviceMemory_8cpp_source.html#l00020">StackDeviceMemory.cpp:20</a></div></div>
<div class="ttc" id="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack_html_a8cd6e71bd4d147dcc5a9db951bcbb075"><div class="ttname"><a href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a8cd6e71bd4d147dcc5a9db951bcbb075">faiss::gpu::StackDeviceMemory::Stack::mallocCurrent_</a></div><div class="ttdeci">size_t mallocCurrent_</div><div class="ttdoc">How much cudaMalloc memory is currently outstanding? </div><div class="ttdef"><b>Definition:</b> <a href="StackDeviceMemory_8h_source.html#l00106">StackDeviceMemory.h:106</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1StackDeviceMemory_html_a323a632f397eaf3df3034595762c6a29"><div class="ttname"><a href="classfaiss_1_1gpu_1_1StackDeviceMemory.html#a323a632f397eaf3df3034595762c6a29">faiss::gpu::StackDeviceMemory::stack_</a></div><div class="ttdeci">Stack stack_</div><div class="ttdoc">Memory stack. </div><div class="ttdef"><b>Definition:</b> <a href="StackDeviceMemory_8h_source.html#l00121">StackDeviceMemory.h:121</a></div></div>
<div class="ttc" id="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack_html_a5c652c126c2bf37149995cdb9d46a382"><div class="ttname"><a href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a5c652c126c2bf37149995cdb9d46a382">faiss::gpu::StackDeviceMemory::Stack::returnAlloc</a></div><div class="ttdeci">void returnAlloc(char *p, size_t size, cudaStream_t stream)</div><div class="ttdoc">Returns an allocation. </div><div class="ttdef"><b>Definition:</b> <a href="StackDeviceMemory_8cpp_source.html#l00130">StackDeviceMemory.cpp:130</a></div></div>
<div class="ttc" id="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack_html_a140d3dc4577883704708ecca493813ff"><div class="ttname"><a href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a140d3dc4577883704708ecca493813ff">faiss::gpu::StackDeviceMemory::Stack::head_</a></div><div class="ttdeci">char * head_</div><div class="ttdoc">Stack head within [start, end) </div><div class="ttdef"><b>Definition:</b> <a href="StackDeviceMemory_8h_source.html#l00099">StackDeviceMemory.h:99</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1StackDeviceMemory_html_a66e82485ab7a89be137f85a82ea94fd0"><div class="ttname"><a href="classfaiss_1_1gpu_1_1StackDeviceMemory.html#a66e82485ab7a89be137f85a82ea94fd0">faiss::gpu::StackDeviceMemory::getSizeAvailable</a></div><div class="ttdeci">size_t getSizeAvailable() const override</div><div class="ttdoc">Returns the current size available without calling cudaMalloc. </div><div class="ttdef"><b>Definition:</b> <a href="StackDeviceMemory_8cpp_source.html#l00213">StackDeviceMemory.cpp:213</a></div></div>
<div class="ttc" id="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack_html"><div class="ttname"><a href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html">faiss::gpu::StackDeviceMemory::Stack</a></div><div class="ttdef"><b>Definition:</b> <a href="StackDeviceMemory_8h_source.html#l00059">StackDeviceMemory.h:59</a></div></div>
<div class="ttc" id="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack_html_ac9fe1174255fedfee546bb5e37c12834"><div class="ttname"><a href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#ac9fe1174255fedfee546bb5e37c12834">faiss::gpu::StackDeviceMemory::Stack::getSizeAvailable</a></div><div class="ttdeci">size_t getSizeAvailable() const </div><div class="ttdef"><b>Definition:</b> <a href="StackDeviceMemory_8cpp_source.html#l00058">StackDeviceMemory.cpp:58</a></div></div>
<div class="ttc" id="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack_html_aa05c1f4a5280fe723c9888937182df75"><div class="ttname"><a href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#aa05c1f4a5280fe723c9888937182df75">faiss::gpu::StackDeviceMemory::Stack::highWaterMemoryUsed_</a></div><div class="ttdeci">size_t highWaterMemoryUsed_</div><div class="ttdef"><b>Definition:</b> <a href="StackDeviceMemory_8h_source.html#l00110">StackDeviceMemory.h:110</a></div></div>
<div class="ttc" id="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack_html_a0950e30ddd0008367a0fb109db9c01b9"><div class="ttname"><a href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a0950e30ddd0008367a0fb109db9c01b9">faiss::gpu::StackDeviceMemory::Stack::device_</a></div><div class="ttdeci">int device_</div><div class="ttdoc">Device this allocation is on. </div><div class="ttdef"><b>Definition:</b> <a href="StackDeviceMemory_8h_source.html#l00085">StackDeviceMemory.h:85</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1StackDeviceMemory_html"><div class="ttname"><a href="classfaiss_1_1gpu_1_1StackDeviceMemory.html">faiss::gpu::StackDeviceMemory</a></div><div class="ttdef"><b>Definition:</b> <a href="StackDeviceMemory_8h_source.html#l00022">StackDeviceMemory.h:22</a></div></div>
<div class="ttc" id="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack_html_a6536a4542048be713b5669ef8bcc5ff6"><div class="ttname"><a href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a6536a4542048be713b5669ef8bcc5ff6">faiss::gpu::StackDeviceMemory::Stack::highWaterMalloc_</a></div><div class="ttdeci">size_t highWaterMalloc_</div><div class="ttdef"><b>Definition:</b> <a href="StackDeviceMemory_8h_source.html#l00114">StackDeviceMemory.h:114</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1StackDeviceMemory_html_ae4fab99808556307b17241c45503a4b0"><div class="ttname"><a href="classfaiss_1_1gpu_1_1StackDeviceMemory.html#ae4fab99808556307b17241c45503a4b0">faiss::gpu::StackDeviceMemory::toString</a></div><div class="ttdeci">std::string toString() const override</div><div class="ttdoc">Returns a string containing our current memory manager state. </div><div class="ttdef"><b>Definition:</b> <a href="StackDeviceMemory_8cpp_source.html#l00218">StackDeviceMemory.cpp:218</a></div></div>
<div class="ttc" id="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Range_html"><div class="ttname"><a href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Range.html">faiss::gpu::StackDeviceMemory::Range</a></div><div class="ttdef"><b>Definition:</b> <a href="StackDeviceMemory_8h_source.html#l00048">StackDeviceMemory.h:48</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1DeviceMemory_html"><div class="ttname"><a href="classfaiss_1_1gpu_1_1DeviceMemory.html">faiss::gpu::DeviceMemory</a></div><div class="ttdoc">Manages temporary memory allocations on a GPU device. </div><div class="ttdef"><b>Definition:</b> <a href="DeviceMemory_8h_source.html#l00046">DeviceMemory.h:46</a></div></div>
<div class="ttc" id="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack_html_a1c91f4d50ecb8bb659054227d32fb47b"><div class="ttname"><a href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a1c91f4d50ecb8bb659054227d32fb47b">faiss::gpu::StackDeviceMemory::Stack::toString</a></div><div class="ttdeci">std::string toString() const </div><div class="ttdoc">Returns the stack state. </div><div class="ttdef"><b>Definition:</b> <a href="StackDeviceMemory_8cpp_source.html#l00155">StackDeviceMemory.cpp:155</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1StackDeviceMemory_html_ad1659533968bccdb288b1682e7feb234"><div class="ttname"><a href="classfaiss_1_1gpu_1_1StackDeviceMemory.html#ad1659533968bccdb288b1682e7feb234">faiss::gpu::StackDeviceMemory::getHighWaterCudaMalloc</a></div><div class="ttdeci">size_t getHighWaterCudaMalloc() const override</div><div class="ttdef"><b>Definition:</b> <a href="StackDeviceMemory_8cpp_source.html#l00223">StackDeviceMemory.cpp:223</a></div></div>
<div class="ttc" id="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack_html_ab45d128f288728df5baf03defd50cec7"><div class="ttname"><a href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#ab45d128f288728df5baf03defd50cec7">faiss::gpu::StackDeviceMemory::Stack::getAlloc</a></div><div class="ttdeci">char * getAlloc(size_t size, cudaStream_t stream)</div><div class="ttdef"><b>Definition:</b> <a href="StackDeviceMemory_8cpp_source.html#l00063">StackDeviceMemory.cpp:63</a></div></div>
<div class="ttc" id="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack_html_aed64654e7d498114fdd48a6f1cdb1aa2"><div class="ttname"><a href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#aed64654e7d498114fdd48a6f1cdb1aa2">faiss::gpu::StackDeviceMemory::Stack::start_</a></div><div class="ttdeci">char * start_</div><div class="ttdef"><b>Definition:</b> <a href="StackDeviceMemory_8h_source.html#l00092">StackDeviceMemory.h:92</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1StackDeviceMemory_html_ac54f49a3be6b7fe4f1fc70094075d875"><div class="ttname"><a href="classfaiss_1_1gpu_1_1StackDeviceMemory.html#ac54f49a3be6b7fe4f1fc70094075d875">faiss::gpu::StackDeviceMemory::device_</a></div><div class="ttdeci">int device_</div><div class="ttdoc">Our device. </div><div class="ttdef"><b>Definition:</b> <a href="StackDeviceMemory_8h_source.html#l00118">StackDeviceMemory.h:118</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1DeviceMemoryReservation_html"><div class="ttname"><a href="classfaiss_1_1gpu_1_1DeviceMemoryReservation.html">faiss::gpu::DeviceMemoryReservation</a></div><div class="ttdef"><b>Definition:</b> <a href="DeviceMemory_8h_source.html#l00020">DeviceMemory.h:20</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1StackDeviceMemory_html_ab9dac6d8953630121f60fb804599f648"><div class="ttname"><a href="classfaiss_1_1gpu_1_1StackDeviceMemory.html#ab9dac6d8953630121f60fb804599f648">faiss::gpu::StackDeviceMemory::getDevice</a></div><div class="ttdeci">int getDevice() const override</div><div class="ttdoc">Returns the device we are managing memory for. </div><div class="ttdef"><b>Definition:</b> <a href="StackDeviceMemory_8cpp_source.html#l00195">StackDeviceMemory.cpp:195</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1StackDeviceMemory_html_a130f900c32ba91ae1f872c7ee506a93e"><div class="ttname"><a href="classfaiss_1_1gpu_1_1StackDeviceMemory.html#a130f900c32ba91ae1f872c7ee506a93e">faiss::gpu::StackDeviceMemory::StackDeviceMemory</a></div><div class="ttdeci">StackDeviceMemory(int device, size_t allocPerDevice)</div><div class="ttdoc">Allocate a new region of memory that we manage. </div><div class="ttdef"><b>Definition:</b> <a href="StackDeviceMemory_8cpp_source.html#l00180">StackDeviceMemory.cpp:180</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>