You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hbase.apache.org by gi...@apache.org on 2018/03/25 14:49:16 UTC
[02/13] hbase-site git commit: Published site at
3f7222df3699ef11d0782628c8358ad5d0ce108b.
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/545b969c/devapidocs/src-html/org/apache/hadoop/hbase/io/hfile/bucket/BucketCache.html
----------------------------------------------------------------------
diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/io/hfile/bucket/BucketCache.html b/devapidocs/src-html/org/apache/hadoop/hbase/io/hfile/bucket/BucketCache.html
index eecd2f9..e8070ca 100644
--- a/devapidocs/src-html/org/apache/hadoop/hbase/io/hfile/bucket/BucketCache.html
+++ b/devapidocs/src-html/org/apache/hadoop/hbase/io/hfile/bucket/BucketCache.html
@@ -80,1548 +80,1607 @@
<span class="sourceLineNo">072</span>import org.apache.hadoop.hbase.util.HasThread;<a name="line.72"></a>
<span class="sourceLineNo">073</span>import org.apache.hadoop.hbase.util.IdReadWriteLock;<a name="line.73"></a>
<span class="sourceLineNo">074</span>import org.apache.hadoop.hbase.util.IdReadWriteLock.ReferenceType;<a name="line.74"></a>
-<span class="sourceLineNo">075</span>import org.apache.hadoop.util.StringUtils;<a name="line.75"></a>
-<span class="sourceLineNo">076</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.76"></a>
-<span class="sourceLineNo">077</span>import org.slf4j.Logger;<a name="line.77"></a>
-<span class="sourceLineNo">078</span>import org.slf4j.LoggerFactory;<a name="line.78"></a>
-<span class="sourceLineNo">079</span><a name="line.79"></a>
-<span class="sourceLineNo">080</span>import org.apache.hbase.thirdparty.com.google.common.annotations.VisibleForTesting;<a name="line.80"></a>
-<span class="sourceLineNo">081</span>import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;<a name="line.81"></a>
-<span class="sourceLineNo">082</span>import org.apache.hbase.thirdparty.com.google.common.util.concurrent.ThreadFactoryBuilder;<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> * BucketCache uses {@link BucketAllocator} to allocate/free blocks, and uses<a name="line.85"></a>
-<span class="sourceLineNo">086</span> * BucketCache#ramCache and BucketCache#backingMap in order to<a name="line.86"></a>
-<span class="sourceLineNo">087</span> * determine if a given element is in the cache. The bucket cache can use on-heap or<a name="line.87"></a>
-<span class="sourceLineNo">088</span> * off-heap memory {@link ByteBufferIOEngine} or in a file {@link FileIOEngine} to<a name="line.88"></a>
-<span class="sourceLineNo">089</span> * store/read the block data.<a name="line.89"></a>
-<span class="sourceLineNo">090</span> *<a name="line.90"></a>
-<span class="sourceLineNo">091</span> * <p>Eviction is via a similar algorithm as used in<a name="line.91"></a>
-<span class="sourceLineNo">092</span> * {@link org.apache.hadoop.hbase.io.hfile.LruBlockCache}<a name="line.92"></a>
-<span class="sourceLineNo">093</span> *<a name="line.93"></a>
-<span class="sourceLineNo">094</span> * <p>BucketCache can be used as mainly a block cache (see<a name="line.94"></a>
-<span class="sourceLineNo">095</span> * {@link org.apache.hadoop.hbase.io.hfile.CombinedBlockCache}), combined with<a name="line.95"></a>
-<span class="sourceLineNo">096</span> * LruBlockCache to decrease CMS GC and heap fragmentation.<a name="line.96"></a>
-<span class="sourceLineNo">097</span> *<a name="line.97"></a>
-<span class="sourceLineNo">098</span> * <p>It also can be used as a secondary cache (e.g. using a file on ssd/fusionio to store<a name="line.98"></a>
-<span class="sourceLineNo">099</span> * blocks) to enlarge cache space via<a name="line.99"></a>
-<span class="sourceLineNo">100</span> * {@link org.apache.hadoop.hbase.io.hfile.LruBlockCache#setVictimCache}<a name="line.100"></a>
-<span class="sourceLineNo">101</span> */<a name="line.101"></a>
-<span class="sourceLineNo">102</span>@InterfaceAudience.Private<a name="line.102"></a>
-<span class="sourceLineNo">103</span>public class BucketCache implements BlockCache, HeapSize {<a name="line.103"></a>
-<span class="sourceLineNo">104</span> private static final Logger LOG = LoggerFactory.getLogger(BucketCache.class);<a name="line.104"></a>
-<span class="sourceLineNo">105</span><a name="line.105"></a>
-<span class="sourceLineNo">106</span> /** Priority buckets config */<a name="line.106"></a>
-<span class="sourceLineNo">107</span> static final String SINGLE_FACTOR_CONFIG_NAME = "hbase.bucketcache.single.factor";<a name="line.107"></a>
-<span class="sourceLineNo">108</span> static final String MULTI_FACTOR_CONFIG_NAME = "hbase.bucketcache.multi.factor";<a name="line.108"></a>
-<span class="sourceLineNo">109</span> static final String MEMORY_FACTOR_CONFIG_NAME = "hbase.bucketcache.memory.factor";<a name="line.109"></a>
-<span class="sourceLineNo">110</span> static final String EXTRA_FREE_FACTOR_CONFIG_NAME = "hbase.bucketcache.extrafreefactor";<a name="line.110"></a>
-<span class="sourceLineNo">111</span> static final String ACCEPT_FACTOR_CONFIG_NAME = "hbase.bucketcache.acceptfactor";<a name="line.111"></a>
-<span class="sourceLineNo">112</span> static final String MIN_FACTOR_CONFIG_NAME = "hbase.bucketcache.minfactor";<a name="line.112"></a>
-<span class="sourceLineNo">113</span><a name="line.113"></a>
-<span class="sourceLineNo">114</span> /** Priority buckets */<a name="line.114"></a>
-<span class="sourceLineNo">115</span> @VisibleForTesting<a name="line.115"></a>
-<span class="sourceLineNo">116</span> static final float DEFAULT_SINGLE_FACTOR = 0.25f;<a name="line.116"></a>
-<span class="sourceLineNo">117</span> static final float DEFAULT_MULTI_FACTOR = 0.50f;<a name="line.117"></a>
-<span class="sourceLineNo">118</span> static final float DEFAULT_MEMORY_FACTOR = 0.25f;<a name="line.118"></a>
-<span class="sourceLineNo">119</span> static final float DEFAULT_MIN_FACTOR = 0.85f;<a name="line.119"></a>
-<span class="sourceLineNo">120</span><a name="line.120"></a>
-<span class="sourceLineNo">121</span> private static final float DEFAULT_EXTRA_FREE_FACTOR = 0.10f;<a name="line.121"></a>
-<span class="sourceLineNo">122</span> private static final float DEFAULT_ACCEPT_FACTOR = 0.95f;<a name="line.122"></a>
-<span class="sourceLineNo">123</span><a name="line.123"></a>
-<span class="sourceLineNo">124</span> // Number of blocks to clear for each of the bucket size that is full<a name="line.124"></a>
-<span class="sourceLineNo">125</span> private static final int DEFAULT_FREE_ENTIRE_BLOCK_FACTOR = 2;<a name="line.125"></a>
-<span class="sourceLineNo">126</span><a name="line.126"></a>
-<span class="sourceLineNo">127</span> /** Statistics thread */<a name="line.127"></a>
-<span class="sourceLineNo">128</span> private static final int statThreadPeriod = 5 * 60;<a name="line.128"></a>
-<span class="sourceLineNo">129</span><a name="line.129"></a>
-<span class="sourceLineNo">130</span> final static int DEFAULT_WRITER_THREADS = 3;<a name="line.130"></a>
-<span class="sourceLineNo">131</span> final static int DEFAULT_WRITER_QUEUE_ITEMS = 64;<a name="line.131"></a>
-<span class="sourceLineNo">132</span><a name="line.132"></a>
-<span class="sourceLineNo">133</span> // Store/read block data<a name="line.133"></a>
-<span class="sourceLineNo">134</span> final IOEngine ioEngine;<a name="line.134"></a>
-<span class="sourceLineNo">135</span><a name="line.135"></a>
-<span class="sourceLineNo">136</span> // Store the block in this map before writing it to cache<a name="line.136"></a>
-<span class="sourceLineNo">137</span> @VisibleForTesting<a name="line.137"></a>
-<span class="sourceLineNo">138</span> final ConcurrentMap<BlockCacheKey, RAMQueueEntry> ramCache;<a name="line.138"></a>
-<span class="sourceLineNo">139</span> // In this map, store the block's meta data like offset, length<a name="line.139"></a>
-<span class="sourceLineNo">140</span> @VisibleForTesting<a name="line.140"></a>
-<span class="sourceLineNo">141</span> ConcurrentMap<BlockCacheKey, BucketEntry> backingMap;<a name="line.141"></a>
-<span class="sourceLineNo">142</span><a name="line.142"></a>
-<span class="sourceLineNo">143</span> /**<a name="line.143"></a>
-<span class="sourceLineNo">144</span> * Flag if the cache is enabled or not... We shut it off if there are IO<a name="line.144"></a>
-<span class="sourceLineNo">145</span> * errors for some time, so that Bucket IO exceptions/errors don't bring down<a name="line.145"></a>
-<span class="sourceLineNo">146</span> * the HBase server.<a name="line.146"></a>
-<span class="sourceLineNo">147</span> */<a name="line.147"></a>
-<span class="sourceLineNo">148</span> private volatile boolean cacheEnabled;<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> * A list of writer queues. We have a queue per {@link WriterThread} we have running.<a name="line.151"></a>
-<span class="sourceLineNo">152</span> * In other words, the work adding blocks to the BucketCache is divided up amongst the<a name="line.152"></a>
-<span class="sourceLineNo">153</span> * running WriterThreads. Its done by taking hash of the cache key modulo queue count.<a name="line.153"></a>
-<span class="sourceLineNo">154</span> * WriterThread when it runs takes whatever has been recently added and 'drains' the entries<a name="line.154"></a>
-<span class="sourceLineNo">155</span> * to the BucketCache. It then updates the ramCache and backingMap accordingly.<a name="line.155"></a>
-<span class="sourceLineNo">156</span> */<a name="line.156"></a>
-<span class="sourceLineNo">157</span> @VisibleForTesting<a name="line.157"></a>
-<span class="sourceLineNo">158</span> final ArrayList<BlockingQueue<RAMQueueEntry>> writerQueues = new ArrayList<>();<a name="line.158"></a>
-<span class="sourceLineNo">159</span> @VisibleForTesting<a name="line.159"></a>
-<span class="sourceLineNo">160</span> final WriterThread[] writerThreads;<a name="line.160"></a>
-<span class="sourceLineNo">161</span><a name="line.161"></a>
-<span class="sourceLineNo">162</span> /** Volatile boolean to track if free space is in process or not */<a name="line.162"></a>
-<span class="sourceLineNo">163</span> private volatile boolean freeInProgress = false;<a name="line.163"></a>
-<span class="sourceLineNo">164</span> private final Lock freeSpaceLock = new ReentrantLock();<a name="line.164"></a>
-<span class="sourceLineNo">165</span><a name="line.165"></a>
-<span class="sourceLineNo">166</span> private UniqueIndexMap<Integer> deserialiserMap = new UniqueIndexMap<>();<a name="line.166"></a>
-<span class="sourceLineNo">167</span><a name="line.167"></a>
-<span class="sourceLineNo">168</span> private final LongAdder realCacheSize = new LongAdder();<a name="line.168"></a>
-<span class="sourceLineNo">169</span> private final LongAdder heapSize = new LongAdder();<a name="line.169"></a>
-<span class="sourceLineNo">170</span> /** Current number of cached elements */<a name="line.170"></a>
-<span class="sourceLineNo">171</span> private final LongAdder blockNumber = new LongAdder();<a name="line.171"></a>
-<span class="sourceLineNo">172</span><a name="line.172"></a>
-<span class="sourceLineNo">173</span> /** Cache access count (sequential ID) */<a name="line.173"></a>
-<span class="sourceLineNo">174</span> private final AtomicLong accessCount = new AtomicLong();<a name="line.174"></a>
-<span class="sourceLineNo">175</span><a name="line.175"></a>
-<span class="sourceLineNo">176</span> private static final int DEFAULT_CACHE_WAIT_TIME = 50;<a name="line.176"></a>
-<span class="sourceLineNo">177</span> // Used in test now. If the flag is false and the cache speed is very fast,<a name="line.177"></a>
-<span class="sourceLineNo">178</span> // bucket cache will skip some blocks when caching. If the flag is true, we<a name="line.178"></a>
-<span class="sourceLineNo">179</span> // will wait blocks flushed to IOEngine for some time when caching<a name="line.179"></a>
-<span class="sourceLineNo">180</span> boolean wait_when_cache = false;<a name="line.180"></a>
-<span class="sourceLineNo">181</span><a name="line.181"></a>
-<span class="sourceLineNo">182</span> private final BucketCacheStats cacheStats = new BucketCacheStats();<a name="line.182"></a>
-<span class="sourceLineNo">183</span><a name="line.183"></a>
-<span class="sourceLineNo">184</span> private final String persistencePath;<a name="line.184"></a>
-<span class="sourceLineNo">185</span> private final long cacheCapacity;<a name="line.185"></a>
-<span class="sourceLineNo">186</span> /** Approximate block size */<a name="line.186"></a>
-<span class="sourceLineNo">187</span> private final long blockSize;<a name="line.187"></a>
-<span class="sourceLineNo">188</span><a name="line.188"></a>
-<span class="sourceLineNo">189</span> /** Duration of IO errors tolerated before we disable cache, 1 min as default */<a name="line.189"></a>
-<span class="sourceLineNo">190</span> private final int ioErrorsTolerationDuration;<a name="line.190"></a>
-<span class="sourceLineNo">191</span> // 1 min<a name="line.191"></a>
-<span class="sourceLineNo">192</span> public static final int DEFAULT_ERROR_TOLERATION_DURATION = 60 * 1000;<a name="line.192"></a>
-<span class="sourceLineNo">193</span><a name="line.193"></a>
-<span class="sourceLineNo">194</span> // Start time of first IO error when reading or writing IO Engine, it will be<a name="line.194"></a>
-<span class="sourceLineNo">195</span> // reset after a successful read/write.<a name="line.195"></a>
-<span class="sourceLineNo">196</span> private volatile long ioErrorStartTime = -1;<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 ReentrantReadWriteLock to lock on a particular block identified by offset.<a name="line.199"></a>
-<span class="sourceLineNo">200</span> * The purpose of this is to avoid freeing the block which is being read.<a name="line.200"></a>
-<span class="sourceLineNo">201</span> * <p><a name="line.201"></a>
-<span class="sourceLineNo">202</span> * Key set of offsets in BucketCache is limited so soft reference is the best choice here.<a name="line.202"></a>
-<span class="sourceLineNo">203</span> */<a name="line.203"></a>
-<span class="sourceLineNo">204</span> @VisibleForTesting<a name="line.204"></a>
-<span class="sourceLineNo">205</span> final IdReadWriteLock offsetLock = new IdReadWriteLock(ReferenceType.SOFT);<a name="line.205"></a>
-<span class="sourceLineNo">206</span><a name="line.206"></a>
-<span class="sourceLineNo">207</span> private final NavigableSet<BlockCacheKey> blocksByHFile =<a name="line.207"></a>
-<span class="sourceLineNo">208</span> new ConcurrentSkipListSet<>(new Comparator<BlockCacheKey>() {<a name="line.208"></a>
-<span class="sourceLineNo">209</span> @Override<a name="line.209"></a>
-<span class="sourceLineNo">210</span> public int compare(BlockCacheKey a, BlockCacheKey b) {<a name="line.210"></a>
-<span class="sourceLineNo">211</span> int nameComparison = a.getHfileName().compareTo(b.getHfileName());<a name="line.211"></a>
-<span class="sourceLineNo">212</span> if (nameComparison != 0) {<a name="line.212"></a>
-<span class="sourceLineNo">213</span> return nameComparison;<a name="line.213"></a>
-<span class="sourceLineNo">214</span> }<a name="line.214"></a>
-<span class="sourceLineNo">215</span><a name="line.215"></a>
-<span class="sourceLineNo">216</span> if (a.getOffset() == b.getOffset()) {<a name="line.216"></a>
-<span class="sourceLineNo">217</span> return 0;<a name="line.217"></a>
-<span class="sourceLineNo">218</span> } else if (a.getOffset() < b.getOffset()) {<a name="line.218"></a>
-<span class="sourceLineNo">219</span> return -1;<a name="line.219"></a>
-<span class="sourceLineNo">220</span> }<a name="line.220"></a>
-<span class="sourceLineNo">221</span> return 1;<a name="line.221"></a>
-<span class="sourceLineNo">222</span> }<a name="line.222"></a>
-<span class="sourceLineNo">223</span> });<a name="line.223"></a>
-<span class="sourceLineNo">224</span><a name="line.224"></a>
-<span class="sourceLineNo">225</span> /** Statistics thread schedule pool (for heavy debugging, could remove) */<a name="line.225"></a>
-<span class="sourceLineNo">226</span> private final ScheduledExecutorService scheduleThreadPool = Executors.newScheduledThreadPool(1,<a name="line.226"></a>
-<span class="sourceLineNo">227</span> new ThreadFactoryBuilder().setNameFormat("BucketCacheStatsExecutor").setDaemon(true).build());<a name="line.227"></a>
-<span class="sourceLineNo">228</span><a name="line.228"></a>
-<span class="sourceLineNo">229</span> // Allocate or free space for the block<a name="line.229"></a>
-<span class="sourceLineNo">230</span> private BucketAllocator bucketAllocator;<a name="line.230"></a>
-<span class="sourceLineNo">231</span><a name="line.231"></a>
-<span class="sourceLineNo">232</span> /** Acceptable size of cache (no evictions if size < acceptable) */<a name="line.232"></a>
-<span class="sourceLineNo">233</span> private float acceptableFactor;<a name="line.233"></a>
-<span class="sourceLineNo">234</span><a name="line.234"></a>
-<span class="sourceLineNo">235</span> /** Minimum threshold of cache (when evicting, evict until size < min) */<a name="line.235"></a>
-<span class="sourceLineNo">236</span> private float minFactor;<a name="line.236"></a>
-<span class="sourceLineNo">237</span><a name="line.237"></a>
-<span class="sourceLineNo">238</span> /** Free this floating point factor of extra blocks when evicting. For example free the number of blocks requested * (1 + extraFreeFactor) */<a name="line.238"></a>
-<span class="sourceLineNo">239</span> private float extraFreeFactor;<a name="line.239"></a>
-<span class="sourceLineNo">240</span><a name="line.240"></a>
-<span class="sourceLineNo">241</span> /** Single access bucket size */<a name="line.241"></a>
-<span class="sourceLineNo">242</span> private float singleFactor;<a name="line.242"></a>
-<span class="sourceLineNo">243</span><a name="line.243"></a>
-<span class="sourceLineNo">244</span> /** Multiple access bucket size */<a name="line.244"></a>
-<span class="sourceLineNo">245</span> private float multiFactor;<a name="line.245"></a>
-<span class="sourceLineNo">246</span><a name="line.246"></a>
-<span class="sourceLineNo">247</span> /** In-memory bucket size */<a name="line.247"></a>
-<span class="sourceLineNo">248</span> private float memoryFactor;<a name="line.248"></a>
-<span class="sourceLineNo">249</span><a name="line.249"></a>
-<span class="sourceLineNo">250</span> public BucketCache(String ioEngineName, long capacity, int blockSize, int[] bucketSizes,<a name="line.250"></a>
-<span class="sourceLineNo">251</span> int writerThreadNum, int writerQLen, String persistencePath) throws FileNotFoundException,<a name="line.251"></a>
-<span class="sourceLineNo">252</span> IOException {<a name="line.252"></a>
-<span class="sourceLineNo">253</span> this(ioEngineName, capacity, blockSize, bucketSizes, writerThreadNum, writerQLen,<a name="line.253"></a>
-<span class="sourceLineNo">254</span> persistencePath, DEFAULT_ERROR_TOLERATION_DURATION, HBaseConfiguration.create());<a name="line.254"></a>
-<span class="sourceLineNo">255</span> }<a name="line.255"></a>
-<span class="sourceLineNo">256</span><a name="line.256"></a>
-<span class="sourceLineNo">257</span> public BucketCache(String ioEngineName, long capacity, int blockSize, int[] bucketSizes,<a name="line.257"></a>
-<span class="sourceLineNo">258</span> int writerThreadNum, int writerQLen, String persistencePath, int ioErrorsTolerationDuration,<a name="line.258"></a>
-<span class="sourceLineNo">259</span> Configuration conf)<a name="line.259"></a>
-<span class="sourceLineNo">260</span> throws FileNotFoundException, IOException {<a name="line.260"></a>
-<span class="sourceLineNo">261</span> this.ioEngine = getIOEngineFromName(ioEngineName, capacity, persistencePath);<a name="line.261"></a>
-<span class="sourceLineNo">262</span> this.writerThreads = new WriterThread[writerThreadNum];<a name="line.262"></a>
-<span class="sourceLineNo">263</span> long blockNumCapacity = capacity / blockSize;<a name="line.263"></a>
-<span class="sourceLineNo">264</span> if (blockNumCapacity >= Integer.MAX_VALUE) {<a name="line.264"></a>
-<span class="sourceLineNo">265</span> // Enough for about 32TB of cache!<a name="line.265"></a>
-<span class="sourceLineNo">266</span> throw new IllegalArgumentException("Cache capacity is too large, only support 32TB now");<a name="line.266"></a>
-<span class="sourceLineNo">267</span> }<a name="line.267"></a>
-<span class="sourceLineNo">268</span><a name="line.268"></a>
-<span class="sourceLineNo">269</span> this.acceptableFactor = conf.getFloat(ACCEPT_FACTOR_CONFIG_NAME, DEFAULT_ACCEPT_FACTOR);<a name="line.269"></a>
-<span class="sourceLineNo">270</span> this.minFactor = conf.getFloat(MIN_FACTOR_CONFIG_NAME, DEFAULT_MIN_FACTOR);<a name="line.270"></a>
-<span class="sourceLineNo">271</span> this.extraFreeFactor = conf.getFloat(EXTRA_FREE_FACTOR_CONFIG_NAME, DEFAULT_EXTRA_FREE_FACTOR);<a name="line.271"></a>
-<span class="sourceLineNo">272</span> this.singleFactor = conf.getFloat(SINGLE_FACTOR_CONFIG_NAME, DEFAULT_SINGLE_FACTOR);<a name="line.272"></a>
-<span class="sourceLineNo">273</span> this.multiFactor = conf.getFloat(MULTI_FACTOR_CONFIG_NAME, DEFAULT_MULTI_FACTOR);<a name="line.273"></a>
-<span class="sourceLineNo">274</span> this.memoryFactor = conf.getFloat(MEMORY_FACTOR_CONFIG_NAME, DEFAULT_MEMORY_FACTOR);<a name="line.274"></a>
-<span class="sourceLineNo">275</span><a name="line.275"></a>
-<span class="sourceLineNo">276</span> sanityCheckConfigs();<a name="line.276"></a>
-<span class="sourceLineNo">277</span><a name="line.277"></a>
-<span class="sourceLineNo">278</span> LOG.info("Instantiating BucketCache with acceptableFactor: " + acceptableFactor + ", minFactor: " + minFactor +<a name="line.278"></a>
-<span class="sourceLineNo">279</span> ", extraFreeFactor: " + extraFreeFactor + ", singleFactor: " + singleFactor + ", multiFactor: " + multiFactor +<a name="line.279"></a>
-<span class="sourceLineNo">280</span> ", memoryFactor: " + memoryFactor);<a name="line.280"></a>
-<span class="sourceLineNo">281</span><a name="line.281"></a>
-<span class="sourceLineNo">282</span> this.cacheCapacity = capacity;<a name="line.282"></a>
-<span class="sourceLineNo">283</span> this.persistencePath = persistencePath;<a name="line.283"></a>
-<span class="sourceLineNo">284</span> this.blockSize = blockSize;<a name="line.284"></a>
-<span class="sourceLineNo">285</span> this.ioErrorsTolerationDuration = ioErrorsTolerationDuration;<a name="line.285"></a>
-<span class="sourceLineNo">286</span><a name="line.286"></a>
-<span class="sourceLineNo">287</span> bucketAllocator = new BucketAllocator(capacity, bucketSizes);<a name="line.287"></a>
-<span class="sourceLineNo">288</span> for (int i = 0; i < writerThreads.length; ++i) {<a name="line.288"></a>
-<span class="sourceLineNo">289</span> writerQueues.add(new ArrayBlockingQueue<>(writerQLen));<a name="line.289"></a>
-<span class="sourceLineNo">290</span> }<a name="line.290"></a>
-<span class="sourceLineNo">291</span><a name="line.291"></a>
-<span class="sourceLineNo">292</span> assert writerQueues.size() == writerThreads.length;<a name="line.292"></a>
-<span class="sourceLineNo">293</span> this.ramCache = new ConcurrentHashMap<>();<a name="line.293"></a>
-<span class="sourceLineNo">294</span><a name="line.294"></a>
-<span class="sourceLineNo">295</span> this.backingMap = new ConcurrentHashMap<>((int) blockNumCapacity);<a name="line.295"></a>
-<span class="sourceLineNo">296</span><a name="line.296"></a>
-<span class="sourceLineNo">297</span> if (ioEngine.isPersistent() && persistencePath != null) {<a name="line.297"></a>
-<span class="sourceLineNo">298</span> try {<a name="line.298"></a>
-<span class="sourceLineNo">299</span> retrieveFromFile(bucketSizes);<a name="line.299"></a>
-<span class="sourceLineNo">300</span> } catch (IOException ioex) {<a name="line.300"></a>
-<span class="sourceLineNo">301</span> LOG.error("Can't restore from file because of", ioex);<a name="line.301"></a>
-<span class="sourceLineNo">302</span> } catch (ClassNotFoundException cnfe) {<a name="line.302"></a>
-<span class="sourceLineNo">303</span> LOG.error("Can't restore from file in rebuild because can't deserialise",cnfe);<a name="line.303"></a>
-<span class="sourceLineNo">304</span> throw new RuntimeException(cnfe);<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> final String threadName = Thread.currentThread().getName();<a name="line.307"></a>
-<span class="sourceLineNo">308</span> this.cacheEnabled = true;<a name="line.308"></a>
-<span class="sourceLineNo">309</span> for (int i = 0; i < writerThreads.length; ++i) {<a name="line.309"></a>
-<span class="sourceLineNo">310</span> writerThreads[i] = new WriterThread(writerQueues.get(i));<a name="line.310"></a>
-<span class="sourceLineNo">311</span> writerThreads[i].setName(threadName + "-BucketCacheWriter-" + i);<a name="line.311"></a>
-<span class="sourceLineNo">312</span> writerThreads[i].setDaemon(true);<a name="line.312"></a>
-<span class="sourceLineNo">313</span> }<a name="line.313"></a>
-<span class="sourceLineNo">314</span> startWriterThreads();<a name="line.314"></a>
-<span class="sourceLineNo">315</span><a name="line.315"></a>
-<span class="sourceLineNo">316</span> // Run the statistics thread periodically to print the cache statistics log<a name="line.316"></a>
-<span class="sourceLineNo">317</span> // TODO: Add means of turning this off. Bit obnoxious running thread just to make a log<a name="line.317"></a>
-<span class="sourceLineNo">318</span> // every five minutes.<a name="line.318"></a>
-<span class="sourceLineNo">319</span> this.scheduleThreadPool.scheduleAtFixedRate(new StatisticsThread(this),<a name="line.319"></a>
-<span class="sourceLineNo">320</span> statThreadPeriod, statThreadPeriod, TimeUnit.SECONDS);<a name="line.320"></a>
-<span class="sourceLineNo">321</span> LOG.info("Started bucket cache; ioengine=" + ioEngineName +<a name="line.321"></a>
-<span class="sourceLineNo">322</span> ", capacity=" + StringUtils.byteDesc(capacity) +<a name="line.322"></a>
-<span class="sourceLineNo">323</span> ", blockSize=" + StringUtils.byteDesc(blockSize) + ", writerThreadNum=" +<a name="line.323"></a>
-<span class="sourceLineNo">324</span> writerThreadNum + ", writerQLen=" + writerQLen + ", persistencePath=" +<a name="line.324"></a>
-<span class="sourceLineNo">325</span> persistencePath + ", bucketAllocator=" + this.bucketAllocator.getClass().getName());<a name="line.325"></a>
-<span class="sourceLineNo">326</span> }<a name="line.326"></a>
-<span class="sourceLineNo">327</span><a name="line.327"></a>
-<span class="sourceLineNo">328</span> private void sanityCheckConfigs() {<a name="line.328"></a>
-<span class="sourceLineNo">329</span> Preconditions.checkArgument(acceptableFactor <= 1 && acceptableFactor >= 0, ACCEPT_FACTOR_CONFIG_NAME + " must be between 0.0 and 1.0");<a name="line.329"></a>
-<span class="sourceLineNo">330</span> Preconditions.checkArgument(minFactor <= 1 && minFactor >= 0, MIN_FACTOR_CONFIG_NAME + " must be between 0.0 and 1.0");<a name="line.330"></a>
-<span class="sourceLineNo">331</span> Preconditions.checkArgument(minFactor <= acceptableFactor, MIN_FACTOR_CONFIG_NAME + " must be <= " + ACCEPT_FACTOR_CONFIG_NAME);<a name="line.331"></a>
-<span class="sourceLineNo">332</span> Preconditions.checkArgument(extraFreeFactor >= 0, EXTRA_FREE_FACTOR_CONFIG_NAME + " must be greater than 0.0");<a name="line.332"></a>
-<span class="sourceLineNo">333</span> Preconditions.checkArgument(singleFactor <= 1 && singleFactor >= 0, SINGLE_FACTOR_CONFIG_NAME + " must be between 0.0 and 1.0");<a name="line.333"></a>
-<span class="sourceLineNo">334</span> Preconditions.checkArgument(multiFactor <= 1 && multiFactor >= 0, MULTI_FACTOR_CONFIG_NAME + " must be between 0.0 and 1.0");<a name="line.334"></a>
-<span class="sourceLineNo">335</span> Preconditions.checkArgument(memoryFactor <= 1 && memoryFactor >= 0, MEMORY_FACTOR_CONFIG_NAME + " must be between 0.0 and 1.0");<a name="line.335"></a>
-<span class="sourceLineNo">336</span> Preconditions.checkArgument((singleFactor + multiFactor + memoryFactor) == 1, SINGLE_FACTOR_CONFIG_NAME + ", " +<a name="line.336"></a>
-<span class="sourceLineNo">337</span> MULTI_FACTOR_CONFIG_NAME + ", and " + MEMORY_FACTOR_CONFIG_NAME + " segments must add up to 1.0");<a name="line.337"></a>
-<span class="sourceLineNo">338</span> }<a name="line.338"></a>
-<span class="sourceLineNo">339</span><a name="line.339"></a>
-<span class="sourceLineNo">340</span> /**<a name="line.340"></a>
-<span class="sourceLineNo">341</span> * Called by the constructor to start the writer threads. Used by tests that need to override<a name="line.341"></a>
-<span class="sourceLineNo">342</span> * starting the threads.<a name="line.342"></a>
-<span class="sourceLineNo">343</span> */<a name="line.343"></a>
-<span class="sourceLineNo">344</span> @VisibleForTesting<a name="line.344"></a>
-<span class="sourceLineNo">345</span> protected void startWriterThreads() {<a name="line.345"></a>
-<span class="sourceLineNo">346</span> for (WriterThread thread : writerThreads) {<a name="line.346"></a>
-<span class="sourceLineNo">347</span> thread.start();<a name="line.347"></a>
-<span class="sourceLineNo">348</span> }<a name="line.348"></a>
-<span class="sourceLineNo">349</span> }<a name="line.349"></a>
-<span class="sourceLineNo">350</span><a name="line.350"></a>
-<span class="sourceLineNo">351</span> @VisibleForTesting<a name="line.351"></a>
-<span class="sourceLineNo">352</span> boolean isCacheEnabled() {<a name="line.352"></a>
-<span class="sourceLineNo">353</span> return this.cacheEnabled;<a name="line.353"></a>
-<span class="sourceLineNo">354</span> }<a name="line.354"></a>
-<span class="sourceLineNo">355</span><a name="line.355"></a>
-<span class="sourceLineNo">356</span> @Override<a name="line.356"></a>
-<span class="sourceLineNo">357</span> public long getMaxSize() {<a name="line.357"></a>
-<span class="sourceLineNo">358</span> return this.cacheCapacity;<a name="line.358"></a>
-<span class="sourceLineNo">359</span> }<a name="line.359"></a>
-<span class="sourceLineNo">360</span><a name="line.360"></a>
-<span class="sourceLineNo">361</span> public String getIoEngine() {<a name="line.361"></a>
-<span class="sourceLineNo">362</span> return ioEngine.toString();<a name="line.362"></a>
-<span class="sourceLineNo">363</span> }<a name="line.363"></a>
-<span class="sourceLineNo">364</span><a name="line.364"></a>
-<span class="sourceLineNo">365</span> /**<a name="line.365"></a>
-<span class="sourceLineNo">366</span> * Get the IOEngine from the IO engine name<a name="line.366"></a>
-<span class="sourceLineNo">367</span> * @param ioEngineName<a name="line.367"></a>
-<span class="sourceLineNo">368</span> * @param capacity<a name="line.368"></a>
-<span class="sourceLineNo">369</span> * @param persistencePath<a name="line.369"></a>
-<span class="sourceLineNo">370</span> * @return the IOEngine<a name="line.370"></a>
-<span class="sourceLineNo">371</span> * @throws IOException<a name="line.371"></a>
-<span class="sourceLineNo">372</span> */<a name="line.372"></a>
-<span class="sourceLineNo">373</span> private IOEngine getIOEngineFromName(String ioEngineName, long capacity, String persistencePath)<a name="line.373"></a>
-<span class="sourceLineNo">374</span> throws IOException {<a name="line.374"></a>
-<span class="sourceLineNo">375</span> if (ioEngineName.startsWith("file:") || ioEngineName.startsWith("files:")) {<a name="line.375"></a>
-<span class="sourceLineNo">376</span> // In order to make the usage simple, we only need the prefix 'files:' in<a name="line.376"></a>
-<span class="sourceLineNo">377</span> // document whether one or multiple file(s), but also support 'file:' for<a name="line.377"></a>
-<span class="sourceLineNo">378</span> // the compatibility<a name="line.378"></a>
-<span class="sourceLineNo">379</span> String[] filePaths = ioEngineName.substring(ioEngineName.indexOf(":") + 1)<a name="line.379"></a>
-<span class="sourceLineNo">380</span> .split(FileIOEngine.FILE_DELIMITER);<a name="line.380"></a>
-<span class="sourceLineNo">381</span> return new FileIOEngine(capacity, persistencePath != null, filePaths);<a name="line.381"></a>
-<span class="sourceLineNo">382</span> } else if (ioEngineName.startsWith("offheap")) {<a name="line.382"></a>
-<span class="sourceLineNo">383</span> return new ByteBufferIOEngine(capacity);<a name="line.383"></a>
-<span class="sourceLineNo">384</span> } else if (ioEngineName.startsWith("mmap:")) {<a name="line.384"></a>
-<span class="sourceLineNo">385</span> return new FileMmapEngine(ioEngineName.substring(5), capacity);<a name="line.385"></a>
-<span class="sourceLineNo">386</span> } else {<a name="line.386"></a>
-<span class="sourceLineNo">387</span> throw new IllegalArgumentException(<a name="line.387"></a>
-<span class="sourceLineNo">388</span> "Don't understand io engine name for cache- prefix with file:, files:, mmap: or offheap");<a name="line.388"></a>
-<span class="sourceLineNo">389</span> }<a name="line.389"></a>
-<span class="sourceLineNo">390</span> }<a name="line.390"></a>
-<span class="sourceLineNo">391</span><a name="line.391"></a>
-<span class="sourceLineNo">392</span> /**<a name="line.392"></a>
-<span class="sourceLineNo">393</span> * Cache the block with the specified name and buffer.<a name="line.393"></a>
-<span class="sourceLineNo">394</span> * @param cacheKey block's cache key<a name="line.394"></a>
-<span class="sourceLineNo">395</span> * @param buf block buffer<a name="line.395"></a>
-<span class="sourceLineNo">396</span> */<a name="line.396"></a>
-<span class="sourceLineNo">397</span> @Override<a name="line.397"></a>
-<span class="sourceLineNo">398</span> public void cacheBlock(BlockCacheKey cacheKey, Cacheable buf) {<a name="line.398"></a>
-<span class="sourceLineNo">399</span> cacheBlock(cacheKey, buf, false);<a name="line.399"></a>
-<span class="sourceLineNo">400</span> }<a name="line.400"></a>
-<span class="sourceLineNo">401</span><a name="line.401"></a>
-<span class="sourceLineNo">402</span> /**<a name="line.402"></a>
-<span class="sourceLineNo">403</span> * Cache the block with the specified name and buffer.<a name="line.403"></a>
-<span class="sourceLineNo">404</span> * @param cacheKey block's cache key<a name="line.404"></a>
-<span class="sourceLineNo">405</span> * @param cachedItem block buffer<a name="line.405"></a>
-<span class="sourceLineNo">406</span> * @param inMemory if block is in-memory<a name="line.406"></a>
-<span class="sourceLineNo">407</span> */<a name="line.407"></a>
-<span class="sourceLineNo">408</span> @Override<a name="line.408"></a>
-<span class="sourceLineNo">409</span> public void cacheBlock(BlockCacheKey cacheKey, Cacheable cachedItem, boolean inMemory) {<a name="line.409"></a>
-<span class="sourceLineNo">410</span> cacheBlockWithWait(cacheKey, cachedItem, inMemory, wait_when_cache);<a name="line.410"></a>
-<span class="sourceLineNo">411</span> }<a name="line.411"></a>
-<span class="sourceLineNo">412</span><a name="line.412"></a>
-<span class="sourceLineNo">413</span> /**<a name="line.413"></a>
-<span class="sourceLineNo">414</span> * Cache the block to ramCache<a name="line.414"></a>
-<span class="sourceLineNo">415</span> * @param cacheKey block's cache key<a name="line.415"></a>
-<span class="sourceLineNo">416</span> * @param cachedItem block buffer<a name="line.416"></a>
-<span class="sourceLineNo">417</span> * @param inMemory if block is in-memory<a name="line.417"></a>
-<span class="sourceLineNo">418</span> * @param wait if true, blocking wait when queue is full<a name="line.418"></a>
-<span class="sourceLineNo">419</span> */<a name="line.419"></a>
-<span class="sourceLineNo">420</span> public void cacheBlockWithWait(BlockCacheKey cacheKey, Cacheable cachedItem, boolean inMemory,<a name="line.420"></a>
-<span class="sourceLineNo">421</span> boolean wait) {<a name="line.421"></a>
-<span class="sourceLineNo">422</span> if (LOG.isTraceEnabled()) LOG.trace("Caching key=" + cacheKey + ", item=" + cachedItem);<a name="line.422"></a>
-<span class="sourceLineNo">423</span> if (!cacheEnabled) {<a name="line.423"></a>
-<span class="sourceLineNo">424</span> return;<a name="line.424"></a>
-<span class="sourceLineNo">425</span> }<a name="line.425"></a>
-<span class="sourceLineNo">426</span><a name="line.426"></a>
-<span class="sourceLineNo">427</span> if (backingMap.containsKey(cacheKey)) {<a name="line.427"></a>
-<span class="sourceLineNo">428</span> Cacheable existingBlock = getBlock(cacheKey, false, false, false);<a name="line.428"></a>
-<span class="sourceLineNo">429</span> try {<a name="line.429"></a>
-<span class="sourceLineNo">430</span> if (BlockCacheUtil.compareCacheBlock(cachedItem, existingBlock) != 0) {<a name="line.430"></a>
-<span class="sourceLineNo">431</span> throw new RuntimeException("Cached block contents differ, which should not have happened."<a name="line.431"></a>
-<span class="sourceLineNo">432</span> + "cacheKey:" + cacheKey);<a name="line.432"></a>
-<span class="sourceLineNo">433</span> }<a name="line.433"></a>
-<span class="sourceLineNo">434</span> String msg = "Caching an already cached block: " + cacheKey;<a name="line.434"></a>
-<span class="sourceLineNo">435</span> msg += ". This is harmless and can happen in rare cases (see HBASE-8547)";<a name="line.435"></a>
-<span class="sourceLineNo">436</span> LOG.warn(msg);<a name="line.436"></a>
-<span class="sourceLineNo">437</span> } finally {<a name="line.437"></a>
-<span class="sourceLineNo">438</span> // return the block since we need to decrement the count<a name="line.438"></a>
-<span class="sourceLineNo">439</span> returnBlock(cacheKey, existingBlock);<a name="line.439"></a>
-<span class="sourceLineNo">440</span> }<a name="line.440"></a>
-<span class="sourceLineNo">441</span> return;<a name="line.441"></a>
-<span class="sourceLineNo">442</span> }<a name="line.442"></a>
-<span class="sourceLineNo">443</span><a name="line.443"></a>
-<span class="sourceLineNo">444</span> /*<a name="line.444"></a>
-<span class="sourceLineNo">445</span> * Stuff the entry into the RAM cache so it can get drained to the persistent store<a name="line.445"></a>
-<span class="sourceLineNo">446</span> */<a name="line.446"></a>
-<span class="sourceLineNo">447</span> RAMQueueEntry re =<a name="line.447"></a>
-<span class="sourceLineNo">448</span> new RAMQueueEntry(cacheKey, cachedItem, accessCount.incrementAndGet(), inMemory);<a name="line.448"></a>
-<span class="sourceLineNo">449</span> if (ramCache.putIfAbsent(cacheKey, re) != null) {<a name="line.449"></a>
-<span class="sourceLineNo">450</span> return;<a name="line.450"></a>
-<span class="sourceLineNo">451</span> }<a name="line.451"></a>
-<span class="sourceLineNo">452</span> int queueNum = (cacheKey.hashCode() & 0x7FFFFFFF) % writerQueues.size();<a name="line.452"></a>
-<span class="sourceLineNo">453</span> BlockingQueue<RAMQueueEntry> bq = writerQueues.get(queueNum);<a name="line.453"></a>
-<span class="sourceLineNo">454</span> boolean successfulAddition = false;<a name="line.454"></a>
-<span class="sourceLineNo">455</span> if (wait) {<a name="line.455"></a>
-<span class="sourceLineNo">456</span> try {<a name="line.456"></a>
-<span class="sourceLineNo">457</span> successfulAddition = bq.offer(re, DEFAULT_CACHE_WAIT_TIME, TimeUnit.MILLISECONDS);<a name="line.457"></a>
-<span class="sourceLineNo">458</span> } catch (InterruptedException e) {<a name="line.458"></a>
-<span class="sourceLineNo">459</span> Thread.currentThread().interrupt();<a name="line.459"></a>
-<span class="sourceLineNo">460</span> }<a name="line.460"></a>
-<span class="sourceLineNo">461</span> } else {<a name="line.461"></a>
-<span class="sourceLineNo">462</span> successfulAddition = bq.offer(re);<a name="line.462"></a>
-<span class="sourceLineNo">463</span> }<a name="line.463"></a>
-<span class="sourceLineNo">464</span> if (!successfulAddition) {<a name="line.464"></a>
-<span class="sourceLineNo">465</span> ramCache.remove(cacheKey);<a name="line.465"></a>
-<span class="sourceLineNo">466</span> cacheStats.failInsert();<a name="line.466"></a>
-<span class="sourceLineNo">467</span> } else {<a name="line.467"></a>
-<span class="sourceLineNo">468</span> this.blockNumber.increment();<a name="line.468"></a>
-<span class="sourceLineNo">469</span> this.heapSize.add(cachedItem.heapSize());<a name="line.469"></a>
-<span class="sourceLineNo">470</span> blocksByHFile.add(cacheKey);<a name="line.470"></a>
-<span class="sourceLineNo">471</span> }<a name="line.471"></a>
-<span class="sourceLineNo">472</span> }<a name="line.472"></a>
-<span class="sourceLineNo">473</span><a name="line.473"></a>
-<span class="sourceLineNo">474</span> /**<a name="line.474"></a>
-<span class="sourceLineNo">475</span> * Get the buffer of the block with the specified key.<a name="line.475"></a>
-<span class="sourceLineNo">476</span> * @param key block's cache key<a name="line.476"></a>
-<span class="sourceLineNo">477</span> * @param caching true if the caller caches blocks on cache misses<a name="line.477"></a>
-<span class="sourceLineNo">478</span> * @param repeat Whether this is a repeat lookup for the same block<a name="line.478"></a>
-<span class="sourceLineNo">479</span> * @param updateCacheMetrics Whether we should update cache metrics or not<a name="line.479"></a>
-<span class="sourceLineNo">480</span> * @return buffer of specified cache key, or null if not in cache<a name="line.480"></a>
-<span class="sourceLineNo">481</span> */<a name="line.481"></a>
-<span class="sourceLineNo">482</span> @Override<a name="line.482"></a>
-<span class="sourceLineNo">483</span> public Cacheable getBlock(BlockCacheKey key, boolean caching, boolean repeat,<a name="line.483"></a>
-<span class="sourceLineNo">484</span> boolean updateCacheMetrics) {<a name="line.484"></a>
-<span class="sourceLineNo">485</span> if (!cacheEnabled) {<a name="line.485"></a>
-<span class="sourceLineNo">486</span> return null;<a name="line.486"></a>
-<span class="sourceLineNo">487</span> }<a name="line.487"></a>
-<span class="sourceLineNo">488</span> RAMQueueEntry re = ramCache.get(key);<a name="line.488"></a>
-<span class="sourceLineNo">489</span> if (re != null) {<a name="line.489"></a>
-<span class="sourceLineNo">490</span> if (updateCacheMetrics) {<a name="line.490"></a>
-<span class="sourceLineNo">491</span> cacheStats.hit(caching, key.isPrimary(), key.getBlockType());<a name="line.491"></a>
-<span class="sourceLineNo">492</span> }<a name="line.492"></a>
-<span class="sourceLineNo">493</span> re.access(accessCount.incrementAndGet());<a name="line.493"></a>
-<span class="sourceLineNo">494</span> return re.getData();<a name="line.494"></a>
-<span class="sourceLineNo">495</span> }<a name="line.495"></a>
-<span class="sourceLineNo">496</span> BucketEntry bucketEntry = backingMap.get(key);<a name="line.496"></a>
-<span class="sourceLineNo">497</span> if (bucketEntry != null) {<a name="line.497"></a>
-<span class="sourceLineNo">498</span> long start = System.nanoTime();<a name="line.498"></a>
-<span class="sourceLineNo">499</span> ReentrantReadWriteLock lock = offsetLock.getLock(bucketEntry.offset());<a name="line.499"></a>
-<span class="sourceLineNo">500</span> try {<a name="line.500"></a>
-<span class="sourceLineNo">501</span> lock.readLock().lock();<a name="line.501"></a>
-<span class="sourceLineNo">502</span> // We can not read here even if backingMap does contain the given key because its offset<a name="line.502"></a>
-<span class="sourceLineNo">503</span> // maybe changed. If we lock BlockCacheKey instead of offset, then we can only check<a name="line.503"></a>
-<span class="sourceLineNo">504</span> // existence here.<a name="line.504"></a>
-<span class="sourceLineNo">505</span> if (bucketEntry.equals(backingMap.get(key))) {<a name="line.505"></a>
-<span class="sourceLineNo">506</span> // TODO : change this area - should be removed after server cells and<a name="line.506"></a>
-<span class="sourceLineNo">507</span> // 12295 are available<a name="line.507"></a>
-<span class="sourceLineNo">508</span> int len = bucketEntry.getLength();<a name="line.508"></a>
-<span class="sourceLineNo">509</span> if (LOG.isTraceEnabled()) {<a name="line.509"></a>
-<span class="sourceLineNo">510</span> LOG.trace("Read offset=" + bucketEntry.offset() + ", len=" + len);<a name="line.510"></a>
-<span class="sourceLineNo">511</span> }<a name="line.511"></a>
-<span class="sourceLineNo">512</span> Cacheable cachedBlock = ioEngine.read(bucketEntry.offset(), len,<a name="line.512"></a>
-<span class="sourceLineNo">513</span> bucketEntry.deserializerReference(this.deserialiserMap));<a name="line.513"></a>
-<span class="sourceLineNo">514</span> long timeTaken = System.nanoTime() - start;<a name="line.514"></a>
-<span class="sourceLineNo">515</span> if (updateCacheMetrics) {<a name="line.515"></a>
-<span class="sourceLineNo">516</span> cacheStats.hit(caching, key.isPrimary(), key.getBlockType());<a name="line.516"></a>
-<span class="sourceLineNo">517</span> cacheStats.ioHit(timeTaken);<a name="line.517"></a>
-<span class="sourceLineNo">518</span> }<a name="line.518"></a>
-<span class="sourceLineNo">519</span> if (cachedBlock.getMemoryType() == MemoryType.SHARED) {<a name="line.519"></a>
-<span class="sourceLineNo">520</span> bucketEntry.refCount.incrementAndGet();<a name="line.520"></a>
-<span class="sourceLineNo">521</span> }<a name="line.521"></a>
-<span class="sourceLineNo">522</span> bucketEntry.access(accessCount.incrementAndGet());<a name="line.522"></a>
-<span class="sourceLineNo">523</span> if (this.ioErrorStartTime > 0) {<a name="line.523"></a>
-<span class="sourceLineNo">524</span> ioErrorStartTime = -1;<a name="line.524"></a>
-<span class="sourceLineNo">525</span> }<a name="line.525"></a>
-<span class="sourceLineNo">526</span> return cachedBlock;<a name="line.526"></a>
-<span class="sourceLineNo">527</span> }<a name="line.527"></a>
-<span class="sourceLineNo">528</span> } catch (IOException ioex) {<a name="line.528"></a>
-<span class="sourceLineNo">529</span> LOG.error("Failed reading block " + key + " from bucket cache", ioex);<a name="line.529"></a>
-<span class="sourceLineNo">530</span> checkIOErrorIsTolerated();<a name="line.530"></a>
-<span class="sourceLineNo">531</span> } finally {<a name="line.531"></a>
-<span class="sourceLineNo">532</span> lock.readLock().unlock();<a name="line.532"></a>
-<span class="sourceLineNo">533</span> }<a name="line.533"></a>
-<span class="sourceLineNo">534</span> }<a name="line.534"></a>
-<span class="sourceLineNo">535</span> if (!repeat && updateCacheMetrics) {<a name="line.535"></a>
-<span class="sourceLineNo">536</span> cacheStats.miss(caching, key.isPrimary(), key.getBlockType());<a name="line.536"></a>
-<span class="sourceLineNo">537</span> }<a name="line.537"></a>
-<span class="sourceLineNo">538</span> return null;<a name="line.538"></a>
-<span class="sourceLineNo">539</span> }<a name="line.539"></a>
-<span class="sourceLineNo">540</span><a name="line.540"></a>
-<span class="sourceLineNo">541</span> @VisibleForTesting<a name="line.541"></a>
-<span class="sourceLineNo">542</span> void blockEvicted(BlockCacheKey cacheKey, BucketEntry bucketEntry, boolean decrementBlockNumber) {<a name="line.542"></a>
-<span class="sourceLineNo">543</span> bucketAllocator.freeBlock(bucketEntry.offset());<a name="line.543"></a>
-<span class="sourceLineNo">544</span> realCacheSize.add(-1 * bucketEntry.getLength());<a name="line.544"></a>
-<span class="sourceLineNo">545</span> blocksByHFile.remove(cacheKey);<a name="line.545"></a>
-<span class="sourceLineNo">546</span> if (decrementBlockNumber) {<a name="line.546"></a>
-<span class="sourceLineNo">547</span> this.blockNumber.decrement();<a name="line.547"></a>
-<span class="sourceLineNo">548</span> }<a name="line.548"></a>
-<span class="sourceLineNo">549</span> }<a name="line.549"></a>
-<span class="sourceLineNo">550</span><a name="line.550"></a>
-<span class="sourceLineNo">551</span> @Override<a name="line.551"></a>
-<span class="sourceLineNo">552</span> public boolean evictBlock(BlockCacheKey cacheKey) {<a name="line.552"></a>
-<span class="sourceLineNo">553</span> return evictBlock(cacheKey, true);<a name="line.553"></a>
-<span class="sourceLineNo">554</span> }<a name="line.554"></a>
-<span class="sourceLineNo">555</span><a name="line.555"></a>
-<span class="sourceLineNo">556</span> // does not check for the ref count. Just tries to evict it if found in the<a name="line.556"></a>
-<span class="sourceLineNo">557</span> // bucket map<a name="line.557"></a>
-<span class="sourceLineNo">558</span> private boolean forceEvict(BlockCacheKey cacheKey) {<a name="line.558"></a>
-<span class="sourceLineNo">559</span> if (!cacheEnabled) {<a name="line.559"></a>
-<span class="sourceLineNo">560</span> return false;<a name="line.560"></a>
-<span class="sourceLineNo">561</span> }<a name="line.561"></a>
-<span class="sourceLineNo">562</span> RAMQueueEntry removedBlock = checkRamCache(cacheKey);<a name="line.562"></a>
-<span class="sourceLineNo">563</span> BucketEntry bucketEntry = backingMap.get(cacheKey);<a name="line.563"></a>
-<span class="sourceLineNo">564</span> if (bucketEntry == null) {<a name="line.564"></a>
-<span class="sourceLineNo">565</span> if (removedBlock != null) {<a name="line.565"></a>
-<span class="sourceLineNo">566</span> cacheStats.evicted(0, cacheKey.isPrimary());<a name="line.566"></a>
-<span class="sourceLineNo">567</span> return true;<a name="line.567"></a>
-<span class="sourceLineNo">568</span> } else {<a name="line.568"></a>
-<span class="sourceLineNo">569</span> return false;<a name="line.569"></a>
-<span class="sourceLineNo">570</span> }<a name="line.570"></a>
-<span class="sourceLineNo">571</span> }<a name="line.571"></a>
-<span class="sourceLineNo">572</span> ReentrantReadWriteLock lock = offsetLock.getLock(bucketEntry.offset());<a name="line.572"></a>
-<span class="sourceLineNo">573</span> try {<a name="line.573"></a>
-<span class="sourceLineNo">574</span> lock.writeLock().lock();<a name="line.574"></a>
-<span class="sourceLineNo">575</span> if (backingMap.remove(cacheKey, bucketEntry)) {<a name="line.575"></a>
-<span class="sourceLineNo">576</span> blockEvicted(cacheKey, bucketEntry, removedBlock == null);<a name="line.576"></a>
-<span class="sourceLineNo">577</span> } else {<a name="line.577"></a>
-<span class="sourceLineNo">578</span> return false;<a name="line.578"></a>
-<span class="sourceLineNo">579</span> }<a name="line.579"></a>
-<span class="sourceLineNo">580</span> } finally {<a name="line.580"></a>
-<span class="sourceLineNo">581</span> lock.writeLock().unlock();<a name="line.581"></a>
-<span class="sourceLineNo">582</span> }<a name="line.582"></a>
-<span class="sourceLineNo">583</span> cacheStats.evicted(bucketEntry.getCachedTime(), cacheKey.isPrimary());<a name="line.583"></a>
-<span class="sourceLineNo">584</span> return true;<a name="line.584"></a>
-<span class="sourceLineNo">585</span> }<a name="line.585"></a>
-<span class="sourceLineNo">586</span><a name="line.586"></a>
-<span class="sourceLineNo">587</span> private RAMQueueEntry checkRamCache(BlockCacheKey cacheKey) {<a name="line.587"></a>
-<span class="sourceLineNo">588</span> RAMQueueEntry removedBlock = ramCache.remove(cacheKey);<a name="line.588"></a>
-<span class="sourceLineNo">589</span> if (removedBlock != null) {<a name="line.589"></a>
-<span class="sourceLineNo">590</span> this.blockNumber.decrement();<a name="line.590"></a>
-<span class="sourceLineNo">591</span> this.heapSize.add(-1 * removedBlock.getData().heapSize());<a name="line.591"></a>
-<span class="sourceLineNo">592</span> }<a name="line.592"></a>
-<span class="sourceLineNo">593</span> return removedBlock;<a name="line.593"></a>
-<span class="sourceLineNo">594</span> }<a name="line.594"></a>
-<span class="sourceLineNo">595</span><a name="line.595"></a>
-<span class="sourceLineNo">596</span> public boolean evictBlock(BlockCacheKey cacheKey, boolean deletedBlock) {<a name="line.596"></a>
-<span class="sourceLineNo">597</span> if (!cacheEnabled) {<a name="line.597"></a>
-<span class="sourceLineNo">598</span> return false;<a name="line.598"></a>
-<span class="sourceLineNo">599</span> }<a name="line.599"></a>
-<span class="sourceLineNo">600</span> RAMQueueEntry removedBlock = checkRamCache(cacheKey);<a name="line.600"></a>
-<span class="sourceLineNo">601</span> BucketEntry bucketEntry = backingMap.get(cacheKey);<a name="line.601"></a>
-<span class="sourceLineNo">602</span> if (bucketEntry == null) {<a name="line.602"></a>
-<span class="sourceLineNo">603</span> if (removedBlock != null) {<a name="line.603"></a>
-<span class="sourceLineNo">604</span> cacheStats.evicted(0, cacheKey.isPrimary());<a name="line.604"></a>
-<span class="sourceLineNo">605</span> return true;<a name="line.605"></a>
-<span class="sourceLineNo">606</span> } else {<a name="line.606"></a>
-<span class="sourceLineNo">607</span> return false;<a name="line.607"></a>
-<span class="sourceLineNo">608</span> }<a name="line.608"></a>
-<span class="sourceLineNo">609</span> }<a name="line.609"></a>
-<span class="sourceLineNo">610</span> ReentrantReadWriteLock lock = offsetLock.getLock(bucketEntry.offset());<a name="line.610"></a>
-<span class="sourceLineNo">611</span> try {<a name="line.611"></a>
-<span class="sourceLineNo">612</span> lock.writeLock().lock();<a name="line.612"></a>
-<span class="sourceLineNo">613</span> int refCount = bucketEntry.refCount.get();<a name="line.613"></a>
-<span class="sourceLineNo">614</span> if(refCount == 0) {<a name="line.614"></a>
-<span class="sourceLineNo">615</span> if (backingMap.remove(cacheKey, bucketEntry)) {<a name="line.615"></a>
-<span class="sourceLineNo">616</span> blockEvicted(cacheKey, bucketEntry, removedBlock == null);<a name="line.616"></a>
-<span class="sourceLineNo">617</span> } else {<a name="line.617"></a>
-<span class="sourceLineNo">618</span> return false;<a name="line.618"></a>
-<span class="sourceLineNo">619</span> }<a name="line.619"></a>
-<span class="sourceLineNo">620</span> } else {<a name="line.620"></a>
-<span class="sourceLineNo">621</span> if(!deletedBlock) {<a name="line.621"></a>
-<span class="sourceLineNo">622</span> if (LOG.isDebugEnabled()) {<a name="line.622"></a>
-<span class="sourceLineNo">623</span> LOG.debug("This block " + cacheKey + " is still referred by " + refCount<a name="line.623"></a>
-<span class="sourceLineNo">624</span> + " readers. Can not be freed now");<a name="line.624"></a>
-<span class="sourceLineNo">625</span> }<a name="line.625"></a>
-<span class="sourceLineNo">626</span> return false;<a name="line.626"></a>
-<span class="sourceLineNo">627</span> } else {<a name="line.627"></a>
-<span class="sourceLineNo">628</span> if (LOG.isDebugEnabled()) {<a name="line.628"></a>
-<span class="sourceLineNo">629</span> LOG.debug("This block " + cacheKey + " is still referred by " + refCount<a name="line.629"></a>
-<span class="sourceLineNo">630</span> + " readers. Can not be freed now. Hence will mark this"<a name="line.630"></a>
-<span class="sourceLineNo">631</span> + " for evicting at a later point");<a name="line.631"></a>
-<span class="sourceLineNo">632</span> }<a name="line.632"></a>
-<span class="sourceLineNo">633</span> bucketEntry.markedForEvict = true;<a name="line.633"></a>
-<span class="sourceLineNo">634</span> }<a name="line.634"></a>
-<span class="sourceLineNo">635</span> }<a name="line.635"></a>
-<span class="sourceLineNo">636</span> } finally {<a name="line.636"></a>
-<span class="sourceLineNo">637</span> lock.writeLock().unlock();<a name="line.637"></a>
-<span class="sourceLineNo">638</span> }<a name="line.638"></a>
-<span class="sourceLineNo">639</span> cacheStats.evicted(bucketEntry.getCachedTime(), cacheKey.isPrimary());<a name="line.639"></a>
-<span class="sourceLineNo">640</span> return true;<a name="line.640"></a>
-<span class="sourceLineNo">641</span> }<a name="line.641"></a>
-<span class="sourceLineNo">642</span><a name="line.642"></a>
-<span class="sourceLineNo">643</span> /*<a name="line.643"></a>
-<span class="sourceLineNo">644</span> * Statistics thread. Periodically output cache statistics to the log.<a name="line.644"></a>
-<span class="sourceLineNo">645</span> */<a name="line.645"></a>
-<span class="sourceLineNo">646</span> private static class StatisticsThread extends Thread {<a name="line.646"></a>
-<span class="sourceLineNo">647</span> private final BucketCache bucketCache;<a name="line.647"></a>
-<span class="sourceLineNo">648</span><a name="line.648"></a>
-<span class="sourceLineNo">649</span> public StatisticsThread(BucketCache bucketCache) {<a name="line.649"></a>
-<span class="sourceLineNo">650</span> super("BucketCacheStatsThread");<a name="line.650"></a>
-<span class="sourceLineNo">651</span> setDaemon(true);<a name="line.651"></a>
-<span class="sourceLineNo">652</span> this.bucketCache = bucketCache;<a name="line.652"></a>
-<span class="sourceLineNo">653</span> }<a name="line.653"></a>
-<span class="sourceLineNo">654</span><a name="line.654"></a>
-<span class="sourceLineNo">655</span> @Override<a name="line.655"></a>
-<span class="sourceLineNo">656</span> public void run() {<a name="line.656"></a>
-<span class="sourceLineNo">657</span> bucketCache.logStats();<a name="line.657"></a>
-<span class="sourceLineNo">658</span> }<a name="line.658"></a>
-<span class="sourceLineNo">659</span> }<a name="line.659"></a>
-<span class="sourceLineNo">660</span><a name="line.660"></a>
-<span class="sourceLineNo">661</span> public void logStats() {<a name="line.661"></a>
-<span class="sourceLineNo">662</span> long totalSize = bucketAllocator.getTotalSize();<a name="line.662"></a>
-<span class="sourceLineNo">663</span> long usedSize = bucketAllocator.getUsedSize();<a name="line.663"></a>
-<span class="sourceLineNo">664</span> long freeSize = totalSize - usedSize;<a name="line.664"></a>
-<span class="sourceLineNo">665</span> long cacheSize = getRealCacheSize();<a name="line.665"></a>
-<span class="sourceLineNo">666</span> LOG.info("failedBlockAdditions=" + cacheStats.getFailedInserts() + ", " +<a name="line.666"></a>
-<span class="sourceLineNo">667</span> "totalSize=" + StringUtils.byteDesc(totalSize) + ", " +<a name="line.667"></a>
-<span class="sourceLineNo">668</span> "freeSize=" + StringUtils.byteDesc(freeSize) + ", " +<a name="line.668"></a>
-<span class="sourceLineNo">669</span> "usedSize=" + StringUtils.byteDesc(usedSize) +", " +<a name="line.669"></a>
-<span class="sourceLineNo">670</span> "cacheSize=" + StringUtils.byteDesc(cacheSize) +", " +<a name="line.670"></a>
-<span class="sourceLineNo">671</span> "accesses=" + cacheStats.getRequestCount() + ", " +<a name="line.671"></a>
-<span class="sourceLineNo">672</span> "hits=" + cacheStats.getHitCount() + ", " +<a name="line.672"></a>
-<span class="sourceLineNo">673</span> "IOhitsPerSecond=" + cacheStats.getIOHitsPerSecond() + ", " +<a name="line.673"></a>
-<span class="sourceLineNo">674</span> "IOTimePerHit=" + String.format("%.2f", cacheStats.getIOTimePerHit())+ ", " +<a name="line.674"></a>
-<span class="sourceLineNo">675</span> "hitRatio=" + (cacheStats.getHitCount() == 0 ? "0," :<a name="line.675"></a>
-<span class="sourceLineNo">676</span> (StringUtils.formatPercent(cacheStats.getHitRatio(), 2)+ ", ")) +<a name="line.676"></a>
-<span class="sourceLineNo">677</span> "cachingAccesses=" + cacheStats.getRequestCachingCount() + ", " +<a name="line.677"></a>
-<span class="sourceLineNo">678</span> "cachingHits=" + cacheStats.getHitCachingCount() + ", " +<a name="line.678"></a>
-<span class="sourceLineNo">679</span> "cachingHitsRatio=" +(cacheStats.getHitCachingCount() == 0 ? "0," :<a name="line.679"></a>
-<span class="sourceLineNo">680</span> (StringUtils.formatPercent(cacheStats.getHitCachingRatio(), 2)+ ", ")) +<a name="line.680"></a>
-<span class="sourceLineNo">681</span> "evictions=" + cacheStats.getEvictionCount() + ", " +<a name="line.681"></a>
-<span class="sourceLineNo">682</span> "evicted=" + cacheStats.getEvictedCount() + ", " +<a name="line.682"></a>
-<span class="sourceLineNo">683</span> "evictedPerRun=" + cacheStats.evictedPerEviction());<a name="line.683"></a>
-<span class="sourceLineNo">684</span> cacheStats.reset();<a name="line.684"></a>
-<span class="sourceLineNo">685</span> }<a name="line.685"></a>
-<span class="sourceLineNo">686</span><a name="line.686"></a>
-<span class="sourceLineNo">687</span> public long getRealCacheSize() {<a name="line.687"></a>
-<span class="sourceLineNo">688</span> return this.realCacheSize.sum();<a name="line.688"></a>
-<span class="sourceLineNo">689</span> }<a name="line.689"></a>
-<span class="sourceLineNo">690</span><a name="line.690"></a>
-<span class="sourceLineNo">691</span> private long acceptableSize() {<a name="line.691"></a>
-<span class="sourceLineNo">692</span> return (long) Math.floor(bucketAllocator.getTotalSize() * acceptableFactor);<a name="line.692"></a>
-<span class="sourceLineNo">693</span> }<a name="line.693"></a>
-<span class="sourceLineNo">694</span><a name="line.694"></a>
-<span class="sourceLineNo">695</span> @VisibleForTesting<a name="line.695"></a>
-<span class="sourceLineNo">696</span> long getPartitionSize(float partitionFactor) {<a name="line.696"></a>
-<span class="sourceLineNo">697</span> return (long) Math.floor(bucketAllocator.getTotalSize() * partitionFactor * minFactor);<a name="line.697"></a>
-<span class="sourceLineNo">698</span> }<a name="line.698"></a>
-<span class="sourceLineNo">699</span><a name="line.699"></a>
-<span class="sourceLineNo">700</span> /**<a name="line.700"></a>
-<span class="sourceLineNo">701</span> * Return the count of bucketSizeinfos still need free space<a name="line.701"></a>
-<span class="sourceLineNo">702</span> */<a name="line.702"></a>
-<span class="sourceLineNo">703</span> private int bucketSizesAboveThresholdCount(float minFactor) {<a name="line.703"></a>
-<span class="sourceLineNo">704</span> BucketAllocator.IndexStatistics[] stats = bucketAllocator.getIndexStatistics();<a name="line.704"></a>
-<span class="sourceLineNo">705</span> int fullCount = 0;<a name="line.705"></a>
-<span class="sourceLineNo">706</span> for (int i = 0; i < stats.length; i++) {<a name="line.706"></a>
-<span class="sourceLineNo">707</span> long freeGoal = (long) Math.floor(stats[i].totalCount() * (1 - minFactor));<a name="line.707"></a>
-<span class="sourceLineNo">708</span> freeGoal = Math.max(freeGoal, 1);<a name="line.708"></a>
-<span class="sourceLineNo">709</span> if (stats[i].freeCount() < freeGoal) {<a name="line.709"></a>
-<span class="sourceLineNo">710</span> fullCount++;<a name="line.710"></a>
-<span class="sourceLineNo">711</span> }<a name="line.711"></a>
-<span class="sourceLineNo">712</span> }<a name="line.712"></a>
-<span class="sourceLineNo">713</span> return fullCount;<a name="line.713"></a>
-<span class="sourceLineNo">714</span> }<a name="line.714"></a>
-<span class="sourceLineNo">715</span><a name="line.715"></a>
-<span class="sourceLineNo">716</span> /**<a name="line.716"></a>
-<span class="sourceLineNo">717</span> * This method will find the buckets that are minimally occupied<a name="line.717"></a>
-<span class="sourceLineNo">718</span> * and are not reference counted and will free them completely<a name="line.718"></a>
-<span class="sourceLineNo">719</span> * without any constraint on the access times of the elements,<a name="line.719"></a>
-<span class="sourceLineNo">720</span> * and as a process will completely free at most the number of buckets<a name="line.720"></a>
-<span class="sourceLineNo">721</span> * passed, sometimes it might not due to changing refCounts<a name="line.721"></a>
-<span class="sourceLineNo">722</span> *<a name="line.722"></a>
-<span class="sourceLineNo">723</span> * @param completelyFreeBucketsNeeded number of buckets to free<a name="line.723"></a>
-<span class="sourceLineNo">724</span> **/<a name="line.724"></a>
-<span class="sourceLineNo">725</span> private void freeEntireBuckets(int completelyFreeBucketsNeeded) {<a name="line.725"></a>
-<span class="sourceLineNo">726</span> if (completelyFreeBucketsNeeded != 0) {<a name="line.726"></a>
-<span class="sourceLineNo">727</span> // First we will build a set where the offsets are reference counted, usually<a name="line.727"></a>
-<span class="sourceLineNo">728</span> // this set is small around O(Handler Count) unless something else is wrong<a name="line.728"></a>
-<span class="sourceLineNo">729</span> Set<Integer> inUseBuckets = new HashSet<Integer>();<a name="line.729"></a>
-<span class="sourceLineNo">730</span> for (BucketEntry entry : backingMap.values()) {<a name="line.730"></a>
-<span class="sourceLineNo">731</span> if (entry.refCount.get() != 0) {<a name="line.731"></a>
-<span class="sourceLineNo">732</span> inUseBuckets.add(bucketAllocator.getBucketIndex(entry.offset()));<a name="line.732"></a>
-<span class="sourceLineNo">733</span> }<a name="line.733"></a>
-<span class="sourceLineNo">734</span> }<a name="line.734"></a>
-<span class="sourceLineNo">735</span><a name="line.735"></a>
-<span class="sourceLineNo">736</span> Set<Integer> candidateBuckets = bucketAllocator.getLeastFilledBuckets(<a name="line.736"></a>
-<span class="sourceLineNo">737</span> inUseBuckets, completelyFreeBucketsNeeded);<a name="line.737"></a>
-<span class="sourceLineNo">738</span> for (Map.Entry<BlockCacheKey, BucketEntry> entry : backingMap.entrySet()) {<a name="line.738"></a>
-<span class="sourceLineNo">739</span> if (candidateBuckets.contains(bucketAllocator<a name="line.739"></a>
-<span class="sourceLineNo">740</span> .getBucketIndex(entry.getValue().offset()))) {<a name="line.740"></a>
-<span class="sourceLineNo">741</span> evictBlock(entry.getKey(), false);<a name="line.741"></a>
-<span class="sourceLineNo">742</span> }<a name="line.742"></a>
-<span class="sourceLineNo">743</span> }<a name="line.743"></a>
-<span class="sourceLineNo">744</span> }<a name="line.744"></a>
-<span class="sourceLineNo">745</span> }<a name="line.745"></a>
-<span class="sourceLineNo">746</span><a name="line.746"></a>
-<span class="sourceLineNo">747</span> /**<a name="line.747"></a>
-<span class="sourceLineNo">748</span> * Free the space if the used size reaches acceptableSize() or one size block<a name="line.748"></a>
-<span class="sourceLineNo">749</span> * couldn't be allocated. When freeing the space, we use the LRU algorithm and<a name="line.749"></a>
-<span class="sourceLineNo">750</span> * ensure there must be some blocks evicted<a name="line.750"></a>
-<span class="sourceLineNo">751</span> * @param why Why we are being called<a name="line.751"></a>
-<span class="sourceLineNo">752</span> */<a name="line.752"></a>
-<span class="sourceLineNo">753</span> private void freeSpace(final String why) {<a name="line.753"></a>
-<span class="sourceLineNo">754</span> // Ensure only one freeSpace progress at a time<a name="line.754"></a>
-<span class="sourceLineNo">755</span> if (!freeSpaceLock.tryLock()) {<a name="line.755"></a>
-<span class="sourceLineNo">756</span> return;<a name="line.756"></a>
-<span class="sourceLineNo">757</span> }<a name="line.757"></a>
-<span class="sourceLineNo">758</span> try {<a name="line.758"></a>
-<span class="sourceLineNo">759</span> freeInProgress = true;<a name="line.759"></a>
-<span class="sourceLineNo">760</span> long bytesToFreeWithoutExtra = 0;<a name="line.760"></a>
-<span class="sourceLineNo">761</span> // Calculate free byte for each bucketSizeinfo<a name="line.761"></a>
-<span class="sourceLineNo">762</span> StringBuilder msgBuffer = LOG.isDebugEnabled()? new StringBuilder(): null;<a name="line.762"></a>
-<span class="sourceLineNo">763</span> BucketAllocator.IndexStatistics[] stats = bucketAllocator.getIndexStatistics();<a name="line.763"></a>
-<span class="sourceLineNo">764</span> long[] bytesToFreeForBucket = new long[stats.length];<a name="line.764"></a>
-<span class="sourceLineNo">765</span> for (int i = 0; i < stats.length; i++) {<a name="line.765"></a>
-<span class="sourceLineNo">766</span> bytesToFreeForBucket[i] = 0;<a name="line.766"></a>
-<span class="sourceLineNo">767</span> long freeGoal = (long) Math.floor(stats[i].totalCount() * (1 - minFactor));<a name="line.767"></a>
-<span class="sourceLineNo">768</span> freeGoal = Math.max(freeGoal, 1);<a name="line.768"></a>
-<span class="sourceLineNo">769</span> if (stats[i].freeCount() < freeGoal) {<a name="line.769"></a>
-<span class="sourceLineNo">770</span> bytesToFreeForBucket[i] = stats[i].itemSize() * (freeGoal - stats[i].freeCount());<a name="line.770"></a>
-<span class="sourceLineNo">771</span> bytesToFreeWithoutExtra += bytesToFreeForBucket[i];<a name="line.771"></a>
-<span class="sourceLineNo">772</span> if (msgBuffer != null) {<a name="line.772"></a>
-<span class="sourceLineNo">773</span> msgBuffer.append("Free for bucketSize(" + stats[i].itemSize() + ")="<a name="line.773"></a>
-<span class="sourceLineNo">774</span> + StringUtils.byteDesc(bytesToFreeForBucket[i]) + ", ");<a name="line.774"></a>
-<span class="sourceLineNo">775</span> }<a name="line.775"></a>
-<span class="sourceLineNo">776</span> }<a name="line.776"></a>
-<span class="sourceLineNo">777</span> }<a name="line.777"></a>
-<span class="sourceLineNo">778</span> if (msgBuffer != null) {<a name="line.778"></a>
-<span class="sourceLineNo">779</span> msgBuffer.append("Free for total=" + StringUtils.byteDesc(bytesToFreeWithoutExtra) + ", ");<a name="line.779"></a>
-<span class="sourceLineNo">780</span> }<a name="line.780"></a>
-<span class="sourceLineNo">781</span><a name="line.781"></a>
-<span class="sourceLineNo">782</span> if (bytesToFreeWithoutExtra <= 0) {<a name="line.782"></a>
-<span class="sourceLineNo">783</span> return;<a name="line.783"></a>
-<span class="sourceLineNo">784</span> }<a name="line.784"></a>
-<span class="sourceLineNo">785</span> long currentSize = bucketAllocator.getUsedSize();<a name="line.785"></a>
-<span class="sourceLineNo">786</span> long totalSize = bucketAllocator.getTotalSize();<a name="line.786"></a>
-<span class="sourceLineNo">787</span> if (LOG.isDebugEnabled() && msgBuffer != null) {<a name="line.787"></a>
-<span class="sourceLineNo">788</span> LOG.debug("Free started because \"" + why + "\"; " + msgBuffer.toString() +<a name="line.788"></a>
-<span class="sourceLineNo">789</span> " of current used=" + StringUtils.byteDesc(currentSize) + ", actual cacheSize=" +<a name="line.789"></a>
-<span class="sourceLineNo">790</span> StringUtils.byteDesc(realCacheSize.sum()) + ", total=" + StringUtils.byteDesc(totalSize));<a name="line.790"></a>
-<span class="sourceLineNo">791</span> }<a name="line.791"></a>
-<span class="sourceLineNo">792</span><a name="line.792"></a>
-<span class="sourceLineNo">793</span> long bytesToFreeWithExtra = (long) Math.floor(bytesToFreeWithoutExtra<a name="line.793"></a>
-<span class="sourceLineNo">794</span> * (1 + extraFreeFactor));<a name="line.794"></a>
-<span class="sourceLineNo">795</span><a name="line.795"></a>
-<span class="sourceLineNo">796</span> // Instantiate priority buckets<a name="line.796"></a>
-<span class="sourceLineNo">797</span> BucketEntryGroup bucketSingle = new BucketEntryGroup(bytesToFreeWithExtra,<a name="line.797"></a>
-<span class="sourceLineNo">798</span> blockSize, getPartitionSize(singleFactor));<a name="line.798"></a>
-<span class="sourceLineNo">799</span> BucketEntryGroup bucketMulti = new BucketEntryGroup(bytesToFreeWithExtra,<a name="line.799"></a>
-<span class="sourceLineNo">800</span> blockSize, getPartitionSize(multiFactor));<a name="line.800"></a>
-<span class="sourceLineNo">801</span> BucketEntryGroup bucketMemory = new BucketEntryGroup(bytesToFreeWithExtra,<a name="line.801"></a>
-<span class="sourceLineNo">802</span> blockSize, getPartitionSize(memoryFactor));<a name="line.802"></a>
-<span class="sourceLineNo">803</span><a name="line.803"></a>
-<span class="sourceLineNo">804</span> // Scan entire map putting bucket entry into appropriate bucket entry<a name="line.804"></a>
-<span class="sourceLineNo">805</span> // group<a name="line.805"></a>
-<span class="sourceLineNo">806</span> for (Map.Entry<BlockCacheKey, BucketEntry> bucketEntryWithKey : backingMap.entrySet()) {<a name="line.806"></a>
-<span class="sourceLineNo">807</span> switch (bucketEntryWithKey.getValue().getPriority()) {<a name="line.807"></a>
-<span class="sourceLineNo">808</span> case SINGLE: {<a name="line.808"></a>
-<span class="sourceLineNo">809</span> bucketSingle.add(bucketEntryWithKey);<a name="line.809"></a>
-<span class="sourceLineNo">810</span> break;<a name="line.810"></a>
-<span class="sourceLineNo">811</span> }<a name="line.811"></a>
-<span class="sourceLineNo">812</span> case MULTI: {<a name="line.812"></a>
-<span class="sourceLineNo">813</span> bucketMulti.add(bucketEntryWithKey);<a name="line.813"></a>
-<span class="sourceLineNo">814</span> break;<a name="line.814"></a>
-<span class="sourceLineNo">815</span> }<a name="line.815"></a>
-<span class="sourceLineNo">816</span> case MEMORY: {<a name="line.816"></a>
-<span class="sourceLineNo">817</span> bucketMemory.add(bucketEntryWithKey);<a name="line.817"></a>
-<span class="sourceLineNo">818</span> break;<a name="line.818"></a>
-<span class="sourceLineNo">819</span> }<a name="line.819"></a>
-<span class="sourceLineNo">820</span> }<a name="line.820"></a>
-<span class="sourceLineNo">821</span> }<a name="line.821"></a>
-<span class="sourceLineNo">822</span><a name="line.822"></a>
-<span class="sourceLineNo">823</span> PriorityQueue<BucketEntryGroup> bucketQueue = new PriorityQueue<>(3,<a name="line.823"></a>
-<span class="sourceLineNo">824</span> Comparator.comparingLong(BucketEntryGroup::overflow));<a name="line.824"></a>
-<span class="sourceLineNo">825</span><a name="line.825"></a>
-<span class="sourceLineNo">826</span> bucketQueue.add(bucketSingle);<a name="line.826"></a>
-<span class="sourceLineNo">827</span> bucketQueue.add(bucketMulti);<a name="line.827"></a>
-<span class="sourceLineNo">828</span> bucketQueue.add(bucketMemory);<a name="line.828"></a>
-<span class="sourceLineNo">829</span><a name="line.829"></a>
-<span class="sourceLineNo">830</span> int remainingBuckets = 3;<a name="line.830"></a>
-<span class="sourceLineNo">831</span> long bytesFreed = 0;<a name="line.831"></a>
-<span class="sourceLineNo">832</span><a name="line.832"></a>
-<span class="sourceLineNo">833</span> BucketEntryGroup bucketGroup;<a name="line.833"></a>
-<span class="sourceLineNo">834</span> while ((bucketGroup = bucketQueue.poll()) != null) {<a name="line.834"></a>
-<span class="sourceLineNo">835</span> long overflow = bucketGroup.overflow();<a name="line.835"></a>
-<span class="sourceLineNo">836</span> if (overflow > 0) {<a name="line.836"></a>
-<span class="sourceLineNo">837</span> long bucketBytesToFree = Math.min(overflow,<a name="line.837"></a>
-<span class="sourceLineNo">838</span> (bytesToFreeWithoutExtra - bytesFreed) / remainingBuckets);<a name="line.838"></a>
-<span class="sourceLineNo">839</span> bytesFreed += bucketGroup.free(bucketBytesToFree);<a name="line.839"></a>
-<span class="sourceLineNo">840</span> }<a name="line.840"></a>
-<span class="sourceLineNo">841</span> remainingBuckets--;<a name="line.841"></a>
-<span class="sourceLineNo">842</span> }<a name="line.842"></a>
-<span class="sourceLineNo">843</span><a name="line.843"></a>
-<span class="sourceLineNo">844</span> // Check and free if there are buckets that still need freeing of space<a name="line.844"></a>
-<span class="sourceLineNo">845</span> if (bucketSizesAboveThresholdCount(minFactor) > 0) {<a name="line.845"></a>
-<span class="sourceLineNo">846</span> bucketQueue.clear();<a name="line.846"></a>
-<span class="sourceLineNo">847</span> remainingBuckets = 3;<a name="line.847"></a>
-<span class="sourceLineNo">848</span><a name="line.848"></a>
-<span class="sourceLineNo">849</span> bucketQueue.add(bucketSingle);<a name="line.849"></a>
-<span class="sourceLineNo">850</span> bucketQueue.add(bucketMulti);<a name="line.850"></a>
-<span class="sourceLineNo">851</span> bucketQueue.add(bucketMemory);<a name="line.851"></a>
-<span class="sourceLineNo">852</span><a name="line.852"></a>
-<span class="sourceLineNo">853</span> while ((bucketGroup = bucketQueue.poll()) != null) {<a name="line.853"></a>
-<span class="sourceLineNo">854</span> long bucketBytesToFree = (bytesToFreeWithExtra - bytesFreed) / remainingBuckets;<a name="line.854"></a>
-<span class="sourceLineNo">855</span> bytesFreed += bucketGroup.free(bucketBytesToFree);<a name="line.855"></a>
-<span class="sourceLineNo">856</span> remainingBuckets--;<a name="line.856"></a>
-<span class="sourceLineNo">857</span> }<a name="line.857"></a>
-<span class="sourceLineNo">858</span> }<a name="line.858"></a>
-<span class="sourceLineNo">859</span><a name="line.859"></a>
-<span class="sourceLineNo">860</span> // Even after the above free we might still need freeing because of the<a name="line.860"></a>
-<span class="sourceLineNo">861</span> // De-fragmentation of the buckets (also called Slab Calcification problem), i.e<a name="line.861"></a>
-<span class="sourceLineNo">862</span> // there might be some buckets where the occupancy is very sparse and thus are not<a name="line.862"></a>
-<span class="sourceLineNo">863</span> // yielding the free for the other bucket sizes, the fix for this to evict some<a name="line.863"></a>
-<span class="sourceLineNo">864</span> // of the buckets, we do this by evicting the buckets that are least fulled<a name="line.864"></a>
-<span class="sourceLineNo">865</span> freeEntireBuckets(DEFAULT_FREE_ENTIRE_BLOCK_FACTOR *<a name="line.865"></a>
-<span class="sourceLineNo">866</span> bucketSizesAboveThresholdCount(1.0f));<a name="line.866"></a>
-<span class="sourceLineNo">867</span><a name="line.867"></a>
-<span class="sourceLineNo">868</span> if (LOG.isDebugEnabled()) {<a name="line.868"></a>
-<span class="sourceLineNo">869</span> long single = bucketSingle.totalSize();<a name="line.869"></a>
-<span class="sourceLineNo">870</span> long multi = bucketMulti.totalSize();<a name="line.870"></a>
-<span class="sourceLineNo">871</span> long memory = bucketMemory.totalSize();<a name="line.871"></a>
-<span class="sourceLineNo">872</span> if (LOG.isDebugEnabled()) {<a name="line.872"></a>
-<span class="sourceLineNo">873</span> LOG.debug("Bucket cache free space completed; " + "freed="<a name="line.873"></a>
-<span class="sourceLineNo">874</span> + StringUtils.byteDesc(bytesFreed) + ", " + "total="<a name="line.874"></a>
-<span class="sourceLineNo">875</span> + StringUtils.byteDesc(totalSize) + ", " + "single="<a name="line.875"></a>
-<span class="sourceLineNo">876</span> + StringUtils.byteDesc(single) + ", " + "multi="<a name="line.876"></a>
-<span class="sourceLineNo">877</span> + StringUtils.byteDesc(multi) + ", " + "memory="<a name="line.877"></a>
-<span class="sourceLineNo">878</span> + StringUtils.byteDesc(memory));<a name="line.878"></a>
-<span class="sourceLineNo">879</span> }<a name="line.879"></a>
-<span class="sourceLineNo">880</span> }<a name="line.880"></a>
-<span class="sourceLineNo">881</span><a name="line.881"></a>
-<span class="sourceLineNo">882</span> } catch (Throwable t) {<a name="line.882"></a>
-<span class="sourceLineNo">883</span> LOG.warn("Failed freeing space", t);<a name="line.883"></a>
-<span class="sourceLineNo">884</span> } finally {<a name="line.884"></a>
-<span class="sourceLineNo">885</span> cacheStats.evict();<a name="line.885"></a>
-<span class="sourceLineNo">886</span> freeInProgress = false;<a name="line.886"></a>
-<span class="sourceLineNo">887</span> freeSpaceLock.unlock();<a name="line.887"></a>
-<span class="sourceLineNo">888</span> }<a name="line.888"></a>
-<span class="sourceLineNo">889</span> }<a name="line.889"></a>
-<span class="sourceLineNo">890</span><a name="line.890"></a>
-<span class="sourceLineNo">891</span> // This handles flushing the RAM cache to IOEngine.<a name="line.891"></a>
-<span class="sourceLineNo">892</span> @VisibleForTesting<a name="line.892"></a>
-<span class="sourceLineNo">893</span> class WriterThread extends HasThread {<a name="line.893"></a>
-<span class="sourceLineNo">894</span> private final BlockingQueue<RAMQueueEntry> inputQueue;<a name="line.894"></a>
-<span class="sourceLineNo">895</span> private volatile boolean writerEnabled = true;<a name="line.895"></a>
-<span class="sourceLineNo">896</span><a name="line.896"></a>
-<span class="sourceLineNo">897</span> WriterThread(BlockingQueue<RAMQueueEntry> queue) {<a name="line.897"></a>
-<span class="sourceLineNo">898</span> super("BucketCacheWriterThread");<a name="line.898"></a>
-<span class="sourceLineNo">899</span> this.inputQueue = queue;<a name="line.899"></a>
-<span class="sourceLineNo">900</span> }<a name="line.900"></a>
-<span class="sourceLineNo">901</span><a name="line.901"></a>
-<span class="sourceLineNo">902</span> // Used for test<a name="line.902"></a>
-<span class="sourceLineNo">903</span> @VisibleForTesting<a name="line.903"></a>
-<span class="sourceLineNo">904</span> void disableWriter() {<a name="line.904"></a>
-<span class="sourceLineNo">905</span> this.writerEnabled = false;<a name="line.905"></a>
-<span class="sourceLineNo">906</span> }<a name="line.906"></a>
-<span class="sourceLineNo">907</span><a name="line.907"></a>
-<span class="sourceLineNo">908</span> @Override<a name="line.908"></a>
-<span class="sourceLineNo">909</span> public void run() {<a name="line.909"></a>
-<span class="sourceLineNo">910</span> List<RAMQueueEntry> entries = new ArrayList<>();<a name="line.910"></a>
-<span class="sourceLineNo">911</span> try {<a name="line.911"></a>
-<span class="sourceLineNo">912</span> while (cacheEnabled && writerEnabled) {<a name="line.912"></a>
-<span class="sourceLineNo">913</span> try {<a name="line.913"></a>
-<span class="sourceLineNo">914</span> try {<a name="line.914"></a>
-<span class="sourceLineNo">915</span> // Blocks<a name="line.915"></a>
-<span class="sourceLineNo">916</span> entries = getRAMQueueEntries(inputQueue, entries);<a name="line.916"></a>
-<span class="sourceLineNo">917</span> } catch (InterruptedException ie) {<a name="line.917"></a>
-<span class="sourceLineNo">918</span> if (!cacheEnabled) break;<a name="line.918"></a>
-<span class="sourceLineNo">919</span> }<a name="line.919"></a>
-<span class="sourceLineNo">920</span> doDrain(entries);<a name="line.920"></a>
-<span class="sourceLineNo">921</span> } catch (Exception ioe) {<a name="line.921"></a>
-<span class="sourceLineNo">922</span> LOG.error("WriterThread encountered error", ioe);<a name="line.922"></a>
-<span class="sourceLineNo">923</span> }<a name="line.923"></a>
-<span class="sourceLineNo">924</span> }<a name="line.924"></a>
-<span class="sourceLineNo">925</span> } catch (Throwable t) {<a name="line.925"></a>
-<span class="sourceLineNo">926</span> LOG.warn("Failed doing drain", t);<a name="line.926"></a>
-<span class="sourceLineNo">927</span> }<a name="line.927"></a>
-<span class="sourceLineNo">928</span> LOG.info(this.getName() + " exiting, cacheEnabled=" + cacheEnabled);<a name="line.928"></a>
-<span class="sourceLineNo">929</span> }<a name="line.929"></a>
-<span class="sourceLineNo">930</span><a name="line.930"></a>
-<span class="sourceLineNo">931</span> /**<a name="line.931"></a>
-<span class="sourceLineNo">932</span> * Flush the entries in ramCache to IOEngine and add bucket entry to backingMap.<a name="line.932"></a>
-<span class="sourceLineNo">933</span> * Process all that are passed in even if failure being sure to remove from ramCache else we'll<a name="line.933"></a>
-<span class="sourceLineNo">934</span> * never undo the references and we'll OOME.<a name="line.934"></a>
-<span class="sourceLineNo">935</span> * @param entries Presumes list passed in here will be processed by this invocation only. No<a name="line.935"></a>
-<span class="sourceLineNo">936</span> * interference expected.<a name="line.936"></a>
-<span class="sourceLineNo">937</span> * @throws InterruptedException<a name="line.937"></a>
-<span class="sourceLineNo">938</span> */<a name="line.938"></a>
-<span class="sourceLineNo">939</span> @VisibleForTesting<a name="line.939"></a>
-<span class="sourceLineNo">940</span> void doDrain(final List<RAMQueueEntry> entries) throws InterruptedException {<a name="line.940"></a>
-<span class="sourceLineNo">941</span> if (entries.isEmpty()) {<a name="line.941"></a>
-<span class="sourceLineNo">942</span> return;<a name="line.942"></a>
-<span class="sourceLineNo">943</span> }<a name="line.943"></a>
-<span class="sourceLineNo">944</span> // This method is a little hard to follow. We run through the passed in entries and for each<a name="line.944"></a>
-<span class="sourceLineNo">945</span> // successful add, we add a non-null BucketEntry to the below bucketEntries. Later we must<a name="line.945"></a>
-<span class="sourceLineNo">946</span> // do cleanup making sure we've cleared ramCache of all entries regardless of whether we<a name="line.946"></a>
-<span class="sourceLineNo">947</span> // successfully added the item to the bucketcache; if we don't do the cleanup, we'll OOME by<a name="line.947"></a>
-<span class="sourceLineNo">948</span> // filling ramCache. We do the clean up by again running through the passed in entries<a name="line.948"></a>
-<span class="sourceLineNo">949</span> // doing extra work when we f
<TRUNCATED>