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
280
281
282
283
<!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: faiss::gpu::StackDeviceMemory::Stack Struct Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><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="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</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="namespacefaiss.html">faiss</a></li><li class="navelem"><b>gpu</b></li><li class="navelem"><a class="el" href="classfaiss_1_1gpu_1_1StackDeviceMemory.html">StackDeviceMemory</a></li><li class="navelem"><a class="el" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html">Stack</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">faiss::gpu::StackDeviceMemory::Stack Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a783de9fc71cf57bf336c474f6155453d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a783de9fc71cf57bf336c474f6155453d"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a783de9fc71cf57bf336c474f6155453d">Stack</a> (int device, size_t size)</td></tr>
<tr class="memdesc:a783de9fc71cf57bf336c474f6155453d"><td class="mdescLeft"> </td><td class="mdescRight">Constructor that allocates memory via cudaMalloc. <br/></td></tr>
<tr class="separator:a783de9fc71cf57bf336c474f6155453d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a92a16b44da0ab2a89d3d032b762c0232"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a92a16b44da0ab2a89d3d032b762c0232"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a92a16b44da0ab2a89d3d032b762c0232">Stack</a> (int device, void *p, size_t size, bool isOwner)</td></tr>
<tr class="memdesc:a92a16b44da0ab2a89d3d032b762c0232"><td class="mdescLeft"> </td><td class="mdescRight">Constructor that references a pre-allocated region of memory. <br/></td></tr>
<tr class="separator:a92a16b44da0ab2a89d3d032b762c0232"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac9fe1174255fedfee546bb5e37c12834"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#ac9fe1174255fedfee546bb5e37c12834">getSizeAvailable</a> () const </td></tr>
<tr class="separator:ac9fe1174255fedfee546bb5e37c12834"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab45d128f288728df5baf03defd50cec7"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#ab45d128f288728df5baf03defd50cec7">getAlloc</a> (size_t size, cudaStream_t stream)</td></tr>
<tr class="separator:ab45d128f288728df5baf03defd50cec7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5c652c126c2bf37149995cdb9d46a382"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5c652c126c2bf37149995cdb9d46a382"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a5c652c126c2bf37149995cdb9d46a382">returnAlloc</a> (char *p, size_t size, cudaStream_t stream)</td></tr>
<tr class="memdesc:a5c652c126c2bf37149995cdb9d46a382"><td class="mdescLeft"> </td><td class="mdescRight">Returns an allocation. <br/></td></tr>
<tr class="separator:a5c652c126c2bf37149995cdb9d46a382"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1c91f4d50ecb8bb659054227d32fb47b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c91f4d50ecb8bb659054227d32fb47b"></a>
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a1c91f4d50ecb8bb659054227d32fb47b">toString</a> () const </td></tr>
<tr class="memdesc:a1c91f4d50ecb8bb659054227d32fb47b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the stack state. <br/></td></tr>
<tr class="separator:a1c91f4d50ecb8bb659054227d32fb47b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a88e877d2b63d6e3d828a37462e780004"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a88e877d2b63d6e3d828a37462e780004"></a>
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a88e877d2b63d6e3d828a37462e780004">getHighWaterCudaMalloc</a> () const </td></tr>
<tr class="memdesc:a88e877d2b63d6e3d828a37462e780004"><td class="mdescLeft"> </td><td class="mdescRight">Returns the high-water mark of cudaMalloc activity. <br/></td></tr>
<tr class="separator:a88e877d2b63d6e3d828a37462e780004"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a0950e30ddd0008367a0fb109db9c01b9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0950e30ddd0008367a0fb109db9c01b9"></a>
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a0950e30ddd0008367a0fb109db9c01b9">device_</a></td></tr>
<tr class="memdesc:a0950e30ddd0008367a0fb109db9c01b9"><td class="mdescLeft"> </td><td class="mdescRight">Device this allocation is on. <br/></td></tr>
<tr class="separator:a0950e30ddd0008367a0fb109db9c01b9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a949014db795e0def2c257aa775993230"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a949014db795e0def2c257aa775993230"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a949014db795e0def2c257aa775993230">isOwner_</a></td></tr>
<tr class="memdesc:a949014db795e0def2c257aa775993230"><td class="mdescLeft"> </td><td class="mdescRight">Do we own our region of memory? <br/></td></tr>
<tr class="separator:a949014db795e0def2c257aa775993230"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aed64654e7d498114fdd48a6f1cdb1aa2"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#aed64654e7d498114fdd48a6f1cdb1aa2">start_</a></td></tr>
<tr class="separator:aed64654e7d498114fdd48a6f1cdb1aa2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1db5eeb343fc59b9dc3f0303558c692b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1db5eeb343fc59b9dc3f0303558c692b"></a>
char * </td><td class="memItemRight" valign="bottom"><b>end_</b></td></tr>
<tr class="separator:a1db5eeb343fc59b9dc3f0303558c692b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3df7ba513acd46aa69180585cb4e7aac"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3df7ba513acd46aa69180585cb4e7aac"></a>
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a3df7ba513acd46aa69180585cb4e7aac">size_</a></td></tr>
<tr class="memdesc:a3df7ba513acd46aa69180585cb4e7aac"><td class="mdescLeft"> </td><td class="mdescRight">Total size end_ - start_. <br/></td></tr>
<tr class="separator:a3df7ba513acd46aa69180585cb4e7aac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a140d3dc4577883704708ecca493813ff"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a140d3dc4577883704708ecca493813ff"></a>
char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a140d3dc4577883704708ecca493813ff">head_</a></td></tr>
<tr class="memdesc:a140d3dc4577883704708ecca493813ff"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html">Stack</a> head within [start, end) <br/></td></tr>
<tr class="separator:a140d3dc4577883704708ecca493813ff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9fc42fbbe671faee41ea85a68bdb6b1e"><td class="memItemLeft" align="right" valign="top">std::list< <a class="el" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Range.html">Range</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a9fc42fbbe671faee41ea85a68bdb6b1e">lastUsers_</a></td></tr>
<tr class="separator:a9fc42fbbe671faee41ea85a68bdb6b1e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8cd6e71bd4d147dcc5a9db951bcbb075"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8cd6e71bd4d147dcc5a9db951bcbb075"></a>
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a8cd6e71bd4d147dcc5a9db951bcbb075">mallocCurrent_</a></td></tr>
<tr class="memdesc:a8cd6e71bd4d147dcc5a9db951bcbb075"><td class="mdescLeft"> </td><td class="mdescRight">How much cudaMalloc memory is currently outstanding? <br/></td></tr>
<tr class="separator:a8cd6e71bd4d147dcc5a9db951bcbb075"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa05c1f4a5280fe723c9888937182df75"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#aa05c1f4a5280fe723c9888937182df75">highWaterMemoryUsed_</a></td></tr>
<tr class="separator:aa05c1f4a5280fe723c9888937182df75"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6536a4542048be713b5669ef8bcc5ff6"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Stack.html#a6536a4542048be713b5669ef8bcc5ff6">highWaterMalloc_</a></td></tr>
<tr class="separator:a6536a4542048be713b5669ef8bcc5ff6"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p>Definition at line <a class="el" href="StackDeviceMemory_8h_source.html#l00059">59</a> of file <a class="el" href="StackDeviceMemory_8h_source.html">StackDeviceMemory.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ab45d128f288728df5baf03defd50cec7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * faiss::gpu::StackDeviceMemory::Stack::getAlloc </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">cudaStream_t </td>
<td class="paramname"><em>stream</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Obtains an allocation; all allocations are guaranteed to be 16 byte aligned </p>
<p>Definition at line <a class="el" href="StackDeviceMemory_8cpp_source.html#l00063">63</a> of file <a class="el" href="StackDeviceMemory_8cpp_source.html">StackDeviceMemory.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac9fe1174255fedfee546bb5e37c12834"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t faiss::gpu::StackDeviceMemory::Stack::getSizeAvailable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns how much size is available for an allocation without calling cudaMalloc </p>
<p>Definition at line <a class="el" href="StackDeviceMemory_8cpp_source.html#l00058">58</a> of file <a class="el" href="StackDeviceMemory_8cpp_source.html">StackDeviceMemory.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a6536a4542048be713b5669ef8bcc5ff6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t faiss::gpu::StackDeviceMemory::Stack::highWaterMalloc_</td>
</tr>
</table>
</div><div class="memdoc">
<p>What's the high water mark in terms of memory allocated via cudaMalloc? </p>
<p>Definition at line <a class="el" href="StackDeviceMemory_8h_source.html#l00114">114</a> of file <a class="el" href="StackDeviceMemory_8h_source.html">StackDeviceMemory.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa05c1f4a5280fe723c9888937182df75"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t faiss::gpu::StackDeviceMemory::Stack::highWaterMemoryUsed_</td>
</tr>
</table>
</div><div class="memdoc">
<p>What's the high water mark in terms of memory used from the temporary buffer? </p>
<p>Definition at line <a class="el" href="StackDeviceMemory_8h_source.html#l00110">110</a> of file <a class="el" href="StackDeviceMemory_8h_source.html">StackDeviceMemory.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9fc42fbbe671faee41ea85a68bdb6b1e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::list<<a class="el" href="structfaiss_1_1gpu_1_1StackDeviceMemory_1_1Range.html">Range</a>> faiss::gpu::StackDeviceMemory::Stack::lastUsers_</td>
</tr>
</table>
</div><div class="memdoc">
<p>List of previous last users of allocations on our stack, for possible synchronization purposes </p>
<p>Definition at line <a class="el" href="StackDeviceMemory_8h_source.html#l00103">103</a> of file <a class="el" href="StackDeviceMemory_8h_source.html">StackDeviceMemory.h</a>.</p>
</div>
</div>
<a class="anchor" id="aed64654e7d498114fdd48a6f1cdb1aa2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* faiss::gpu::StackDeviceMemory::Stack::start_</td>
</tr>
</table>
</div><div class="memdoc">
<p>Where our allocation begins and ends [start_, end_) is valid </p>
<p>Definition at line <a class="el" href="StackDeviceMemory_8h_source.html#l00092">92</a> of file <a class="el" href="StackDeviceMemory_8h_source.html">StackDeviceMemory.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>/data/users/matthijs/github_faiss/faiss/gpu/utils/<a class="el" href="StackDeviceMemory_8h_source.html">StackDeviceMemory.h</a></li>
<li>/data/users/matthijs/github_faiss/faiss/gpu/utils/<a class="el" href="StackDeviceMemory_8cpp_source.html">StackDeviceMemory.cpp</a></li>
</ul>
</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>