blob: d8f1c4d01db2016f2070c6466e650bf2bc538401 [file] [log] [blame]
<!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.6"/>
<title>Impala: be/src/util/lru-cache.inline.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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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">Impala
</div>
<div id="projectbrief">Impalaistheopensource,nativeanalyticdatabaseforApacheHadoop.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<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>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('lru-cache_8inline_8h_source.html','');});
</script>
<div id="doc-content">
<!-- 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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</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 class="header">
<div class="headertitle">
<div class="title">lru-cache.inline.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="lru-cache_8inline_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// Copyright 2015 Cloudera Inc.</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// you may not use this file except in compliance with the License.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// You may obtain a copy of the License at</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;<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">// limitations under the License.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#ifndef IMPALA_UTIL_LRU_CACHE_INLINE_H_</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define IMPALA_UTIL_LRU_CACHE_INLINE_H_</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="keyword">namespace </span>impala {</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Key, <span class="keyword">typename</span> Value&gt;</div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="classimpala_1_1FifoMultimap.html#a68dd48a3280a3a6f09d0c1a621204801"> 21</a></span>&#160;<a class="code" href="classimpala_1_1FifoMultimap.html#a68dd48a3280a3a6f09d0c1a621204801">FifoMultimap&lt;Key, Value&gt;::~FifoMultimap</a>() {</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">typename</span> ListType::iterator b = lru_list_.begin(),</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; e = lru_list_.end(); b != e; ++b) {</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; deleter_(&amp;(b-&gt;second));</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;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Key, <span class="keyword">typename</span> Value&gt;</div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="classimpala_1_1FifoMultimap.html#a681f6bfd8901130fbf4627d2ce5e1ac5"> 29</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classimpala_1_1FifoMultimap.html#a681f6bfd8901130fbf4627d2ce5e1ac5">FifoMultimap&lt;Key, Value&gt;::Put</a>(<span class="keyword">const</span> Key&amp; k, <span class="keyword">const</span> Value&amp; v) {</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; boost::lock_guard&lt;SpinLock&gt; g(<a class="code" href="namespaceimpala.html#a420d4837428729719338ca91ed375f3c">lock_</a>);</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keywordflow">if</span> (lru_list_.size() &gt;= capacity_) EvictValue();</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keyword">const</span> <a class="code" href="classimpala_1_1FifoMultimap.html#a106732050ce52789ad086e06ab32fa3e">ValueType</a>&amp; kv_pair = std::make_pair(k, v);</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keyword">const</span> <span class="keyword">typename</span> MapType::value_type&amp; val =</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; std::make_pair(k, lru_list_.insert(lru_list_.end(), kv_pair));</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="comment">// Find an insert hint to use with the insert operation</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">typename</span> MapType::iterator it = cache_.lower_bound(k);</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordflow">if</span> (it == cache_.end() || it-&gt;first != k) {</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; cache_.insert(val);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="comment">// If the insert hint is sufficiently good, the element will be inserted before in the</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="comment">// sequence of elements having the same key</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; cache_.insert(it, val);</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; }</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;}</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;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Key, <span class="keyword">typename</span> Value&gt;</div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classimpala_1_1FifoMultimap.html#ae2291140eb56002a26db4017141b346a"> 47</a></span>&#160;<span class="keywordtype">bool</span> <a class="code" href="classimpala_1_1FifoMultimap.html#ae2291140eb56002a26db4017141b346a">FifoMultimap&lt;Key, Value&gt;::Pop</a>(<span class="keyword">const</span> Key&amp; k, Value* out) {</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; boost::lock_guard&lt;SpinLock&gt; g(<a class="code" href="namespaceimpala.html#a420d4837428729719338ca91ed375f3c">lock_</a>);</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="comment">// Find the first value under key k.</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keyword">typename</span> MapType::iterator it = cache_.lower_bound(k);</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordflow">if</span> (it == cache_.end() || it-&gt;first != k) <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keyword">typename</span> ListType::iterator lit = it-&gt;second;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; cache_.erase(it);</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; *out = lit-&gt;second;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; lru_list_.erase(lit);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;}</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Key, <span class="keyword">typename</span> Value&gt;</div>
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classimpala_1_1FifoMultimap.html#ac3d5d8aa9ac065be23d97af6360f758d"> 60</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classimpala_1_1FifoMultimap.html#ac3d5d8aa9ac065be23d97af6360f758d">FifoMultimap&lt;Key, Value&gt;::EvictValue</a>() {</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keyword">typename</span> ListType::iterator to_evict = lru_list_.begin();</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="comment">// Find all elements under this key, until C++11 the order of the elements is not</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="comment">// guaranteed.</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; std::pair&lt;typename MapType::iterator, typename MapType::iterator&gt; range =</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; cache_.equal_range(to_evict-&gt;first);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="comment">// Search until the value is found in the range of the same key.</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordflow">while</span> (range.first != range.second) {</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keywordflow">if</span> (range.first-&gt;second == to_evict) {</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; cache_.erase(range.first);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keywordflow">break</span>;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; }</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; ++range.first;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; }</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; DCHECK(range.first != range.second); <span class="comment">// LCOV_EXCL_LINE</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; deleter_(&amp;(*to_evict).second);</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; lru_list_.erase(to_evict);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;}</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;}</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="preprocessor">#endif // IMPALA_UTIL_LRU_CACHE_INLINE_H_</span></div>
<div class="ttc" id="classimpala_1_1FifoMultimap_html_a681f6bfd8901130fbf4627d2ce5e1ac5"><div class="ttname"><a href="classimpala_1_1FifoMultimap.html#a681f6bfd8901130fbf4627d2ce5e1ac5">impala::FifoMultimap::Put</a></div><div class="ttdeci">void Put(const Key &amp;k, const Value &amp;v)</div><div class="ttdef"><b>Definition:</b> <a href="lru-cache_8inline_8h_source.html#l00029">lru-cache.inline.h:29</a></div></div>
<div class="ttc" id="classimpala_1_1FifoMultimap_html_ae2291140eb56002a26db4017141b346a"><div class="ttname"><a href="classimpala_1_1FifoMultimap.html#ae2291140eb56002a26db4017141b346a">impala::FifoMultimap::Pop</a></div><div class="ttdeci">bool Pop(const Key &amp;k, Value *out)</div><div class="ttdef"><b>Definition:</b> <a href="lru-cache_8inline_8h_source.html#l00047">lru-cache.inline.h:47</a></div></div>
<div class="ttc" id="namespaceimpala_html_a420d4837428729719338ca91ed375f3c"><div class="ttname"><a href="namespaceimpala.html#a420d4837428729719338ca91ed375f3c">impala::lock_</a></div><div class="ttdeci">boost::mutex lock_</div><div class="ttdoc">protects all fields below </div><div class="ttdef"><b>Definition:</b> <a href="coordinator_8h_source.html#l00233">coordinator.h:233</a></div></div>
<div class="ttc" id="classimpala_1_1FifoMultimap_html_ac3d5d8aa9ac065be23d97af6360f758d"><div class="ttname"><a href="classimpala_1_1FifoMultimap.html#ac3d5d8aa9ac065be23d97af6360f758d">impala::FifoMultimap::EvictValue</a></div><div class="ttdeci">void EvictValue()</div><div class="ttdef"><b>Definition:</b> <a href="lru-cache_8inline_8h_source.html#l00060">lru-cache.inline.h:60</a></div></div>
<div class="ttc" id="classimpala_1_1FifoMultimap_html_a68dd48a3280a3a6f09d0c1a621204801"><div class="ttname"><a href="classimpala_1_1FifoMultimap.html#a68dd48a3280a3a6f09d0c1a621204801">impala::FifoMultimap::~FifoMultimap</a></div><div class="ttdeci">~FifoMultimap()</div><div class="ttdoc">Walk the list of elements and call the deleter function for each element. </div><div class="ttdef"><b>Definition:</b> <a href="lru-cache_8inline_8h_source.html#l00021">lru-cache.inline.h:21</a></div></div>
<div class="ttc" id="classimpala_1_1FifoMultimap_html_a106732050ce52789ad086e06ab32fa3e"><div class="ttname"><a href="classimpala_1_1FifoMultimap.html#a106732050ce52789ad086e06ab32fa3e">impala::FifoMultimap::ValueType</a></div><div class="ttdeci">std::pair&lt; Key, Value &gt; ValueType</div><div class="ttdef"><b>Definition:</b> <a href="lru-cache_8h_source.html#l00063">lru-cache.h:63</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_e5d120be6b5e8a44336cbfd013b25604.html">be</a></li><li class="navelem"><a class="el" href="dir_68cf7cafb51a962d5bc4848b83cab0de.html">src</a></li><li class="navelem"><a class="el" href="dir_6939c8639261a9303da2cde491b82898.html">util</a></li><li class="navelem"><a class="el" href="lru-cache_8inline_8h.html">lru-cache.inline.h</a></li>
<li class="footer">Generated on Thu May 7 2015 16:10:37 for Impala by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
</ul>
</div>
</body>
</html>