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