• Lucas Hosseini's avatar
    Facebook sync (May 2019) + relicense (#838) · a8118acb
    Lucas Hosseini authored
    Changelog:
    
    - changed license: BSD+Patents -> MIT
    - propagates exceptions raised in sub-indexes of IndexShards and IndexReplicas
    - support for searching several inverted lists in parallel (parallel_mode != 0)
    - better support for PQ codes where nbit != 8 or 16
    - IVFSpectralHash implementation: spectral hash codes inside an IVF
    - 6-bit per component scalar quantizer (4 and 8 bit were already supported)
    - combinations of inverted lists: HStackInvertedLists and VStackInvertedLists
    - configurable number of threads for OnDiskInvertedLists prefetching (including 0=no prefetch)
    - more test and demo code compatible with Python 3 (print with parentheses)
    - refactored benchmark code: data loading is now in a single file
    Unverified
    a8118acb
GpuResources_8cpp_source.html 18.9 KB
<!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/hoss/faiss/gpu/GpuResources.cpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Faiss
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;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&#160;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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</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_5956a3e80a20e8e03eb577bedb92689f.html">gpu</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">GpuResources.cpp</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright (c) Facebook, Inc. and its affiliates.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * This source code is licensed under the MIT license found in the</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * LICENSE file in the root directory of this source tree.</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;</div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;</div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="preprocessor">#include &quot;GpuResources.h&quot;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="preprocessor">#include &quot;utils/DeviceUtils.h&quot;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;</div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="keyword">namespace </span>faiss { <span class="keyword">namespace </span>gpu {</div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;</div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;GpuResources::~GpuResources() {</div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;}</div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;</div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;cublasHandle_t</div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1GpuResources.html#a00cb7bcbc5f1a00da673f30749149b12">   18</a></span>&#160;<a class="code" href="classfaiss_1_1gpu_1_1GpuResources.html#a00cb7bcbc5f1a00da673f30749149b12">GpuResources::getBlasHandleCurrentDevice</a>() {</div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;  <span class="keywordflow">return</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuResources.html#aa2682b8503dfdab4f7f5ef867035ad29">getBlasHandle</a>(getCurrentDevice());</div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;}</div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;cudaStream_t</div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1GpuResources.html#aa0354aa570c24e17a9f8a6a45b153ed2">   23</a></span>&#160;<a class="code" href="classfaiss_1_1gpu_1_1GpuResources.html#aa0354aa570c24e17a9f8a6a45b153ed2">GpuResources::getDefaultStreamCurrentDevice</a>() {</div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;  <span class="keywordflow">return</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuResources.html#a6c564198df6ba675920c993e2af34b8c">getDefaultStream</a>(getCurrentDevice());</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;}</div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;</div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;std::vector&lt;cudaStream_t&gt;</div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1GpuResources.html#a622f95597cc2ed2f10f3ae9400dc685b">   28</a></span>&#160;<a class="code" href="classfaiss_1_1gpu_1_1GpuResources.html#a622f95597cc2ed2f10f3ae9400dc685b">GpuResources::getAlternateStreamsCurrentDevice</a>() {</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;  <span class="keywordflow">return</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuResources.html#afb469bf3b107f43ef0d6abe4a014bb5b">getAlternateStreams</a>(getCurrentDevice());</div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;}</div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;</div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<a class="code" href="classfaiss_1_1gpu_1_1DeviceMemory.html">DeviceMemory</a>&amp;</div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1GpuResources.html#a1dda2dc3db1bd62cde6657c5cdbfb6e1">   33</a></span>&#160;<a class="code" href="classfaiss_1_1gpu_1_1GpuResources.html#a1dda2dc3db1bd62cde6657c5cdbfb6e1">GpuResources::getMemoryManagerCurrentDevice</a>() {</div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;  <span class="keywordflow">return</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuResources.html#a7fec58e9414f313fde4988a62f06cfab">getMemoryManager</a>(getCurrentDevice());</div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;}</div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;cudaStream_t</div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1GpuResources.html#aefb90d15fade57cdfcff03ec800183d4">   38</a></span>&#160;<a class="code" href="classfaiss_1_1gpu_1_1GpuResources.html#aefb90d15fade57cdfcff03ec800183d4">GpuResources::getAsyncCopyStreamCurrentDevice</a>() {</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;  <span class="keywordflow">return</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuResources.html#a104b291ed4116033752144e90856c2e7">getAsyncCopyStream</a>(getCurrentDevice());</div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;}</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;</div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="keywordtype">void</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1GpuResources.html#a130deab9f6d49cbdde8f9da45ce868fd">   43</a></span>&#160;<a class="code" href="classfaiss_1_1gpu_1_1GpuResources.html#a130deab9f6d49cbdde8f9da45ce868fd">GpuResources::syncDefaultStream</a>(<span class="keywordtype">int</span> device) {</div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;  CUDA_VERIFY(cudaStreamSynchronize(<a class="code" href="classfaiss_1_1gpu_1_1GpuResources.html#a6c564198df6ba675920c993e2af34b8c">getDefaultStream</a>(device)));</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;}</div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="keywordtype">void</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1GpuResources.html#adf6a5653ec2bbb0e9d58a0e1dd73897f">   48</a></span>&#160;<a class="code" href="classfaiss_1_1gpu_1_1GpuResources.html#adf6a5653ec2bbb0e9d58a0e1dd73897f">GpuResources::syncDefaultStreamCurrentDevice</a>() {</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;  <a class="code" href="classfaiss_1_1gpu_1_1GpuResources.html#a130deab9f6d49cbdde8f9da45ce868fd">syncDefaultStream</a>(getCurrentDevice());</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;}</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;</div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;} } <span class="comment">// namespace</span></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuResources_html_aa0354aa570c24e17a9f8a6a45b153ed2"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuResources.html#aa0354aa570c24e17a9f8a6a45b153ed2">faiss::gpu::GpuResources::getDefaultStreamCurrentDevice</a></div><div class="ttdeci">cudaStream_t getDefaultStreamCurrentDevice()</div><div class="ttdoc">Calls getDefaultStream with the current device. </div><div class="ttdef"><b>Definition:</b> <a href="GpuResources_8cpp_source.html#l00023">GpuResources.cpp:23</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuResources_html_aa2682b8503dfdab4f7f5ef867035ad29"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuResources.html#aa2682b8503dfdab4f7f5ef867035ad29">faiss::gpu::GpuResources::getBlasHandle</a></div><div class="ttdeci">virtual cublasHandle_t getBlasHandle(int device)=0</div><div class="ttdoc">Returns the cuBLAS handle that we use for the given device. </div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuResources_html_a6c564198df6ba675920c993e2af34b8c"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuResources.html#a6c564198df6ba675920c993e2af34b8c">faiss::gpu::GpuResources::getDefaultStream</a></div><div class="ttdeci">virtual cudaStream_t getDefaultStream(int device)=0</div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuResources_html_a00cb7bcbc5f1a00da673f30749149b12"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuResources.html#a00cb7bcbc5f1a00da673f30749149b12">faiss::gpu::GpuResources::getBlasHandleCurrentDevice</a></div><div class="ttdeci">cublasHandle_t getBlasHandleCurrentDevice()</div><div class="ttdoc">Calls getBlasHandle with the current device. </div><div class="ttdef"><b>Definition:</b> <a href="GpuResources_8cpp_source.html#l00018">GpuResources.cpp:18</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuResources_html_a1dda2dc3db1bd62cde6657c5cdbfb6e1"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuResources.html#a1dda2dc3db1bd62cde6657c5cdbfb6e1">faiss::gpu::GpuResources::getMemoryManagerCurrentDevice</a></div><div class="ttdeci">DeviceMemory &amp; getMemoryManagerCurrentDevice()</div><div class="ttdoc">Calls getMemoryManager for the current device. </div><div class="ttdef"><b>Definition:</b> <a href="GpuResources_8cpp_source.html#l00033">GpuResources.cpp:33</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuResources_html_adf6a5653ec2bbb0e9d58a0e1dd73897f"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuResources.html#adf6a5653ec2bbb0e9d58a0e1dd73897f">faiss::gpu::GpuResources::syncDefaultStreamCurrentDevice</a></div><div class="ttdeci">void syncDefaultStreamCurrentDevice()</div><div class="ttdoc">Calls syncDefaultStream for the current device. </div><div class="ttdef"><b>Definition:</b> <a href="GpuResources_8cpp_source.html#l00048">GpuResources.cpp:48</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuResources_html_aefb90d15fade57cdfcff03ec800183d4"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuResources.html#aefb90d15fade57cdfcff03ec800183d4">faiss::gpu::GpuResources::getAsyncCopyStreamCurrentDevice</a></div><div class="ttdeci">cudaStream_t getAsyncCopyStreamCurrentDevice()</div><div class="ttdoc">Calls getAsyncCopyStream for the current device. </div><div class="ttdef"><b>Definition:</b> <a href="GpuResources_8cpp_source.html#l00038">GpuResources.cpp:38</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuResources_html_a622f95597cc2ed2f10f3ae9400dc685b"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuResources.html#a622f95597cc2ed2f10f3ae9400dc685b">faiss::gpu::GpuResources::getAlternateStreamsCurrentDevice</a></div><div class="ttdeci">std::vector&lt; cudaStream_t &gt; getAlternateStreamsCurrentDevice()</div><div class="ttdoc">Calls getAlternateStreams for the current device. </div><div class="ttdef"><b>Definition:</b> <a href="GpuResources_8cpp_source.html#l00028">GpuResources.cpp:28</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuResources_html_a104b291ed4116033752144e90856c2e7"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuResources.html#a104b291ed4116033752144e90856c2e7">faiss::gpu::GpuResources::getAsyncCopyStream</a></div><div class="ttdeci">virtual cudaStream_t getAsyncCopyStream(int device)=0</div><div class="ttdoc">Returns the stream on which we perform async CPU &amp;lt;-&amp;gt; GPU copies. </div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuResources_html_a130deab9f6d49cbdde8f9da45ce868fd"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuResources.html#a130deab9f6d49cbdde8f9da45ce868fd">faiss::gpu::GpuResources::syncDefaultStream</a></div><div class="ttdeci">void syncDefaultStream(int device)</div><div class="ttdef"><b>Definition:</b> <a href="GpuResources_8cpp_source.html#l00043">GpuResources.cpp:43</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuResources_html_a7fec58e9414f313fde4988a62f06cfab"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuResources.html#a7fec58e9414f313fde4988a62f06cfab">faiss::gpu::GpuResources::getMemoryManager</a></div><div class="ttdeci">virtual DeviceMemory &amp; getMemoryManager(int device)=0</div><div class="ttdoc">Returns the temporary memory manager for the given device. </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#l00044">DeviceMemory.h:44</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuResources_html_afb469bf3b107f43ef0d6abe4a014bb5b"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuResources.html#afb469bf3b107f43ef0d6abe4a014bb5b">faiss::gpu::GpuResources::getAlternateStreams</a></div><div class="ttdeci">virtual std::vector&lt; cudaStream_t &gt; getAlternateStreams(int device)=0</div><div class="ttdoc">Returns the set of alternative streams that we use for the given device. </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>