| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.hadoop.hbase.io.hfile, class: TinyLfuBlockCache"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.io.hfile;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import static java.util.Objects.requireNonNull;</span> |
| <span class="source-line-no">021</span><span id="line-21"></span> |
| <span class="source-line-no">022</span><span id="line-22">import com.github.benmanes.caffeine.cache.Cache;</span> |
| <span class="source-line-no">023</span><span id="line-23">import com.github.benmanes.caffeine.cache.Caffeine;</span> |
| <span class="source-line-no">024</span><span id="line-24">import com.github.benmanes.caffeine.cache.Policy.Eviction;</span> |
| <span class="source-line-no">025</span><span id="line-25">import com.github.benmanes.caffeine.cache.RemovalCause;</span> |
| <span class="source-line-no">026</span><span id="line-26">import com.github.benmanes.caffeine.cache.RemovalListener;</span> |
| <span class="source-line-no">027</span><span id="line-27">import java.util.Comparator;</span> |
| <span class="source-line-no">028</span><span id="line-28">import java.util.Iterator;</span> |
| <span class="source-line-no">029</span><span id="line-29">import java.util.concurrent.Executor;</span> |
| <span class="source-line-no">030</span><span id="line-30">import java.util.concurrent.Executors;</span> |
| <span class="source-line-no">031</span><span id="line-31">import java.util.concurrent.ScheduledExecutorService;</span> |
| <span class="source-line-no">032</span><span id="line-32">import java.util.concurrent.TimeUnit;</span> |
| <span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.io.HeapSize;</span> |
| <span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.io.hfile.bucket.BucketCache;</span> |
| <span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.util.StringUtils;</span> |
| <span class="source-line-no">037</span><span id="line-37">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">038</span><span id="line-38">import org.slf4j.Logger;</span> |
| <span class="source-line-no">039</span><span id="line-39">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">040</span><span id="line-40"></span> |
| <span class="source-line-no">041</span><span id="line-41">import org.apache.hbase.thirdparty.com.google.common.base.MoreObjects;</span> |
| <span class="source-line-no">042</span><span id="line-42">import org.apache.hbase.thirdparty.com.google.common.util.concurrent.ThreadFactoryBuilder;</span> |
| <span class="source-line-no">043</span><span id="line-43"></span> |
| <span class="source-line-no">044</span><span id="line-44">/**</span> |
| <span class="source-line-no">045</span><span id="line-45"> * A block cache that is memory-aware using {@link HeapSize}, memory bounded using the W-TinyLFU</span> |
| <span class="source-line-no">046</span><span id="line-46"> * eviction algorithm, and concurrent. This implementation delegates to a Caffeine cache to provide</span> |
| <span class="source-line-no">047</span><span id="line-47"> * O(1) read and write operations.</span> |
| <span class="source-line-no">048</span><span id="line-48"> * <ul></span> |
| <span class="source-line-no">049</span><span id="line-49"> * <li>W-TinyLFU: http://arxiv.org/pdf/1512.00727.pdf</li></span> |
| <span class="source-line-no">050</span><span id="line-50"> * <li>Caffeine: https://github.com/ben-manes/caffeine</li></span> |
| <span class="source-line-no">051</span><span id="line-51"> * <li>Cache design: http://highscalability.com/blog/2016/1/25/design-of-a-modern-cache.html</li></span> |
| <span class="source-line-no">052</span><span id="line-52"> * </ul></span> |
| <span class="source-line-no">053</span><span id="line-53"> */</span> |
| <span class="source-line-no">054</span><span id="line-54">@InterfaceAudience.Private</span> |
| <span class="source-line-no">055</span><span id="line-55">public final class TinyLfuBlockCache implements FirstLevelBlockCache {</span> |
| <span class="source-line-no">056</span><span id="line-56"> private static final Logger LOG = LoggerFactory.getLogger(TinyLfuBlockCache.class);</span> |
| <span class="source-line-no">057</span><span id="line-57"></span> |
| <span class="source-line-no">058</span><span id="line-58"> private static final String MAX_BLOCK_SIZE = "hbase.tinylfu.max.block.size";</span> |
| <span class="source-line-no">059</span><span id="line-59"> private static final long DEFAULT_MAX_BLOCK_SIZE = 16L * 1024L * 1024L;</span> |
| <span class="source-line-no">060</span><span id="line-60"> private static final int STAT_THREAD_PERIOD_SECONDS = 5 * 60;</span> |
| <span class="source-line-no">061</span><span id="line-61"></span> |
| <span class="source-line-no">062</span><span id="line-62"> private transient final Eviction<BlockCacheKey, Cacheable> policy;</span> |
| <span class="source-line-no">063</span><span id="line-63"> private transient final ScheduledExecutorService statsThreadPool;</span> |
| <span class="source-line-no">064</span><span id="line-64"> private final long maxBlockSize;</span> |
| <span class="source-line-no">065</span><span id="line-65"> private final CacheStats stats;</span> |
| <span class="source-line-no">066</span><span id="line-66"></span> |
| <span class="source-line-no">067</span><span id="line-67"> private transient BlockCache victimCache;</span> |
| <span class="source-line-no">068</span><span id="line-68"></span> |
| <span class="source-line-no">069</span><span id="line-69"> transient final Cache<BlockCacheKey, Cacheable> cache;</span> |
| <span class="source-line-no">070</span><span id="line-70"></span> |
| <span class="source-line-no">071</span><span id="line-71"> /**</span> |
| <span class="source-line-no">072</span><span id="line-72"> * Creates a block cache.</span> |
| <span class="source-line-no">073</span><span id="line-73"> * @param maximumSizeInBytes maximum size of this cache, in bytes</span> |
| <span class="source-line-no">074</span><span id="line-74"> * @param avgBlockSize expected average size of blocks, in bytes</span> |
| <span class="source-line-no">075</span><span id="line-75"> * @param executor the cache's executor</span> |
| <span class="source-line-no">076</span><span id="line-76"> * @param conf additional configuration</span> |
| <span class="source-line-no">077</span><span id="line-77"> */</span> |
| <span class="source-line-no">078</span><span id="line-78"> public TinyLfuBlockCache(long maximumSizeInBytes, long avgBlockSize, Executor executor,</span> |
| <span class="source-line-no">079</span><span id="line-79"> Configuration conf) {</span> |
| <span class="source-line-no">080</span><span id="line-80"> this(maximumSizeInBytes, avgBlockSize, conf.getLong(MAX_BLOCK_SIZE, DEFAULT_MAX_BLOCK_SIZE),</span> |
| <span class="source-line-no">081</span><span id="line-81"> executor);</span> |
| <span class="source-line-no">082</span><span id="line-82"> }</span> |
| <span class="source-line-no">083</span><span id="line-83"></span> |
| <span class="source-line-no">084</span><span id="line-84"> /**</span> |
| <span class="source-line-no">085</span><span id="line-85"> * Creates a block cache.</span> |
| <span class="source-line-no">086</span><span id="line-86"> * @param maximumSizeInBytes maximum size of this cache, in bytes</span> |
| <span class="source-line-no">087</span><span id="line-87"> * @param avgBlockSize expected average size of blocks, in bytes</span> |
| <span class="source-line-no">088</span><span id="line-88"> * @param maxBlockSize maximum size of a block, in bytes</span> |
| <span class="source-line-no">089</span><span id="line-89"> * @param executor the cache's executor</span> |
| <span class="source-line-no">090</span><span id="line-90"> */</span> |
| <span class="source-line-no">091</span><span id="line-91"> public TinyLfuBlockCache(long maximumSizeInBytes, long avgBlockSize, long maxBlockSize,</span> |
| <span class="source-line-no">092</span><span id="line-92"> Executor executor) {</span> |
| <span class="source-line-no">093</span><span id="line-93"> this.cache = Caffeine.newBuilder().executor(executor).maximumWeight(maximumSizeInBytes)</span> |
| <span class="source-line-no">094</span><span id="line-94"> .removalListener(new EvictionListener())</span> |
| <span class="source-line-no">095</span><span id="line-95"> .weigher(</span> |
| <span class="source-line-no">096</span><span id="line-96"> (BlockCacheKey key, Cacheable value) -> (int) Math.min(value.heapSize(), Integer.MAX_VALUE))</span> |
| <span class="source-line-no">097</span><span id="line-97"> .initialCapacity((int) Math.ceil((1.2 * maximumSizeInBytes) / avgBlockSize)).build();</span> |
| <span class="source-line-no">098</span><span id="line-98"> this.maxBlockSize = maxBlockSize;</span> |
| <span class="source-line-no">099</span><span id="line-99"> this.policy = cache.policy().eviction().get();</span> |
| <span class="source-line-no">100</span><span id="line-100"> this.stats = new CacheStats(getClass().getSimpleName());</span> |
| <span class="source-line-no">101</span><span id="line-101"></span> |
| <span class="source-line-no">102</span><span id="line-102"> statsThreadPool = Executors.newSingleThreadScheduledExecutor(new ThreadFactoryBuilder()</span> |
| <span class="source-line-no">103</span><span id="line-103"> .setNameFormat("TinyLfuBlockCacheStatsExecutor").setDaemon(true).build());</span> |
| <span class="source-line-no">104</span><span id="line-104"> statsThreadPool.scheduleAtFixedRate(this::logStats, STAT_THREAD_PERIOD_SECONDS,</span> |
| <span class="source-line-no">105</span><span id="line-105"> STAT_THREAD_PERIOD_SECONDS, TimeUnit.SECONDS);</span> |
| <span class="source-line-no">106</span><span id="line-106"> }</span> |
| <span class="source-line-no">107</span><span id="line-107"></span> |
| <span class="source-line-no">108</span><span id="line-108"> @Override</span> |
| <span class="source-line-no">109</span><span id="line-109"> public void setVictimCache(BlockCache victimCache) {</span> |
| <span class="source-line-no">110</span><span id="line-110"> if (this.victimCache != null) {</span> |
| <span class="source-line-no">111</span><span id="line-111"> throw new IllegalArgumentException("The victim cache has already been set");</span> |
| <span class="source-line-no">112</span><span id="line-112"> }</span> |
| <span class="source-line-no">113</span><span id="line-113"> this.victimCache = requireNonNull(victimCache);</span> |
| <span class="source-line-no">114</span><span id="line-114"> }</span> |
| <span class="source-line-no">115</span><span id="line-115"></span> |
| <span class="source-line-no">116</span><span id="line-116"> @Override</span> |
| <span class="source-line-no">117</span><span id="line-117"> public long size() {</span> |
| <span class="source-line-no">118</span><span id="line-118"> return policy.getMaximum();</span> |
| <span class="source-line-no">119</span><span id="line-119"> }</span> |
| <span class="source-line-no">120</span><span id="line-120"></span> |
| <span class="source-line-no">121</span><span id="line-121"> @Override</span> |
| <span class="source-line-no">122</span><span id="line-122"> public long getFreeSize() {</span> |
| <span class="source-line-no">123</span><span id="line-123"> return size() - getCurrentSize();</span> |
| <span class="source-line-no">124</span><span id="line-124"> }</span> |
| <span class="source-line-no">125</span><span id="line-125"></span> |
| <span class="source-line-no">126</span><span id="line-126"> @Override</span> |
| <span class="source-line-no">127</span><span id="line-127"> public long getCurrentSize() {</span> |
| <span class="source-line-no">128</span><span id="line-128"> return policy.weightedSize().getAsLong();</span> |
| <span class="source-line-no">129</span><span id="line-129"> }</span> |
| <span class="source-line-no">130</span><span id="line-130"></span> |
| <span class="source-line-no">131</span><span id="line-131"> @Override</span> |
| <span class="source-line-no">132</span><span id="line-132"> public long getBlockCount() {</span> |
| <span class="source-line-no">133</span><span id="line-133"> return cache.estimatedSize();</span> |
| <span class="source-line-no">134</span><span id="line-134"> }</span> |
| <span class="source-line-no">135</span><span id="line-135"></span> |
| <span class="source-line-no">136</span><span id="line-136"> @Override</span> |
| <span class="source-line-no">137</span><span id="line-137"> public long heapSize() {</span> |
| <span class="source-line-no">138</span><span id="line-138"> return getCurrentSize();</span> |
| <span class="source-line-no">139</span><span id="line-139"> }</span> |
| <span class="source-line-no">140</span><span id="line-140"></span> |
| <span class="source-line-no">141</span><span id="line-141"> @Override</span> |
| <span class="source-line-no">142</span><span id="line-142"> public void setMaxSize(long size) {</span> |
| <span class="source-line-no">143</span><span id="line-143"> policy.setMaximum(size);</span> |
| <span class="source-line-no">144</span><span id="line-144"> }</span> |
| <span class="source-line-no">145</span><span id="line-145"></span> |
| <span class="source-line-no">146</span><span id="line-146"> @Override</span> |
| <span class="source-line-no">147</span><span id="line-147"> public boolean containsBlock(BlockCacheKey cacheKey) {</span> |
| <span class="source-line-no">148</span><span id="line-148"> return cache.asMap().containsKey(cacheKey);</span> |
| <span class="source-line-no">149</span><span id="line-149"> }</span> |
| <span class="source-line-no">150</span><span id="line-150"></span> |
| <span class="source-line-no">151</span><span id="line-151"> @Override</span> |
| <span class="source-line-no">152</span><span id="line-152"> public Cacheable getBlock(BlockCacheKey cacheKey, boolean caching, boolean repeat,</span> |
| <span class="source-line-no">153</span><span id="line-153"> boolean updateCacheMetrics) {</span> |
| <span class="source-line-no">154</span><span id="line-154"> Cacheable value = cache.asMap().computeIfPresent(cacheKey, (blockCacheKey, cacheable) -> {</span> |
| <span class="source-line-no">155</span><span id="line-155"> // It will be referenced by RPC path, so increase here. NOTICE: Must do the retain inside</span> |
| <span class="source-line-no">156</span><span id="line-156"> // this block. because if retain outside the map#computeIfPresent, the evictBlock may remove</span> |
| <span class="source-line-no">157</span><span id="line-157"> // the block and release, then we're retaining a block with refCnt=0 which is disallowed.</span> |
| <span class="source-line-no">158</span><span id="line-158"> cacheable.retain();</span> |
| <span class="source-line-no">159</span><span id="line-159"> return cacheable;</span> |
| <span class="source-line-no">160</span><span id="line-160"> });</span> |
| <span class="source-line-no">161</span><span id="line-161"> if (value == null) {</span> |
| <span class="source-line-no">162</span><span id="line-162"> if (repeat) {</span> |
| <span class="source-line-no">163</span><span id="line-163"> return null;</span> |
| <span class="source-line-no">164</span><span id="line-164"> }</span> |
| <span class="source-line-no">165</span><span id="line-165"> if (updateCacheMetrics) {</span> |
| <span class="source-line-no">166</span><span id="line-166"> stats.miss(caching, cacheKey.isPrimary(), cacheKey.getBlockType());</span> |
| <span class="source-line-no">167</span><span id="line-167"> }</span> |
| <span class="source-line-no">168</span><span id="line-168"> if (victimCache != null) {</span> |
| <span class="source-line-no">169</span><span id="line-169"> value = victimCache.getBlock(cacheKey, caching, repeat, updateCacheMetrics);</span> |
| <span class="source-line-no">170</span><span id="line-170"> if ((value != null) && caching) {</span> |
| <span class="source-line-no">171</span><span id="line-171"> cacheBlock(cacheKey, value);</span> |
| <span class="source-line-no">172</span><span id="line-172"> }</span> |
| <span class="source-line-no">173</span><span id="line-173"> }</span> |
| <span class="source-line-no">174</span><span id="line-174"> } else if (updateCacheMetrics) {</span> |
| <span class="source-line-no">175</span><span id="line-175"> stats.hit(caching, cacheKey.isPrimary(), cacheKey.getBlockType());</span> |
| <span class="source-line-no">176</span><span id="line-176"> }</span> |
| <span class="source-line-no">177</span><span id="line-177"> return value;</span> |
| <span class="source-line-no">178</span><span id="line-178"> }</span> |
| <span class="source-line-no">179</span><span id="line-179"></span> |
| <span class="source-line-no">180</span><span id="line-180"> @Override</span> |
| <span class="source-line-no">181</span><span id="line-181"> public void cacheBlock(BlockCacheKey cacheKey, Cacheable value, boolean inMemory) {</span> |
| <span class="source-line-no">182</span><span id="line-182"> cacheBlock(cacheKey, value);</span> |
| <span class="source-line-no">183</span><span id="line-183"> }</span> |
| <span class="source-line-no">184</span><span id="line-184"></span> |
| <span class="source-line-no">185</span><span id="line-185"> @Override</span> |
| <span class="source-line-no">186</span><span id="line-186"> public void cacheBlock(BlockCacheKey key, Cacheable value) {</span> |
| <span class="source-line-no">187</span><span id="line-187"> if (value.heapSize() > maxBlockSize) {</span> |
| <span class="source-line-no">188</span><span id="line-188"> // If there are a lot of blocks that are too big this can make the logs too noisy (2% logged)</span> |
| <span class="source-line-no">189</span><span id="line-189"> if (stats.failInsert() % 50 == 0) {</span> |
| <span class="source-line-no">190</span><span id="line-190"> LOG.warn(String.format(</span> |
| <span class="source-line-no">191</span><span id="line-191"> "Trying to cache too large a block %s @ %,d is %,d which is larger than %,d",</span> |
| <span class="source-line-no">192</span><span id="line-192"> key.getHfileName(), key.getOffset(), value.heapSize(), DEFAULT_MAX_BLOCK_SIZE));</span> |
| <span class="source-line-no">193</span><span id="line-193"> }</span> |
| <span class="source-line-no">194</span><span id="line-194"> } else {</span> |
| <span class="source-line-no">195</span><span id="line-195"> value = asReferencedHeapBlock(value);</span> |
| <span class="source-line-no">196</span><span id="line-196"> cache.put(key, value);</span> |
| <span class="source-line-no">197</span><span id="line-197"> }</span> |
| <span class="source-line-no">198</span><span id="line-198"> }</span> |
| <span class="source-line-no">199</span><span id="line-199"></span> |
| <span class="source-line-no">200</span><span id="line-200"> /**</span> |
| <span class="source-line-no">201</span><span id="line-201"> * The block cached in TinyLfuBlockCache will always be an heap block: on the one side, the heap</span> |
| <span class="source-line-no">202</span><span id="line-202"> * access will be more faster then off-heap, the small index block or meta block cached in</span> |
| <span class="source-line-no">203</span><span id="line-203"> * CombinedBlockCache will benefit a lot. on other side, the TinyLfuBlockCache size is always</span> |
| <span class="source-line-no">204</span><span id="line-204"> * calculated based on the total heap size, if caching an off-heap block in TinyLfuBlockCache, the</span> |
| <span class="source-line-no">205</span><span id="line-205"> * heap size will be messed up. Here we will clone the block into an heap block if it's an</span> |
| <span class="source-line-no">206</span><span id="line-206"> * off-heap block, otherwise just use the original block. The key point is maintain the refCnt of</span> |
| <span class="source-line-no">207</span><span id="line-207"> * the block (HBASE-22127): <br></span> |
| <span class="source-line-no">208</span><span id="line-208"> * 1. if cache the cloned heap block, its refCnt is an totally new one, it's easy to handle; <br></span> |
| <span class="source-line-no">209</span><span id="line-209"> * 2. if cache the original heap block, we're sure that it won't be tracked in ByteBuffAllocator's</span> |
| <span class="source-line-no">210</span><span id="line-210"> * reservoir, if both RPC and TinyLfuBlockCache release the block, then it can be garbage</span> |
| <span class="source-line-no">211</span><span id="line-211"> * collected by JVM, so need a retain here.</span> |
| <span class="source-line-no">212</span><span id="line-212"> * @param buf the original block</span> |
| <span class="source-line-no">213</span><span id="line-213"> * @return an block with an heap memory backend.</span> |
| <span class="source-line-no">214</span><span id="line-214"> */</span> |
| <span class="source-line-no">215</span><span id="line-215"> private Cacheable asReferencedHeapBlock(Cacheable buf) {</span> |
| <span class="source-line-no">216</span><span id="line-216"> if (buf instanceof HFileBlock) {</span> |
| <span class="source-line-no">217</span><span id="line-217"> HFileBlock blk = ((HFileBlock) buf);</span> |
| <span class="source-line-no">218</span><span id="line-218"> if (blk.isSharedMem()) {</span> |
| <span class="source-line-no">219</span><span id="line-219"> return HFileBlock.deepCloneOnHeap(blk);</span> |
| <span class="source-line-no">220</span><span id="line-220"> }</span> |
| <span class="source-line-no">221</span><span id="line-221"> }</span> |
| <span class="source-line-no">222</span><span id="line-222"> // The block will be referenced by this TinyLfuBlockCache, so should increase its refCnt here.</span> |
| <span class="source-line-no">223</span><span id="line-223"> return buf.retain();</span> |
| <span class="source-line-no">224</span><span id="line-224"> }</span> |
| <span class="source-line-no">225</span><span id="line-225"></span> |
| <span class="source-line-no">226</span><span id="line-226"> @Override</span> |
| <span class="source-line-no">227</span><span id="line-227"> public boolean evictBlock(BlockCacheKey cacheKey) {</span> |
| <span class="source-line-no">228</span><span id="line-228"> Cacheable value = cache.asMap().remove(cacheKey);</span> |
| <span class="source-line-no">229</span><span id="line-229"> if (value != null) {</span> |
| <span class="source-line-no">230</span><span id="line-230"> value.release();</span> |
| <span class="source-line-no">231</span><span id="line-231"> }</span> |
| <span class="source-line-no">232</span><span id="line-232"> return (value != null);</span> |
| <span class="source-line-no">233</span><span id="line-233"> }</span> |
| <span class="source-line-no">234</span><span id="line-234"></span> |
| <span class="source-line-no">235</span><span id="line-235"> @Override</span> |
| <span class="source-line-no">236</span><span id="line-236"> public int evictBlocksByHfileName(String hfileName) {</span> |
| <span class="source-line-no">237</span><span id="line-237"> int evicted = 0;</span> |
| <span class="source-line-no">238</span><span id="line-238"> for (BlockCacheKey key : cache.asMap().keySet()) {</span> |
| <span class="source-line-no">239</span><span id="line-239"> if (key.getHfileName().equals(hfileName) && evictBlock(key)) {</span> |
| <span class="source-line-no">240</span><span id="line-240"> evicted++;</span> |
| <span class="source-line-no">241</span><span id="line-241"> }</span> |
| <span class="source-line-no">242</span><span id="line-242"> }</span> |
| <span class="source-line-no">243</span><span id="line-243"> if (victimCache != null) {</span> |
| <span class="source-line-no">244</span><span id="line-244"> evicted += victimCache.evictBlocksByHfileName(hfileName);</span> |
| <span class="source-line-no">245</span><span id="line-245"> }</span> |
| <span class="source-line-no">246</span><span id="line-246"> return evicted;</span> |
| <span class="source-line-no">247</span><span id="line-247"> }</span> |
| <span class="source-line-no">248</span><span id="line-248"></span> |
| <span class="source-line-no">249</span><span id="line-249"> @Override</span> |
| <span class="source-line-no">250</span><span id="line-250"> public CacheStats getStats() {</span> |
| <span class="source-line-no">251</span><span id="line-251"> return stats;</span> |
| <span class="source-line-no">252</span><span id="line-252"> }</span> |
| <span class="source-line-no">253</span><span id="line-253"></span> |
| <span class="source-line-no">254</span><span id="line-254"> @Override</span> |
| <span class="source-line-no">255</span><span id="line-255"> public void shutdown() {</span> |
| <span class="source-line-no">256</span><span id="line-256"> if (victimCache != null) {</span> |
| <span class="source-line-no">257</span><span id="line-257"> victimCache.shutdown();</span> |
| <span class="source-line-no">258</span><span id="line-258"> }</span> |
| <span class="source-line-no">259</span><span id="line-259"> statsThreadPool.shutdown();</span> |
| <span class="source-line-no">260</span><span id="line-260"> }</span> |
| <span class="source-line-no">261</span><span id="line-261"></span> |
| <span class="source-line-no">262</span><span id="line-262"> @Override</span> |
| <span class="source-line-no">263</span><span id="line-263"> public BlockCache[] getBlockCaches() {</span> |
| <span class="source-line-no">264</span><span id="line-264"> return null;</span> |
| <span class="source-line-no">265</span><span id="line-265"> }</span> |
| <span class="source-line-no">266</span><span id="line-266"></span> |
| <span class="source-line-no">267</span><span id="line-267"> @Override</span> |
| <span class="source-line-no">268</span><span id="line-268"> public Iterator<CachedBlock> iterator() {</span> |
| <span class="source-line-no">269</span><span id="line-269"> long now = System.nanoTime();</span> |
| <span class="source-line-no">270</span><span id="line-270"> return cache.asMap().entrySet().stream()</span> |
| <span class="source-line-no">271</span><span id="line-271"> .map(entry -> (CachedBlock) new CachedBlockView(entry.getKey(), entry.getValue(), now))</span> |
| <span class="source-line-no">272</span><span id="line-272"> .iterator();</span> |
| <span class="source-line-no">273</span><span id="line-273"> }</span> |
| <span class="source-line-no">274</span><span id="line-274"></span> |
| <span class="source-line-no">275</span><span id="line-275"> private void logStats() {</span> |
| <span class="source-line-no">276</span><span id="line-276"> LOG.info("totalSize=" + StringUtils.byteDesc(heapSize()) + ", " + "freeSize="</span> |
| <span class="source-line-no">277</span><span id="line-277"> + StringUtils.byteDesc(getFreeSize()) + ", " + "max=" + StringUtils.byteDesc(size()) + ", "</span> |
| <span class="source-line-no">278</span><span id="line-278"> + "blockCount=" + getBlockCount() + ", " + "accesses=" + stats.getRequestCount() + ", "</span> |
| <span class="source-line-no">279</span><span id="line-279"> + "hits=" + stats.getHitCount() + ", " + "hitRatio="</span> |
| <span class="source-line-no">280</span><span id="line-280"> + (stats.getHitCount() == 0 ? "0," : StringUtils.formatPercent(stats.getHitRatio(), 2) + ", ")</span> |
| <span class="source-line-no">281</span><span id="line-281"> + "cachingAccesses=" + stats.getRequestCachingCount() + ", " + "cachingHits="</span> |
| <span class="source-line-no">282</span><span id="line-282"> + stats.getHitCachingCount() + ", " + "cachingHitsRatio="</span> |
| <span class="source-line-no">283</span><span id="line-283"> + (stats.getHitCachingCount() == 0</span> |
| <span class="source-line-no">284</span><span id="line-284"> ? "0,"</span> |
| <span class="source-line-no">285</span><span id="line-285"> : (StringUtils.formatPercent(stats.getHitCachingRatio(), 2) + ", "))</span> |
| <span class="source-line-no">286</span><span id="line-286"> + "evictions=" + stats.getEvictionCount() + ", " + "evicted=" + stats.getEvictedCount());</span> |
| <span class="source-line-no">287</span><span id="line-287"> }</span> |
| <span class="source-line-no">288</span><span id="line-288"></span> |
| <span class="source-line-no">289</span><span id="line-289"> @Override</span> |
| <span class="source-line-no">290</span><span id="line-290"> public String toString() {</span> |
| <span class="source-line-no">291</span><span id="line-291"> return MoreObjects.toStringHelper(this).add("blockCount", getBlockCount())</span> |
| <span class="source-line-no">292</span><span id="line-292"> .add("currentSize", getCurrentSize()).add("freeSize", getFreeSize()).add("maxSize", size())</span> |
| <span class="source-line-no">293</span><span id="line-293"> .add("heapSize", heapSize()).add("victimCache", (victimCache != null)).toString();</span> |
| <span class="source-line-no">294</span><span id="line-294"> }</span> |
| <span class="source-line-no">295</span><span id="line-295"></span> |
| <span class="source-line-no">296</span><span id="line-296"> /** A removal listener to asynchronously record evictions and populate the victim cache. */</span> |
| <span class="source-line-no">297</span><span id="line-297"> private final class EvictionListener implements RemovalListener<BlockCacheKey, Cacheable> {</span> |
| <span class="source-line-no">298</span><span id="line-298"></span> |
| <span class="source-line-no">299</span><span id="line-299"> @Override</span> |
| <span class="source-line-no">300</span><span id="line-300"> public void onRemoval(BlockCacheKey key, Cacheable value, RemovalCause cause) {</span> |
| <span class="source-line-no">301</span><span id="line-301"> if (!cause.wasEvicted()) {</span> |
| <span class="source-line-no">302</span><span id="line-302"> // An explicit eviction (invalidation) is not added to the victim cache as the data may</span> |
| <span class="source-line-no">303</span><span id="line-303"> // no longer be valid for subsequent queries.</span> |
| <span class="source-line-no">304</span><span id="line-304"> return;</span> |
| <span class="source-line-no">305</span><span id="line-305"> }</span> |
| <span class="source-line-no">306</span><span id="line-306"></span> |
| <span class="source-line-no">307</span><span id="line-307"> recordEviction();</span> |
| <span class="source-line-no">308</span><span id="line-308"></span> |
| <span class="source-line-no">309</span><span id="line-309"> if (victimCache == null) {</span> |
| <span class="source-line-no">310</span><span id="line-310"> return;</span> |
| <span class="source-line-no">311</span><span id="line-311"> } else if (victimCache instanceof BucketCache) {</span> |
| <span class="source-line-no">312</span><span id="line-312"> BucketCache victimBucketCache = (BucketCache) victimCache;</span> |
| <span class="source-line-no">313</span><span id="line-313"> victimBucketCache.cacheBlockWithWait(key, value, /* inMemory */ true, /* wait */ true);</span> |
| <span class="source-line-no">314</span><span id="line-314"> } else {</span> |
| <span class="source-line-no">315</span><span id="line-315"> victimCache.cacheBlock(key, value);</span> |
| <span class="source-line-no">316</span><span id="line-316"> }</span> |
| <span class="source-line-no">317</span><span id="line-317"> }</span> |
| <span class="source-line-no">318</span><span id="line-318"> }</span> |
| <span class="source-line-no">319</span><span id="line-319"></span> |
| <span class="source-line-no">320</span><span id="line-320"> /**</span> |
| <span class="source-line-no">321</span><span id="line-321"> * Records an eviction. The number of eviction operations and evicted blocks are identical, as an</span> |
| <span class="source-line-no">322</span><span id="line-322"> * eviction is triggered immediately when the capacity has been exceeded. An eviction is performed</span> |
| <span class="source-line-no">323</span><span id="line-323"> * asynchronously. See the library's documentation for details on write buffers, batching, and</span> |
| <span class="source-line-no">324</span><span id="line-324"> * maintenance behavior.</span> |
| <span class="source-line-no">325</span><span id="line-325"> */</span> |
| <span class="source-line-no">326</span><span id="line-326"> private void recordEviction() {</span> |
| <span class="source-line-no">327</span><span id="line-327"> // FIXME: Currently does not capture the insertion time</span> |
| <span class="source-line-no">328</span><span id="line-328"> stats.evicted(Long.MAX_VALUE, true);</span> |
| <span class="source-line-no">329</span><span id="line-329"> stats.evict();</span> |
| <span class="source-line-no">330</span><span id="line-330"> }</span> |
| <span class="source-line-no">331</span><span id="line-331"></span> |
| <span class="source-line-no">332</span><span id="line-332"> private static final class CachedBlockView implements CachedBlock {</span> |
| <span class="source-line-no">333</span><span id="line-333"> private static final Comparator<CachedBlock> COMPARATOR =</span> |
| <span class="source-line-no">334</span><span id="line-334"> Comparator.comparing(CachedBlock::getFilename).thenComparing(CachedBlock::getOffset)</span> |
| <span class="source-line-no">335</span><span id="line-335"> .thenComparing(CachedBlock::getCachedTime);</span> |
| <span class="source-line-no">336</span><span id="line-336"></span> |
| <span class="source-line-no">337</span><span id="line-337"> private final BlockCacheKey key;</span> |
| <span class="source-line-no">338</span><span id="line-338"> private final Cacheable value;</span> |
| <span class="source-line-no">339</span><span id="line-339"> private final long now;</span> |
| <span class="source-line-no">340</span><span id="line-340"></span> |
| <span class="source-line-no">341</span><span id="line-341"> public CachedBlockView(BlockCacheKey key, Cacheable value, long now) {</span> |
| <span class="source-line-no">342</span><span id="line-342"> this.now = now;</span> |
| <span class="source-line-no">343</span><span id="line-343"> this.key = key;</span> |
| <span class="source-line-no">344</span><span id="line-344"> this.value = value;</span> |
| <span class="source-line-no">345</span><span id="line-345"> }</span> |
| <span class="source-line-no">346</span><span id="line-346"></span> |
| <span class="source-line-no">347</span><span id="line-347"> @Override</span> |
| <span class="source-line-no">348</span><span id="line-348"> public BlockPriority getBlockPriority() {</span> |
| <span class="source-line-no">349</span><span id="line-349"> // This does not appear to be used in any meaningful way and is irrelevant to this cache</span> |
| <span class="source-line-no">350</span><span id="line-350"> return BlockPriority.MEMORY;</span> |
| <span class="source-line-no">351</span><span id="line-351"> }</span> |
| <span class="source-line-no">352</span><span id="line-352"></span> |
| <span class="source-line-no">353</span><span id="line-353"> @Override</span> |
| <span class="source-line-no">354</span><span id="line-354"> public BlockType getBlockType() {</span> |
| <span class="source-line-no">355</span><span id="line-355"> return value.getBlockType();</span> |
| <span class="source-line-no">356</span><span id="line-356"> }</span> |
| <span class="source-line-no">357</span><span id="line-357"></span> |
| <span class="source-line-no">358</span><span id="line-358"> @Override</span> |
| <span class="source-line-no">359</span><span id="line-359"> public long getOffset() {</span> |
| <span class="source-line-no">360</span><span id="line-360"> return key.getOffset();</span> |
| <span class="source-line-no">361</span><span id="line-361"> }</span> |
| <span class="source-line-no">362</span><span id="line-362"></span> |
| <span class="source-line-no">363</span><span id="line-363"> @Override</span> |
| <span class="source-line-no">364</span><span id="line-364"> public long getSize() {</span> |
| <span class="source-line-no">365</span><span id="line-365"> return value.heapSize();</span> |
| <span class="source-line-no">366</span><span id="line-366"> }</span> |
| <span class="source-line-no">367</span><span id="line-367"></span> |
| <span class="source-line-no">368</span><span id="line-368"> @Override</span> |
| <span class="source-line-no">369</span><span id="line-369"> public long getCachedTime() {</span> |
| <span class="source-line-no">370</span><span id="line-370"> // This does not appear to be used in any meaningful way, so not captured</span> |
| <span class="source-line-no">371</span><span id="line-371"> return 0L;</span> |
| <span class="source-line-no">372</span><span id="line-372"> }</span> |
| <span class="source-line-no">373</span><span id="line-373"></span> |
| <span class="source-line-no">374</span><span id="line-374"> @Override</span> |
| <span class="source-line-no">375</span><span id="line-375"> public String getFilename() {</span> |
| <span class="source-line-no">376</span><span id="line-376"> return key.getHfileName();</span> |
| <span class="source-line-no">377</span><span id="line-377"> }</span> |
| <span class="source-line-no">378</span><span id="line-378"></span> |
| <span class="source-line-no">379</span><span id="line-379"> @Override</span> |
| <span class="source-line-no">380</span><span id="line-380"> public int compareTo(CachedBlock other) {</span> |
| <span class="source-line-no">381</span><span id="line-381"> return COMPARATOR.compare(this, other);</span> |
| <span class="source-line-no">382</span><span id="line-382"> }</span> |
| <span class="source-line-no">383</span><span id="line-383"></span> |
| <span class="source-line-no">384</span><span id="line-384"> @Override</span> |
| <span class="source-line-no">385</span><span id="line-385"> public boolean equals(Object obj) {</span> |
| <span class="source-line-no">386</span><span id="line-386"> if (obj == this) {</span> |
| <span class="source-line-no">387</span><span id="line-387"> return true;</span> |
| <span class="source-line-no">388</span><span id="line-388"> } else if (!(obj instanceof CachedBlock)) {</span> |
| <span class="source-line-no">389</span><span id="line-389"> return false;</span> |
| <span class="source-line-no">390</span><span id="line-390"> }</span> |
| <span class="source-line-no">391</span><span id="line-391"> CachedBlock other = (CachedBlock) obj;</span> |
| <span class="source-line-no">392</span><span id="line-392"> return compareTo(other) == 0;</span> |
| <span class="source-line-no">393</span><span id="line-393"> }</span> |
| <span class="source-line-no">394</span><span id="line-394"></span> |
| <span class="source-line-no">395</span><span id="line-395"> @Override</span> |
| <span class="source-line-no">396</span><span id="line-396"> public int hashCode() {</span> |
| <span class="source-line-no">397</span><span id="line-397"> return key.hashCode();</span> |
| <span class="source-line-no">398</span><span id="line-398"> }</span> |
| <span class="source-line-no">399</span><span id="line-399"></span> |
| <span class="source-line-no">400</span><span id="line-400"> @Override</span> |
| <span class="source-line-no">401</span><span id="line-401"> public String toString() {</span> |
| <span class="source-line-no">402</span><span id="line-402"> return BlockCacheUtil.toString(this, now);</span> |
| <span class="source-line-no">403</span><span id="line-403"> }</span> |
| <span class="source-line-no">404</span><span id="line-404"> }</span> |
| <span class="source-line-no">405</span><span id="line-405"></span> |
| <span class="source-line-no">406</span><span id="line-406"> @Override</span> |
| <span class="source-line-no">407</span><span id="line-407"> public long getMaxSize() {</span> |
| <span class="source-line-no">408</span><span id="line-408"> return size();</span> |
| <span class="source-line-no">409</span><span id="line-409"> }</span> |
| <span class="source-line-no">410</span><span id="line-410"></span> |
| <span class="source-line-no">411</span><span id="line-411"> @Override</span> |
| <span class="source-line-no">412</span><span id="line-412"> public long getCurrentDataSize() {</span> |
| <span class="source-line-no">413</span><span id="line-413"> return getCurrentSize();</span> |
| <span class="source-line-no">414</span><span id="line-414"> }</span> |
| <span class="source-line-no">415</span><span id="line-415"></span> |
| <span class="source-line-no">416</span><span id="line-416"> @Override</span> |
| <span class="source-line-no">417</span><span id="line-417"> public long getDataBlockCount() {</span> |
| <span class="source-line-no">418</span><span id="line-418"> return getBlockCount();</span> |
| <span class="source-line-no">419</span><span id="line-419"> }</span> |
| <span class="source-line-no">420</span><span id="line-420">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
