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/12/18 14:57:03 UTC
[16/51] [partial] hbase-site git commit: Published site at
c448604ceb987d113913f0583452b2abce04db0d.
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/4f8b8424/devapidocs/src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html
----------------------------------------------------------------------
diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html b/devapidocs/src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html
index f32b223..6ac9299 100644
--- a/devapidocs/src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html
+++ b/devapidocs/src-html/org/apache/hadoop/hbase/io/hfile/CacheConfig.html
@@ -25,671 +25,358 @@
<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 org.apache.hadoop.hbase.HConstants.BUCKET_CACHE_IOENGINE_KEY;<a name="line.20"></a>
-<span class="sourceLineNo">021</span>import static org.apache.hadoop.hbase.HConstants.BUCKET_CACHE_SIZE_KEY;<a name="line.21"></a>
-<span class="sourceLineNo">022</span><a name="line.22"></a>
-<span class="sourceLineNo">023</span>import java.io.IOException;<a name="line.23"></a>
-<span class="sourceLineNo">024</span><a name="line.24"></a>
-<span class="sourceLineNo">025</span>import org.apache.hadoop.conf.Configuration;<a name="line.25"></a>
-<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.HConstants;<a name="line.26"></a>
-<span class="sourceLineNo">027</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.27"></a>
-<span class="sourceLineNo">028</span>import org.slf4j.Logger;<a name="line.28"></a>
-<span class="sourceLineNo">029</span>import org.slf4j.LoggerFactory;<a name="line.29"></a>
-<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.client.ColumnFamilyDescriptor;<a name="line.30"></a>
-<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.io.hfile.BlockType.BlockCategory;<a name="line.31"></a>
-<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.io.hfile.bucket.BucketCache;<a name="line.32"></a>
-<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.io.util.MemorySizeUtil;<a name="line.33"></a>
-<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.util.ReflectionUtils;<a name="line.34"></a>
-<span class="sourceLineNo">035</span>import org.apache.hadoop.util.StringUtils;<a name="line.35"></a>
-<span class="sourceLineNo">036</span><a name="line.36"></a>
-<span class="sourceLineNo">037</span>import org.apache.hbase.thirdparty.com.google.common.annotations.VisibleForTesting;<a name="line.37"></a>
-<span class="sourceLineNo">038</span><a name="line.38"></a>
-<span class="sourceLineNo">039</span><a name="line.39"></a>
-<span class="sourceLineNo">040</span>/**<a name="line.40"></a>
-<span class="sourceLineNo">041</span> * Stores all of the cache objects and configuration for a single HFile.<a name="line.41"></a>
-<span class="sourceLineNo">042</span> */<a name="line.42"></a>
-<span class="sourceLineNo">043</span>@InterfaceAudience.Private<a name="line.43"></a>
-<span class="sourceLineNo">044</span>public class CacheConfig {<a name="line.44"></a>
-<span class="sourceLineNo">045</span> private static final Logger LOG = LoggerFactory.getLogger(CacheConfig.class.getName());<a name="line.45"></a>
-<span class="sourceLineNo">046</span><a name="line.46"></a>
-<span class="sourceLineNo">047</span><a name="line.47"></a>
-<span class="sourceLineNo">048</span> /**<a name="line.48"></a>
-<span class="sourceLineNo">049</span> * Disabled cache configuration<a name="line.49"></a>
-<span class="sourceLineNo">050</span> */<a name="line.50"></a>
-<span class="sourceLineNo">051</span> public static final CacheConfig DISABLED = new CacheConfig();<a name="line.51"></a>
-<span class="sourceLineNo">052</span><a name="line.52"></a>
-<span class="sourceLineNo">053</span> /**<a name="line.53"></a>
-<span class="sourceLineNo">054</span> * Configuration key to cache data blocks on read. Bloom blocks and index blocks are always be<a name="line.54"></a>
-<span class="sourceLineNo">055</span> * cached if the block cache is enabled.<a name="line.55"></a>
-<span class="sourceLineNo">056</span> */<a name="line.56"></a>
-<span class="sourceLineNo">057</span> public static final String CACHE_DATA_ON_READ_KEY = "hbase.block.data.cacheonread";<a name="line.57"></a>
-<span class="sourceLineNo">058</span><a name="line.58"></a>
-<span class="sourceLineNo">059</span> /**<a name="line.59"></a>
-<span class="sourceLineNo">060</span> * Configuration key to cache data blocks on write. There are separate<a name="line.60"></a>
-<span class="sourceLineNo">061</span> * switches for bloom blocks and non-root index blocks.<a name="line.61"></a>
-<span class="sourceLineNo">062</span> */<a name="line.62"></a>
-<span class="sourceLineNo">063</span> public static final String CACHE_BLOCKS_ON_WRITE_KEY =<a name="line.63"></a>
-<span class="sourceLineNo">064</span> "hbase.rs.cacheblocksonwrite";<a name="line.64"></a>
+<span class="sourceLineNo">020</span>import java.util.Optional;<a name="line.20"></a>
+<span class="sourceLineNo">021</span><a name="line.21"></a>
+<span class="sourceLineNo">022</span>import org.apache.hadoop.conf.Configuration;<a name="line.22"></a>
+<span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.client.ColumnFamilyDescriptor;<a name="line.23"></a>
+<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.io.hfile.BlockType.BlockCategory;<a name="line.24"></a>
+<span class="sourceLineNo">025</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.25"></a>
+<span class="sourceLineNo">026</span>import org.slf4j.Logger;<a name="line.26"></a>
+<span class="sourceLineNo">027</span>import org.slf4j.LoggerFactory;<a name="line.27"></a>
+<span class="sourceLineNo">028</span><a name="line.28"></a>
+<span class="sourceLineNo">029</span>import org.apache.hbase.thirdparty.com.google.common.annotations.VisibleForTesting;<a name="line.29"></a>
+<span class="sourceLineNo">030</span><a name="line.30"></a>
+<span class="sourceLineNo">031</span>/**<a name="line.31"></a>
+<span class="sourceLineNo">032</span> * Stores all of the cache objects and configuration for a single HFile.<a name="line.32"></a>
+<span class="sourceLineNo">033</span> */<a name="line.33"></a>
+<span class="sourceLineNo">034</span>@InterfaceAudience.Private<a name="line.34"></a>
+<span class="sourceLineNo">035</span>public class CacheConfig {<a name="line.35"></a>
+<span class="sourceLineNo">036</span> private static final Logger LOG = LoggerFactory.getLogger(CacheConfig.class.getName());<a name="line.36"></a>
+<span class="sourceLineNo">037</span><a name="line.37"></a>
+<span class="sourceLineNo">038</span> /**<a name="line.38"></a>
+<span class="sourceLineNo">039</span> * Disabled cache configuration<a name="line.39"></a>
+<span class="sourceLineNo">040</span> */<a name="line.40"></a>
+<span class="sourceLineNo">041</span> public static final CacheConfig DISABLED = new CacheConfig();<a name="line.41"></a>
+<span class="sourceLineNo">042</span><a name="line.42"></a>
+<span class="sourceLineNo">043</span> /**<a name="line.43"></a>
+<span class="sourceLineNo">044</span> * Configuration key to cache data blocks on read. Bloom blocks and index blocks are always be<a name="line.44"></a>
+<span class="sourceLineNo">045</span> * cached if the block cache is enabled.<a name="line.45"></a>
+<span class="sourceLineNo">046</span> */<a name="line.46"></a>
+<span class="sourceLineNo">047</span> public static final String CACHE_DATA_ON_READ_KEY = "hbase.block.data.cacheonread";<a name="line.47"></a>
+<span class="sourceLineNo">048</span><a name="line.48"></a>
+<span class="sourceLineNo">049</span> /**<a name="line.49"></a>
+<span class="sourceLineNo">050</span> * Configuration key to cache data blocks on write. There are separate<a name="line.50"></a>
+<span class="sourceLineNo">051</span> * switches for bloom blocks and non-root index blocks.<a name="line.51"></a>
+<span class="sourceLineNo">052</span> */<a name="line.52"></a>
+<span class="sourceLineNo">053</span> public static final String CACHE_BLOCKS_ON_WRITE_KEY = "hbase.rs.cacheblocksonwrite";<a name="line.53"></a>
+<span class="sourceLineNo">054</span><a name="line.54"></a>
+<span class="sourceLineNo">055</span> /**<a name="line.55"></a>
+<span class="sourceLineNo">056</span> * Configuration key to cache leaf and intermediate-level index blocks on<a name="line.56"></a>
+<span class="sourceLineNo">057</span> * write.<a name="line.57"></a>
+<span class="sourceLineNo">058</span> */<a name="line.58"></a>
+<span class="sourceLineNo">059</span> public static final String CACHE_INDEX_BLOCKS_ON_WRITE_KEY = "hfile.block.index.cacheonwrite";<a name="line.59"></a>
+<span class="sourceLineNo">060</span><a name="line.60"></a>
+<span class="sourceLineNo">061</span> /**<a name="line.61"></a>
+<span class="sourceLineNo">062</span> * Configuration key to cache compound bloom filter blocks on write.<a name="line.62"></a>
+<span class="sourceLineNo">063</span> */<a name="line.63"></a>
+<span class="sourceLineNo">064</span> public static final String CACHE_BLOOM_BLOCKS_ON_WRITE_KEY = "hfile.block.bloom.cacheonwrite";<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span> /**<a name="line.66"></a>
-<span class="sourceLineNo">067</span> * Configuration key to cache leaf and intermediate-level index blocks on<a name="line.67"></a>
-<span class="sourceLineNo">068</span> * write.<a name="line.68"></a>
-<span class="sourceLineNo">069</span> */<a name="line.69"></a>
-<span class="sourceLineNo">070</span> public static final String CACHE_INDEX_BLOCKS_ON_WRITE_KEY =<a name="line.70"></a>
-<span class="sourceLineNo">071</span> "hfile.block.index.cacheonwrite";<a name="line.71"></a>
-<span class="sourceLineNo">072</span><a name="line.72"></a>
-<span class="sourceLineNo">073</span> /**<a name="line.73"></a>
-<span class="sourceLineNo">074</span> * Configuration key to cache compound bloom filter blocks on write.<a name="line.74"></a>
-<span class="sourceLineNo">075</span> */<a name="line.75"></a>
-<span class="sourceLineNo">076</span> public static final String CACHE_BLOOM_BLOCKS_ON_WRITE_KEY =<a name="line.76"></a>
-<span class="sourceLineNo">077</span> "hfile.block.bloom.cacheonwrite";<a name="line.77"></a>
-<span class="sourceLineNo">078</span><a name="line.78"></a>
-<span class="sourceLineNo">079</span> /**<a name="line.79"></a>
-<span class="sourceLineNo">080</span> * Configuration key to cache data blocks in compressed and/or encrypted format.<a name="line.80"></a>
-<span class="sourceLineNo">081</span> */<a name="line.81"></a>
-<span class="sourceLineNo">082</span> public static final String CACHE_DATA_BLOCKS_COMPRESSED_KEY =<a name="line.82"></a>
-<span class="sourceLineNo">083</span> "hbase.block.data.cachecompressed";<a name="line.83"></a>
-<span class="sourceLineNo">084</span><a name="line.84"></a>
-<span class="sourceLineNo">085</span> /**<a name="line.85"></a>
-<span class="sourceLineNo">086</span> * Configuration key to evict all blocks of a given file from the block cache<a name="line.86"></a>
-<span class="sourceLineNo">087</span> * when the file is closed.<a name="line.87"></a>
-<span class="sourceLineNo">088</span> */<a name="line.88"></a>
-<span class="sourceLineNo">089</span> public static final String EVICT_BLOCKS_ON_CLOSE_KEY =<a name="line.89"></a>
-<span class="sourceLineNo">090</span> "hbase.rs.evictblocksonclose";<a name="line.90"></a>
-<span class="sourceLineNo">091</span><a name="line.91"></a>
-<span class="sourceLineNo">092</span> /**<a name="line.92"></a>
-<span class="sourceLineNo">093</span> * Configuration keys for Bucket cache<a name="line.93"></a>
-<span class="sourceLineNo">094</span> */<a name="line.94"></a>
-<span class="sourceLineNo">095</span><a name="line.95"></a>
-<span class="sourceLineNo">096</span> /**<a name="line.96"></a>
-<span class="sourceLineNo">097</span> * If the chosen ioengine can persist its state across restarts, the path to the file to persist<a name="line.97"></a>
-<span class="sourceLineNo">098</span> * to. This file is NOT the data file. It is a file into which we will serialize the map of<a name="line.98"></a>
-<span class="sourceLineNo">099</span> * what is in the data file. For example, if you pass the following argument as<a name="line.99"></a>
-<span class="sourceLineNo">100</span> * BUCKET_CACHE_IOENGINE_KEY ("hbase.bucketcache.ioengine"),<a name="line.100"></a>
-<span class="sourceLineNo">101</span> * <code>file:/tmp/bucketcache.data </code>, then we will write the bucketcache data to the file<a name="line.101"></a>
-<span class="sourceLineNo">102</span> * <code>/tmp/bucketcache.data</code> but the metadata on where the data is in the supplied file<a name="line.102"></a>
-<span class="sourceLineNo">103</span> * is an in-memory map that needs to be persisted across restarts. Where to store this<a name="line.103"></a>
-<span class="sourceLineNo">104</span> * in-memory state is what you supply here: e.g. <code>/tmp/bucketcache.map</code>.<a name="line.104"></a>
-<span class="sourceLineNo">105</span> */<a name="line.105"></a>
-<span class="sourceLineNo">106</span> public static final String BUCKET_CACHE_PERSISTENT_PATH_KEY =<a name="line.106"></a>
-<span class="sourceLineNo">107</span> "hbase.bucketcache.persistent.path";<a name="line.107"></a>
-<span class="sourceLineNo">108</span><a name="line.108"></a>
-<span class="sourceLineNo">109</span> public static final String BUCKET_CACHE_WRITER_THREADS_KEY = "hbase.bucketcache.writer.threads";<a name="line.109"></a>
-<span class="sourceLineNo">110</span> public static final String BUCKET_CACHE_WRITER_QUEUE_KEY =<a name="line.110"></a>
-<span class="sourceLineNo">111</span> "hbase.bucketcache.writer.queuelength";<a name="line.111"></a>
-<span class="sourceLineNo">112</span><a name="line.112"></a>
-<span class="sourceLineNo">113</span> /**<a name="line.113"></a>
-<span class="sourceLineNo">114</span> * A comma-delimited array of values for use as bucket sizes.<a name="line.114"></a>
-<span class="sourceLineNo">115</span> */<a name="line.115"></a>
-<span class="sourceLineNo">116</span> public static final String BUCKET_CACHE_BUCKETS_KEY = "hbase.bucketcache.bucket.sizes";<a name="line.116"></a>
-<span class="sourceLineNo">117</span><a name="line.117"></a>
-<span class="sourceLineNo">118</span> /**<a name="line.118"></a>
-<span class="sourceLineNo">119</span> * Defaults for Bucket cache<a name="line.119"></a>
-<span class="sourceLineNo">120</span> */<a name="line.120"></a>
-<span class="sourceLineNo">121</span> public static final int DEFAULT_BUCKET_CACHE_WRITER_THREADS = 3;<a name="line.121"></a>
-<span class="sourceLineNo">122</span> public static final int DEFAULT_BUCKET_CACHE_WRITER_QUEUE = 64;<a name="line.122"></a>
-<span class="sourceLineNo">123</span><a name="line.123"></a>
-<span class="sourceLineNo">124</span> /**<a name="line.124"></a>
-<span class="sourceLineNo">125</span> * Configuration key to prefetch all blocks of a given file into the block cache<a name="line.125"></a>
-<span class="sourceLineNo">126</span> * when the file is opened.<a name="line.126"></a>
-<span class="sourceLineNo">127</span> */<a name="line.127"></a>
-<span class="sourceLineNo">128</span> public static final String PREFETCH_BLOCKS_ON_OPEN_KEY =<a name="line.128"></a>
-<span class="sourceLineNo">129</span> "hbase.rs.prefetchblocksonopen";<a name="line.129"></a>
+<span class="sourceLineNo">067</span> * Configuration key to cache data blocks in compressed and/or encrypted format.<a name="line.67"></a>
+<span class="sourceLineNo">068</span> */<a name="line.68"></a>
+<span class="sourceLineNo">069</span> public static final String CACHE_DATA_BLOCKS_COMPRESSED_KEY = "hbase.block.data.cachecompressed";<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> * Configuration key to evict all blocks of a given file from the block cache<a name="line.72"></a>
+<span class="sourceLineNo">073</span> * when the file is closed.<a name="line.73"></a>
+<span class="sourceLineNo">074</span> */<a name="line.74"></a>
+<span class="sourceLineNo">075</span> public static final String EVICT_BLOCKS_ON_CLOSE_KEY = "hbase.rs.evictblocksonclose";<a name="line.75"></a>
+<span class="sourceLineNo">076</span><a name="line.76"></a>
+<span class="sourceLineNo">077</span> /**<a name="line.77"></a>
+<span class="sourceLineNo">078</span> * Configuration key to prefetch all blocks of a given file into the block cache<a name="line.78"></a>
+<span class="sourceLineNo">079</span> * when the file is opened.<a name="line.79"></a>
+<span class="sourceLineNo">080</span> */<a name="line.80"></a>
+<span class="sourceLineNo">081</span> public static final String PREFETCH_BLOCKS_ON_OPEN_KEY = "hbase.rs.prefetchblocksonopen";<a name="line.81"></a>
+<span class="sourceLineNo">082</span><a name="line.82"></a>
+<span class="sourceLineNo">083</span> public static final String DROP_BEHIND_CACHE_COMPACTION_KEY =<a name="line.83"></a>
+<span class="sourceLineNo">084</span> "hbase.hfile.drop.behind.compaction";<a name="line.84"></a>
+<span class="sourceLineNo">085</span><a name="line.85"></a>
+<span class="sourceLineNo">086</span> // Defaults<a name="line.86"></a>
+<span class="sourceLineNo">087</span> public static final boolean DEFAULT_CACHE_DATA_ON_READ = true;<a name="line.87"></a>
+<span class="sourceLineNo">088</span> public static final boolean DEFAULT_CACHE_DATA_ON_WRITE = false;<a name="line.88"></a>
+<span class="sourceLineNo">089</span> public static final boolean DEFAULT_IN_MEMORY = false;<a name="line.89"></a>
+<span class="sourceLineNo">090</span> public static final boolean DEFAULT_CACHE_INDEXES_ON_WRITE = false;<a name="line.90"></a>
+<span class="sourceLineNo">091</span> public static final boolean DEFAULT_CACHE_BLOOMS_ON_WRITE = false;<a name="line.91"></a>
+<span class="sourceLineNo">092</span> public static final boolean DEFAULT_EVICT_ON_CLOSE = false;<a name="line.92"></a>
+<span class="sourceLineNo">093</span> public static final boolean DEFAULT_CACHE_DATA_COMPRESSED = false;<a name="line.93"></a>
+<span class="sourceLineNo">094</span> public static final boolean DEFAULT_PREFETCH_ON_OPEN = false;<a name="line.94"></a>
+<span class="sourceLineNo">095</span> public static final boolean DROP_BEHIND_CACHE_COMPACTION_DEFAULT = true;<a name="line.95"></a>
+<span class="sourceLineNo">096</span><a name="line.96"></a>
+<span class="sourceLineNo">097</span> /**<a name="line.97"></a>
+<span class="sourceLineNo">098</span> * Whether blocks should be cached on read (default is on if there is a<a name="line.98"></a>
+<span class="sourceLineNo">099</span> * cache but this can be turned off on a per-family or per-request basis).<a name="line.99"></a>
+<span class="sourceLineNo">100</span> * If off we will STILL cache meta blocks; i.e. INDEX and BLOOM types.<a name="line.100"></a>
+<span class="sourceLineNo">101</span> * This cannot be disabled.<a name="line.101"></a>
+<span class="sourceLineNo">102</span> */<a name="line.102"></a>
+<span class="sourceLineNo">103</span> private final boolean cacheDataOnRead;<a name="line.103"></a>
+<span class="sourceLineNo">104</span><a name="line.104"></a>
+<span class="sourceLineNo">105</span> /** Whether blocks should be flagged as in-memory when being cached */<a name="line.105"></a>
+<span class="sourceLineNo">106</span> private final boolean inMemory;<a name="line.106"></a>
+<span class="sourceLineNo">107</span><a name="line.107"></a>
+<span class="sourceLineNo">108</span> /** Whether data blocks should be cached when new files are written */<a name="line.108"></a>
+<span class="sourceLineNo">109</span> private boolean cacheDataOnWrite;<a name="line.109"></a>
+<span class="sourceLineNo">110</span><a name="line.110"></a>
+<span class="sourceLineNo">111</span> /** Whether index blocks should be cached when new files are written */<a name="line.111"></a>
+<span class="sourceLineNo">112</span> private final boolean cacheIndexesOnWrite;<a name="line.112"></a>
+<span class="sourceLineNo">113</span><a name="line.113"></a>
+<span class="sourceLineNo">114</span> /** Whether compound bloom filter blocks should be cached on write */<a name="line.114"></a>
+<span class="sourceLineNo">115</span> private final boolean cacheBloomsOnWrite;<a name="line.115"></a>
+<span class="sourceLineNo">116</span><a name="line.116"></a>
+<span class="sourceLineNo">117</span> /** Whether blocks of a file should be evicted when the file is closed */<a name="line.117"></a>
+<span class="sourceLineNo">118</span> private boolean evictOnClose;<a name="line.118"></a>
+<span class="sourceLineNo">119</span><a name="line.119"></a>
+<span class="sourceLineNo">120</span> /** Whether data blocks should be stored in compressed and/or encrypted form in the cache */<a name="line.120"></a>
+<span class="sourceLineNo">121</span> private final boolean cacheDataCompressed;<a name="line.121"></a>
+<span class="sourceLineNo">122</span><a name="line.122"></a>
+<span class="sourceLineNo">123</span> /** Whether data blocks should be prefetched into the cache */<a name="line.123"></a>
+<span class="sourceLineNo">124</span> private final boolean prefetchOnOpen;<a name="line.124"></a>
+<span class="sourceLineNo">125</span><a name="line.125"></a>
+<span class="sourceLineNo">126</span> private final boolean dropBehindCompaction;<a name="line.126"></a>
+<span class="sourceLineNo">127</span><a name="line.127"></a>
+<span class="sourceLineNo">128</span> // Local reference to the block cache<a name="line.128"></a>
+<span class="sourceLineNo">129</span> private final BlockCache blockCache;<a name="line.129"></a>
<span class="sourceLineNo">130</span><a name="line.130"></a>
<span class="sourceLineNo">131</span> /**<a name="line.131"></a>
-<span class="sourceLineNo">132</span> * The target block size used by blockcache instances. Defaults to<a name="line.132"></a>
-<span class="sourceLineNo">133</span> * {@link HConstants#DEFAULT_BLOCKSIZE}.<a name="line.133"></a>
-<span class="sourceLineNo">134</span> * TODO: this config point is completely wrong, as it's used to determine the<a name="line.134"></a>
-<span class="sourceLineNo">135</span> * target block size of BlockCache instances. Rename.<a name="line.135"></a>
-<span class="sourceLineNo">136</span> */<a name="line.136"></a>
-<span class="sourceLineNo">137</span> public static final String BLOCKCACHE_BLOCKSIZE_KEY = "hbase.offheapcache.minblocksize";<a name="line.137"></a>
-<span class="sourceLineNo">138</span><a name="line.138"></a>
-<span class="sourceLineNo">139</span> private static final String EXTERNAL_BLOCKCACHE_KEY = "hbase.blockcache.use.external";<a name="line.139"></a>
-<span class="sourceLineNo">140</span> private static final boolean EXTERNAL_BLOCKCACHE_DEFAULT = false;<a name="line.140"></a>
-<span class="sourceLineNo">141</span><a name="line.141"></a>
-<span class="sourceLineNo">142</span> private static final String EXTERNAL_BLOCKCACHE_CLASS_KEY = "hbase.blockcache.external.class";<a name="line.142"></a>
-<span class="sourceLineNo">143</span> private static final String DROP_BEHIND_CACHE_COMPACTION_KEY =<a name="line.143"></a>
-<span class="sourceLineNo">144</span> "hbase.hfile.drop.behind.compaction";<a name="line.144"></a>
-<span class="sourceLineNo">145</span> private static final boolean DROP_BEHIND_CACHE_COMPACTION_DEFAULT = true;<a name="line.145"></a>
-<span class="sourceLineNo">146</span><a name="line.146"></a>
-<span class="sourceLineNo">147</span> /**<a name="line.147"></a>
-<span class="sourceLineNo">148</span> * Enum of all built in external block caches.<a name="line.148"></a>
-<span class="sourceLineNo">149</span> * This is used for config.<a name="line.149"></a>
-<span class="sourceLineNo">150</span> */<a name="line.150"></a>
-<span class="sourceLineNo">151</span> private static enum ExternalBlockCaches {<a name="line.151"></a>
-<span class="sourceLineNo">152</span> memcached("org.apache.hadoop.hbase.io.hfile.MemcachedBlockCache");<a name="line.152"></a>
-<span class="sourceLineNo">153</span> // TODO(eclark): Consider more. Redis, etc.<a name="line.153"></a>
-<span class="sourceLineNo">154</span> Class<? extends BlockCache> clazz;<a name="line.154"></a>
-<span class="sourceLineNo">155</span> ExternalBlockCaches(String clazzName) {<a name="line.155"></a>
-<span class="sourceLineNo">156</span> try {<a name="line.156"></a>
-<span class="sourceLineNo">157</span> clazz = (Class<? extends BlockCache>) Class.forName(clazzName);<a name="line.157"></a>
-<span class="sourceLineNo">158</span> } catch (ClassNotFoundException cnef) {<a name="line.158"></a>
-<span class="sourceLineNo">159</span> clazz = null;<a name="line.159"></a>
-<span class="sourceLineNo">160</span> }<a name="line.160"></a>
-<span class="sourceLineNo">161</span> }<a name="line.161"></a>
-<span class="sourceLineNo">162</span> ExternalBlockCaches(Class<? extends BlockCache> clazz) {<a name="line.162"></a>
-<span class="sourceLineNo">163</span> this.clazz = clazz;<a name="line.163"></a>
-<span class="sourceLineNo">164</span> }<a name="line.164"></a>
-<span class="sourceLineNo">165</span> }<a name="line.165"></a>
-<span class="sourceLineNo">166</span><a name="line.166"></a>
-<span class="sourceLineNo">167</span> // Defaults<a name="line.167"></a>
-<span class="sourceLineNo">168</span> public static final boolean DEFAULT_CACHE_DATA_ON_READ = true;<a name="line.168"></a>
-<span class="sourceLineNo">169</span> public static final boolean DEFAULT_CACHE_DATA_ON_WRITE = false;<a name="line.169"></a>
-<span class="sourceLineNo">170</span> public static final boolean DEFAULT_IN_MEMORY = false;<a name="line.170"></a>
-<span class="sourceLineNo">171</span> public static final boolean DEFAULT_CACHE_INDEXES_ON_WRITE = false;<a name="line.171"></a>
-<span class="sourceLineNo">172</span> public static final boolean DEFAULT_CACHE_BLOOMS_ON_WRITE = false;<a name="line.172"></a>
-<span class="sourceLineNo">173</span> public static final boolean DEFAULT_EVICT_ON_CLOSE = false;<a name="line.173"></a>
-<span class="sourceLineNo">174</span> public static final boolean DEFAULT_CACHE_DATA_COMPRESSED = false;<a name="line.174"></a>
-<span class="sourceLineNo">175</span> public static final boolean DEFAULT_PREFETCH_ON_OPEN = false;<a name="line.175"></a>
-<span class="sourceLineNo">176</span><a name="line.176"></a>
-<span class="sourceLineNo">177</span> /** Local reference to the block cache, null if completely disabled */<a name="line.177"></a>
-<span class="sourceLineNo">178</span> private final BlockCache blockCache;<a name="line.178"></a>
-<span class="sourceLineNo">179</span><a name="line.179"></a>
-<span class="sourceLineNo">180</span> /**<a name="line.180"></a>
-<span class="sourceLineNo">181</span> * Whether blocks should be cached on read (default is on if there is a<a name="line.181"></a>
-<span class="sourceLineNo">182</span> * cache but this can be turned off on a per-family or per-request basis).<a name="line.182"></a>
-<span class="sourceLineNo">183</span> * If off we will STILL cache meta blocks; i.e. INDEX and BLOOM types.<a name="line.183"></a>
-<span class="sourceLineNo">184</span> * This cannot be disabled.<a name="line.184"></a>
-<span class="sourceLineNo">185</span> */<a name="line.185"></a>
-<span class="sourceLineNo">186</span> private boolean cacheDataOnRead;<a name="line.186"></a>
-<span class="sourceLineNo">187</span><a name="line.187"></a>
-<span class="sourceLineNo">188</span> /** Whether blocks should be flagged as in-memory when being cached */<a name="line.188"></a>
-<span class="sourceLineNo">189</span> private final boolean inMemory;<a name="line.189"></a>
-<span class="sourceLineNo">190</span><a name="line.190"></a>
-<span class="sourceLineNo">191</span> /** Whether data blocks should be cached when new files are written */<a name="line.191"></a>
-<span class="sourceLineNo">192</span> private boolean cacheDataOnWrite;<a name="line.192"></a>
-<span class="sourceLineNo">193</span><a name="line.193"></a>
-<span class="sourceLineNo">194</span> /** Whether index blocks should be cached when new files are written */<a name="line.194"></a>
-<span class="sourceLineNo">195</span> private final boolean cacheIndexesOnWrite;<a name="line.195"></a>
-<span class="sourceLineNo">196</span><a name="line.196"></a>
-<span class="sourceLineNo">197</span> /** Whether compound bloom filter blocks should be cached on write */<a name="line.197"></a>
-<span class="sourceLineNo">198</span> private final boolean cacheBloomsOnWrite;<a name="line.198"></a>
-<span class="sourceLineNo">199</span><a name="line.199"></a>
-<span class="sourceLineNo">200</span> /** Whether blocks of a file should be evicted when the file is closed */<a name="line.200"></a>
-<span class="sourceLineNo">201</span> private boolean evictOnClose;<a name="line.201"></a>
-<span class="sourceLineNo">202</span><a name="line.202"></a>
-<span class="sourceLineNo">203</span> /** Whether data blocks should be stored in compressed and/or encrypted form in the cache */<a name="line.203"></a>
-<span class="sourceLineNo">204</span> private final boolean cacheDataCompressed;<a name="line.204"></a>
-<span class="sourceLineNo">205</span><a name="line.205"></a>
-<span class="sourceLineNo">206</span> /** Whether data blocks should be prefetched into the cache */<a name="line.206"></a>
-<span class="sourceLineNo">207</span> private final boolean prefetchOnOpen;<a name="line.207"></a>
-<span class="sourceLineNo">208</span><a name="line.208"></a>
-<span class="sourceLineNo">209</span> private final boolean dropBehindCompaction;<a name="line.209"></a>
-<span class="sourceLineNo">210</span><a name="line.210"></a>
-<span class="sourceLineNo">211</span> /**<a name="line.211"></a>
-<span class="sourceLineNo">212</span> * Create a cache configuration using the specified configuration object and<a name="line.212"></a>
-<span class="sourceLineNo">213</span> * family descriptor.<a name="line.213"></a>
-<span class="sourceLineNo">214</span> * @param conf hbase configuration<a name="line.214"></a>
-<span class="sourceLineNo">215</span> * @param family column family configuration<a name="line.215"></a>
-<span class="sourceLineNo">216</span> */<a name="line.216"></a>
-<span class="sourceLineNo">217</span> public CacheConfig(Configuration conf, ColumnFamilyDescriptor family) {<a name="line.217"></a>
-<span class="sourceLineNo">218</span> this(GLOBAL_BLOCK_CACHE_INSTANCE,<a name="line.218"></a>
-<span class="sourceLineNo">219</span> conf.getBoolean(CACHE_DATA_ON_READ_KEY, DEFAULT_CACHE_DATA_ON_READ)<a name="line.219"></a>
-<span class="sourceLineNo">220</span> && family.isBlockCacheEnabled(),<a name="line.220"></a>
-<span class="sourceLineNo">221</span> family.isInMemory(),<a name="line.221"></a>
-<span class="sourceLineNo">222</span> // For the following flags we enable them regardless of per-schema settings<a name="line.222"></a>
-<span class="sourceLineNo">223</span> // if they are enabled in the global configuration.<a name="line.223"></a>
-<span class="sourceLineNo">224</span> conf.getBoolean(CACHE_BLOCKS_ON_WRITE_KEY,<a name="line.224"></a>
-<span class="sourceLineNo">225</span> DEFAULT_CACHE_DATA_ON_WRITE) || family.isCacheDataOnWrite(),<a name="line.225"></a>
-<span class="sourceLineNo">226</span> conf.getBoolean(CACHE_INDEX_BLOCKS_ON_WRITE_KEY,<a name="line.226"></a>
-<span class="sourceLineNo">227</span> DEFAULT_CACHE_INDEXES_ON_WRITE) || family.isCacheIndexesOnWrite(),<a name="line.227"></a>
-<span class="sourceLineNo">228</span> conf.getBoolean(CACHE_BLOOM_BLOCKS_ON_WRITE_KEY,<a name="line.228"></a>
-<span class="sourceLineNo">229</span> DEFAULT_CACHE_BLOOMS_ON_WRITE) || family.isCacheBloomsOnWrite(),<a name="line.229"></a>
-<span class="sourceLineNo">230</span> conf.getBoolean(EVICT_BLOCKS_ON_CLOSE_KEY,<a name="line.230"></a>
-<span class="sourceLineNo">231</span> DEFAULT_EVICT_ON_CLOSE) || family.isEvictBlocksOnClose(),<a name="line.231"></a>
-<span class="sourceLineNo">232</span> conf.getBoolean(CACHE_DATA_BLOCKS_COMPRESSED_KEY, DEFAULT_CACHE_DATA_COMPRESSED),<a name="line.232"></a>
-<span class="sourceLineNo">233</span> conf.getBoolean(PREFETCH_BLOCKS_ON_OPEN_KEY,<a name="line.233"></a>
-<span class="sourceLineNo">234</span> DEFAULT_PREFETCH_ON_OPEN) || family.isPrefetchBlocksOnOpen(),<a name="line.234"></a>
-<span class="sourceLineNo">235</span> conf.getBoolean(DROP_BEHIND_CACHE_COMPACTION_KEY, DROP_BEHIND_CACHE_COMPACTION_DEFAULT)<a name="line.235"></a>
-<span class="sourceLineNo">236</span> );<a name="line.236"></a>
-<span class="sourceLineNo">237</span> LOG.info("Created cacheConfig for " + family.getNameAsString() + ": " + this);<a name="line.237"></a>
-<span class="sourceLineNo">238</span> }<a name="line.238"></a>
-<span class="sourceLineNo">239</span><a name="line.239"></a>
-<span class="sourceLineNo">240</span> /**<a name="line.240"></a>
-<span class="sourceLineNo">241</span> * Create a cache configuration using the specified configuration object and<a name="line.241"></a>
-<span class="sourceLineNo">242</span> * defaults for family level settings. Only use if no column family context. Prefer<a name="line.242"></a>
-<span class="sourceLineNo">243</span> * {@link CacheConfig#CacheConfig(Configuration, ColumnFamilyDescriptor)}<a name="line.243"></a>
-<span class="sourceLineNo">244</span> * @see #CacheConfig(Configuration, ColumnFamilyDescriptor)<a name="line.244"></a>
-<span class="sourceLineNo">245</span> * @param conf hbase configuration<a name="line.245"></a>
-<span class="sourceLineNo">246</span> */<a name="line.246"></a>
-<span class="sourceLineNo">247</span> public CacheConfig(Configuration conf) {<a name="line.247"></a>
-<span class="sourceLineNo">248</span> this(GLOBAL_BLOCK_CACHE_INSTANCE,<a name="line.248"></a>
-<span class="sourceLineNo">249</span> conf.getBoolean(CACHE_DATA_ON_READ_KEY, DEFAULT_CACHE_DATA_ON_READ),<a name="line.249"></a>
-<span class="sourceLineNo">250</span> DEFAULT_IN_MEMORY, // This is a family-level setting so can't be set<a name="line.250"></a>
-<span class="sourceLineNo">251</span> // strictly from conf<a name="line.251"></a>
-<span class="sourceLineNo">252</span> conf.getBoolean(CACHE_BLOCKS_ON_WRITE_KEY, DEFAULT_CACHE_DATA_ON_WRITE),<a name="line.252"></a>
-<span class="sourceLineNo">253</span> conf.getBoolean(CACHE_INDEX_BLOCKS_ON_WRITE_KEY, DEFAULT_CACHE_INDEXES_ON_WRITE),<a name="line.253"></a>
-<span class="sourceLineNo">254</span> conf.getBoolean(CACHE_BLOOM_BLOCKS_ON_WRITE_KEY, DEFAULT_CACHE_BLOOMS_ON_WRITE),<a name="line.254"></a>
-<span class="sourceLineNo">255</span> conf.getBoolean(EVICT_BLOCKS_ON_CLOSE_KEY, DEFAULT_EVICT_ON_CLOSE),<a name="line.255"></a>
-<span class="sourceLineNo">256</span> conf.getBoolean(CACHE_DATA_BLOCKS_COMPRESSED_KEY, DEFAULT_CACHE_DATA_COMPRESSED),<a name="line.256"></a>
-<span class="sourceLineNo">257</span> conf.getBoolean(PREFETCH_BLOCKS_ON_OPEN_KEY, DEFAULT_PREFETCH_ON_OPEN),<a name="line.257"></a>
-<span class="sourceLineNo">258</span> conf.getBoolean(DROP_BEHIND_CACHE_COMPACTION_KEY, DROP_BEHIND_CACHE_COMPACTION_DEFAULT));<a name="line.258"></a>
-<span class="sourceLineNo">259</span> LOG.info("Created cacheConfig: " + this);<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> /**<a name="line.262"></a>
-<span class="sourceLineNo">263</span> * Create a block cache configuration with the specified cache and configuration parameters.<a name="line.263"></a>
-<span class="sourceLineNo">264</span> * @param blockCache reference to block cache, null if completely disabled<a name="line.264"></a>
-<span class="sourceLineNo">265</span> * @param cacheDataOnRead whether DATA blocks should be cached on read (we always cache INDEX<a name="line.265"></a>
-<span class="sourceLineNo">266</span> * blocks and BLOOM blocks; this cannot be disabled).<a name="line.266"></a>
-<span class="sourceLineNo">267</span> * @param inMemory whether blocks should be flagged as in-memory<a name="line.267"></a>
-<span class="sourceLineNo">268</span> * @param cacheDataOnWrite whether data blocks should be cached on write<a name="line.268"></a>
-<span class="sourceLineNo">269</span> * @param cacheIndexesOnWrite whether index blocks should be cached on write<a name="line.269"></a>
-<span class="sourceLineNo">270</span> * @param cacheBloomsOnWrite whether blooms should be cached on write<a name="line.270"></a>
-<span class="sourceLineNo">271</span> * @param evictOnClose whether blocks should be evicted when HFile is closed<a name="line.271"></a>
-<span class="sourceLineNo">272</span> * @param cacheDataCompressed whether to store blocks as compressed in the cache<a name="line.272"></a>
-<span class="sourceLineNo">273</span> * @param prefetchOnOpen whether to prefetch blocks upon open<a name="line.273"></a>
-<span class="sourceLineNo">274</span> * @param dropBehindCompaction indicate that we should set drop behind to true when open a store<a name="line.274"></a>
-<span class="sourceLineNo">275</span> * file reader for compaction<a name="line.275"></a>
-<span class="sourceLineNo">276</span> */<a name="line.276"></a>
-<span class="sourceLineNo">277</span> @VisibleForTesting<a name="line.277"></a>
-<span class="sourceLineNo">278</span> CacheConfig(final BlockCache blockCache,<a name="line.278"></a>
-<span class="sourceLineNo">279</span> final boolean cacheDataOnRead, final boolean inMemory,<a name="line.279"></a>
-<span class="sourceLineNo">280</span> final boolean cacheDataOnWrite, final boolean cacheIndexesOnWrite,<a name="line.280"></a>
-<span class="sourceLineNo">281</span> final boolean cacheBloomsOnWrite, final boolean evictOnClose,<a name="line.281"></a>
-<span class="sourceLineNo">282</span> final boolean cacheDataCompressed, final boolean prefetchOnOpen,<a name="line.282"></a>
-<span class="sourceLineNo">283</span> final boolean dropBehindCompaction) {<a name="line.283"></a>
-<span class="sourceLineNo">284</span> this.blockCache = blockCache;<a name="line.284"></a>
-<span class="sourceLineNo">285</span> this.cacheDataOnRead = cacheDataOnRead;<a name="line.285"></a>
-<span class="sourceLineNo">286</span> this.inMemory = inMemory;<a name="line.286"></a>
-<span class="sourceLineNo">287</span> this.cacheDataOnWrite = cacheDataOnWrite;<a name="line.287"></a>
-<span class="sourceLineNo">288</span> this.cacheIndexesOnWrite = cacheIndexesOnWrite;<a name="line.288"></a>
-<span class="sourceLineNo">289</span> this.cacheBloomsOnWrite = cacheBloomsOnWrite;<a name="line.289"></a>
-<span class="sourceLineNo">290</span> this.evictOnClose = evictOnClose;<a name="line.290"></a>
-<span class="sourceLineNo">291</span> this.cacheDataCompressed = cacheDataCompressed;<a name="line.291"></a>
-<span class="sourceLineNo">292</span> this.prefetchOnOpen = prefetchOnOpen;<a name="line.292"></a>
-<span class="sourceLineNo">293</span> this.dropBehindCompaction = dropBehindCompaction;<a name="line.293"></a>
+<span class="sourceLineNo">132</span> * Create a cache configuration using the specified configuration object and<a name="line.132"></a>
+<span class="sourceLineNo">133</span> * defaults for family level settings. Only use if no column family context.<a name="line.133"></a>
+<span class="sourceLineNo">134</span> * @param conf hbase configuration<a name="line.134"></a>
+<span class="sourceLineNo">135</span> */<a name="line.135"></a>
+<span class="sourceLineNo">136</span> public CacheConfig(Configuration conf) {<a name="line.136"></a>
+<span class="sourceLineNo">137</span> this(conf, null);<a name="line.137"></a>
+<span class="sourceLineNo">138</span> }<a name="line.138"></a>
+<span class="sourceLineNo">139</span><a name="line.139"></a>
+<span class="sourceLineNo">140</span> public CacheConfig(Configuration conf, BlockCache blockCache) {<a name="line.140"></a>
+<span class="sourceLineNo">141</span> this(conf, null, blockCache);<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> /**<a name="line.144"></a>
+<span class="sourceLineNo">145</span> * Create a cache configuration using the specified configuration object and<a name="line.145"></a>
+<span class="sourceLineNo">146</span> * family descriptor.<a name="line.146"></a>
+<span class="sourceLineNo">147</span> * @param conf hbase configuration<a name="line.147"></a>
+<span class="sourceLineNo">148</span> * @param family column family configuration<a name="line.148"></a>
+<span class="sourceLineNo">149</span> */<a name="line.149"></a>
+<span class="sourceLineNo">150</span> public CacheConfig(Configuration conf, ColumnFamilyDescriptor family, BlockCache blockCache) {<a name="line.150"></a>
+<span class="sourceLineNo">151</span> this.cacheDataOnRead = conf.getBoolean(CACHE_DATA_ON_READ_KEY, DEFAULT_CACHE_DATA_ON_READ) &&<a name="line.151"></a>
+<span class="sourceLineNo">152</span> (family == null ? true : family.isBlockCacheEnabled());<a name="line.152"></a>
+<span class="sourceLineNo">153</span> this.inMemory = family == null ? DEFAULT_IN_MEMORY : family.isInMemory();<a name="line.153"></a>
+<span class="sourceLineNo">154</span> this.cacheDataCompressed =<a name="line.154"></a>
+<span class="sourceLineNo">155</span> conf.getBoolean(CACHE_DATA_BLOCKS_COMPRESSED_KEY, DEFAULT_CACHE_DATA_COMPRESSED);<a name="line.155"></a>
+<span class="sourceLineNo">156</span> this.dropBehindCompaction =<a name="line.156"></a>
+<span class="sourceLineNo">157</span> conf.getBoolean(DROP_BEHIND_CACHE_COMPACTION_KEY, DROP_BEHIND_CACHE_COMPACTION_DEFAULT);<a name="line.157"></a>
+<span class="sourceLineNo">158</span> // For the following flags we enable them regardless of per-schema settings<a name="line.158"></a>
+<span class="sourceLineNo">159</span> // if they are enabled in the global configuration.<a name="line.159"></a>
+<span class="sourceLineNo">160</span> this.cacheDataOnWrite =<a name="line.160"></a>
+<span class="sourceLineNo">161</span> conf.getBoolean(CACHE_BLOCKS_ON_WRITE_KEY, DEFAULT_CACHE_DATA_ON_WRITE) ||<a name="line.161"></a>
+<span class="sourceLineNo">162</span> (family == null ? false : family.isCacheDataOnWrite());<a name="line.162"></a>
+<span class="sourceLineNo">163</span> this.cacheIndexesOnWrite =<a name="line.163"></a>
+<span class="sourceLineNo">164</span> conf.getBoolean(CACHE_INDEX_BLOCKS_ON_WRITE_KEY, DEFAULT_CACHE_INDEXES_ON_WRITE) ||<a name="line.164"></a>
+<span class="sourceLineNo">165</span> (family == null ? false : family.isCacheIndexesOnWrite());<a name="line.165"></a>
+<span class="sourceLineNo">166</span> this.cacheBloomsOnWrite =<a name="line.166"></a>
+<span class="sourceLineNo">167</span> conf.getBoolean(CACHE_BLOOM_BLOCKS_ON_WRITE_KEY, DEFAULT_CACHE_BLOOMS_ON_WRITE) ||<a name="line.167"></a>
+<span class="sourceLineNo">168</span> (family == null ? false : family.isCacheBloomsOnWrite());<a name="line.168"></a>
+<span class="sourceLineNo">169</span> this.evictOnClose = conf.getBoolean(EVICT_BLOCKS_ON_CLOSE_KEY, DEFAULT_EVICT_ON_CLOSE) ||<a name="line.169"></a>
+<span class="sourceLineNo">170</span> (family == null ? false : family.isEvictBlocksOnClose());<a name="line.170"></a>
+<span class="sourceLineNo">171</span> this.prefetchOnOpen = conf.getBoolean(PREFETCH_BLOCKS_ON_OPEN_KEY, DEFAULT_PREFETCH_ON_OPEN) ||<a name="line.171"></a>
+<span class="sourceLineNo">172</span> (family == null ? false : family.isPrefetchBlocksOnOpen());<a name="line.172"></a>
+<span class="sourceLineNo">173</span> this.blockCache = blockCache;<a name="line.173"></a>
+<span class="sourceLineNo">174</span> LOG.info("Created cacheConfig: " + this + (family == null ? "" : " for family " + family) +<a name="line.174"></a>
+<span class="sourceLineNo">175</span> " with blockCache=" + blockCache);<a name="line.175"></a>
+<span class="sourceLineNo">176</span> }<a name="line.176"></a>
+<span class="sourceLineNo">177</span><a name="line.177"></a>
+<span class="sourceLineNo">178</span> /**<a name="line.178"></a>
+<span class="sourceLineNo">179</span> * Constructs a cache configuration copied from the specified configuration.<a name="line.179"></a>
+<span class="sourceLineNo">180</span> * @param cacheConf<a name="line.180"></a>
+<span class="sourceLineNo">181</span> */<a name="line.181"></a>
+<span class="sourceLineNo">182</span> public CacheConfig(CacheConfig cacheConf) {<a name="line.182"></a>
+<span class="sourceLineNo">183</span> this.cacheDataOnRead = cacheConf.cacheDataOnRead;<a name="line.183"></a>
+<span class="sourceLineNo">184</span> this.inMemory = cacheConf.inMemory;<a name="line.184"></a>
+<span class="sourceLineNo">185</span> this.cacheDataOnWrite = cacheConf.cacheDataOnWrite;<a name="line.185"></a>
+<span class="sourceLineNo">186</span> this.cacheIndexesOnWrite = cacheConf.cacheIndexesOnWrite;<a name="line.186"></a>
+<span class="sourceLineNo">187</span> this.cacheBloomsOnWrite = cacheConf.cacheBloomsOnWrite;<a name="line.187"></a>
+<span class="sourceLineNo">188</span> this.evictOnClose = cacheConf.evictOnClose;<a name="line.188"></a>
+<span class="sourceLineNo">189</span> this.cacheDataCompressed = cacheConf.cacheDataCompressed;<a name="line.189"></a>
+<span class="sourceLineNo">190</span> this.prefetchOnOpen = cacheConf.prefetchOnOpen;<a name="line.190"></a>
+<span class="sourceLineNo">191</span> this.dropBehindCompaction = cacheConf.dropBehindCompaction;<a name="line.191"></a>
+<span class="sourceLineNo">192</span> this.blockCache = cacheConf.blockCache;<a name="line.192"></a>
+<span class="sourceLineNo">193</span> }<a name="line.193"></a>
+<span class="sourceLineNo">194</span><a name="line.194"></a>
+<span class="sourceLineNo">195</span> private CacheConfig() {<a name="line.195"></a>
+<span class="sourceLineNo">196</span> this.cacheDataOnRead = false;<a name="line.196"></a>
+<span class="sourceLineNo">197</span> this.inMemory = false;<a name="line.197"></a>
+<span class="sourceLineNo">198</span> this.cacheDataOnWrite = false;<a name="line.198"></a>
+<span class="sourceLineNo">199</span> this.cacheIndexesOnWrite = false;<a name="line.199"></a>
+<span class="sourceLineNo">200</span> this.cacheBloomsOnWrite = false;<a name="line.200"></a>
+<span class="sourceLineNo">201</span> this.evictOnClose = false;<a name="line.201"></a>
+<span class="sourceLineNo">202</span> this.cacheDataCompressed = false;<a name="line.202"></a>
+<span class="sourceLineNo">203</span> this.prefetchOnOpen = false;<a name="line.203"></a>
+<span class="sourceLineNo">204</span> this.dropBehindCompaction = false;<a name="line.204"></a>
+<span class="sourceLineNo">205</span> this.blockCache = null;<a name="line.205"></a>
+<span class="sourceLineNo">206</span> }<a name="line.206"></a>
+<span class="sourceLineNo">207</span><a name="line.207"></a>
+<span class="sourceLineNo">208</span> /**<a name="line.208"></a>
+<span class="sourceLineNo">209</span> * Returns whether the DATA blocks of this HFile should be cached on read or not (we always<a name="line.209"></a>
+<span class="sourceLineNo">210</span> * cache the meta blocks, the INDEX and BLOOM blocks).<a name="line.210"></a>
+<span class="sourceLineNo">211</span> * @return true if blocks should be cached on read, false if not<a name="line.211"></a>
+<span class="sourceLineNo">212</span> */<a name="line.212"></a>
+<span class="sourceLineNo">213</span> public boolean shouldCacheDataOnRead() {<a name="line.213"></a>
+<span class="sourceLineNo">214</span> return cacheDataOnRead;<a name="line.214"></a>
+<span class="sourceLineNo">215</span> }<a name="line.215"></a>
+<span class="sourceLineNo">216</span><a name="line.216"></a>
+<span class="sourceLineNo">217</span> public boolean shouldDropBehindCompaction() {<a name="line.217"></a>
+<span class="sourceLineNo">218</span> return dropBehindCompaction;<a name="line.218"></a>
+<span class="sourceLineNo">219</span> }<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> * Should we cache a block of a particular category? We always cache<a name="line.222"></a>
+<span class="sourceLineNo">223</span> * important blocks such as index blocks, as long as the block cache is<a name="line.223"></a>
+<span class="sourceLineNo">224</span> * available.<a name="line.224"></a>
+<span class="sourceLineNo">225</span> */<a name="line.225"></a>
+<span class="sourceLineNo">226</span> public boolean shouldCacheBlockOnRead(BlockCategory category) {<a name="line.226"></a>
+<span class="sourceLineNo">227</span> return cacheDataOnRead || category == BlockCategory.INDEX || category == BlockCategory.BLOOM ||<a name="line.227"></a>
+<span class="sourceLineNo">228</span> (prefetchOnOpen && (category != BlockCategory.META && category != BlockCategory.UNKNOWN));<a name="line.228"></a>
+<span class="sourceLineNo">229</span> }<a name="line.229"></a>
+<span class="sourceLineNo">230</span><a name="line.230"></a>
+<span class="sourceLineNo">231</span> /**<a name="line.231"></a>
+<span class="sourceLineNo">232</span> * @return true if blocks in this file should be flagged as in-memory<a name="line.232"></a>
+<span class="sourceLineNo">233</span> */<a name="line.233"></a>
+<span class="sourceLineNo">234</span> public boolean isInMemory() {<a name="line.234"></a>
+<span class="sourceLineNo">235</span> return this.inMemory;<a name="line.235"></a>
+<span class="sourceLineNo">236</span> }<a name="line.236"></a>
+<span class="sourceLineNo">237</span><a name="line.237"></a>
+<span class="sourceLineNo">238</span> /**<a name="line.238"></a>
+<span class="sourceLineNo">239</span> * @return true if data blocks should be written to the cache when an HFile is<a name="line.239"></a>
+<span class="sourceLineNo">240</span> * written, false if not<a name="line.240"></a>
+<span class="sourceLineNo">241</span> */<a name="line.241"></a>
+<span class="sourceLineNo">242</span> public boolean shouldCacheDataOnWrite() {<a name="line.242"></a>
+<span class="sourceLineNo">243</span> return this.cacheDataOnWrite;<a name="line.243"></a>
+<span class="sourceLineNo">244</span> }<a name="line.244"></a>
+<span class="sourceLineNo">245</span><a name="line.245"></a>
+<span class="sourceLineNo">246</span> /**<a name="line.246"></a>
+<span class="sourceLineNo">247</span> * @param cacheDataOnWrite whether data blocks should be written to the cache<a name="line.247"></a>
+<span class="sourceLineNo">248</span> * when an HFile is written<a name="line.248"></a>
+<span class="sourceLineNo">249</span> */<a name="line.249"></a>
+<span class="sourceLineNo">250</span> @VisibleForTesting<a name="line.250"></a>
+<span class="sourceLineNo">251</span> public void setCacheDataOnWrite(boolean cacheDataOnWrite) {<a name="line.251"></a>
+<span class="sourceLineNo">252</span> this.cacheDataOnWrite = cacheDataOnWrite;<a name="line.252"></a>
+<span class="sourceLineNo">253</span> }<a name="line.253"></a>
+<span class="sourceLineNo">254</span><a name="line.254"></a>
+<span class="sourceLineNo">255</span> /**<a name="line.255"></a>
+<span class="sourceLineNo">256</span> * @return true if index blocks should be written to the cache when an HFile<a name="line.256"></a>
+<span class="sourceLineNo">257</span> * is written, false if not<a name="line.257"></a>
+<span class="sourceLineNo">258</span> */<a name="line.258"></a>
+<span class="sourceLineNo">259</span> public boolean shouldCacheIndexesOnWrite() {<a name="line.259"></a>
+<span class="sourceLineNo">260</span> return this.cacheIndexesOnWrite;<a name="line.260"></a>
+<span class="sourceLineNo">261</span> }<a name="line.261"></a>
+<span class="sourceLineNo">262</span><a name="line.262"></a>
+<span class="sourceLineNo">263</span> /**<a name="line.263"></a>
+<span class="sourceLineNo">264</span> * @return true if bloom blocks should be written to the cache when an HFile<a name="line.264"></a>
+<span class="sourceLineNo">265</span> * is written, false if not<a name="line.265"></a>
+<span class="sourceLineNo">266</span> */<a name="line.266"></a>
+<span class="sourceLineNo">267</span> public boolean shouldCacheBloomsOnWrite() {<a name="line.267"></a>
+<span class="sourceLineNo">268</span> return this.cacheBloomsOnWrite;<a name="line.268"></a>
+<span class="sourceLineNo">269</span> }<a name="line.269"></a>
+<span class="sourceLineNo">270</span><a name="line.270"></a>
+<span class="sourceLineNo">271</span> /**<a name="line.271"></a>
+<span class="sourceLineNo">272</span> * @return true if blocks should be evicted from the cache when an HFile<a name="line.272"></a>
+<span class="sourceLineNo">273</span> * reader is closed, false if not<a name="line.273"></a>
+<span class="sourceLineNo">274</span> */<a name="line.274"></a>
+<span class="sourceLineNo">275</span> public boolean shouldEvictOnClose() {<a name="line.275"></a>
+<span class="sourceLineNo">276</span> return this.evictOnClose;<a name="line.276"></a>
+<span class="sourceLineNo">277</span> }<a name="line.277"></a>
+<span class="sourceLineNo">278</span><a name="line.278"></a>
+<span class="sourceLineNo">279</span> /**<a name="line.279"></a>
+<span class="sourceLineNo">280</span> * Only used for testing.<a name="line.280"></a>
+<span class="sourceLineNo">281</span> * @param evictOnClose whether blocks should be evicted from the cache when an<a name="line.281"></a>
+<span class="sourceLineNo">282</span> * HFile reader is closed<a name="line.282"></a>
+<span class="sourceLineNo">283</span> */<a name="line.283"></a>
+<span class="sourceLineNo">284</span> @VisibleForTesting<a name="line.284"></a>
+<span class="sourceLineNo">285</span> public void setEvictOnClose(boolean evictOnClose) {<a name="line.285"></a>
+<span class="sourceLineNo">286</span> this.evictOnClose = evictOnClose;<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> /**<a name="line.289"></a>
+<span class="sourceLineNo">290</span> * @return true if data blocks should be compressed in the cache, false if not<a name="line.290"></a>
+<span class="sourceLineNo">291</span> */<a name="line.291"></a>
+<span class="sourceLineNo">292</span> public boolean shouldCacheDataCompressed() {<a name="line.292"></a>
+<span class="sourceLineNo">293</span> return this.cacheDataOnRead && this.cacheDataCompressed;<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 name="line.296"></a>
-<span class="sourceLineNo">297</span> * Constructs a cache configuration copied from the specified configuration.<a name="line.297"></a>
-<span class="sourceLineNo">298</span> * @param cacheConf<a name="line.298"></a>
-<span class="sourceLineNo">299</span> */<a name="line.299"></a>
-<span class="sourceLineNo">300</span> public CacheConfig(CacheConfig cacheConf) {<a name="line.300"></a>
-<span class="sourceLineNo">301</span> this(cacheConf.blockCache, cacheConf.cacheDataOnRead, cacheConf.inMemory,<a name="line.301"></a>
-<span class="sourceLineNo">302</span> cacheConf.cacheDataOnWrite, cacheConf.cacheIndexesOnWrite,<a name="line.302"></a>
-<span class="sourceLineNo">303</span> cacheConf.cacheBloomsOnWrite, cacheConf.evictOnClose,<a name="line.303"></a>
-<span class="sourceLineNo">304</span> cacheConf.cacheDataCompressed, cacheConf.prefetchOnOpen,<a name="line.304"></a>
-<span class="sourceLineNo">305</span> cacheConf.dropBehindCompaction);<a name="line.305"></a>
+<span class="sourceLineNo">297</span> * @return true if this {@link BlockCategory} should be compressed in blockcache, false otherwise<a name="line.297"></a>
+<span class="sourceLineNo">298</span> */<a name="line.298"></a>
+<span class="sourceLineNo">299</span> public boolean shouldCacheCompressed(BlockCategory category) {<a name="line.299"></a>
+<span class="sourceLineNo">300</span> switch (category) {<a name="line.300"></a>
+<span class="sourceLineNo">301</span> case DATA:<a name="line.301"></a>
+<span class="sourceLineNo">302</span> return this.cacheDataOnRead && this.cacheDataCompressed;<a name="line.302"></a>
+<span class="sourceLineNo">303</span> default:<a name="line.303"></a>
+<span class="sourceLineNo">304</span> return false;<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><a name="line.307"></a>
-<span class="sourceLineNo">308</span> private CacheConfig() {<a name="line.308"></a>
-<span class="sourceLineNo">309</span> this(null, false, false, false, false, false, false, false, false, false);<a name="line.309"></a>
-<span class="sourceLineNo">310</span> }<a name="line.310"></a>
-<span class="sourceLineNo">311</span><a name="line.311"></a>
-<span class="sourceLineNo">312</span> /**<a name="line.312"></a>
-<span class="sourceLineNo">313</span> * Checks whether the block cache is enabled.<a name="line.313"></a>
-<span class="sourceLineNo">314</span> */<a name="line.314"></a>
-<span class="sourceLineNo">315</span> public boolean isBlockCacheEnabled() {<a name="line.315"></a>
-<span class="sourceLineNo">316</span> return this.blockCache != null;<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> * Returns the block cache.<a name="line.320"></a>
-<span class="sourceLineNo">321</span> * @return the block cache, or null if caching is completely disabled<a name="line.321"></a>
+<span class="sourceLineNo">308</span> /**<a name="line.308"></a>
+<span class="sourceLineNo">309</span> * @return true if blocks should be prefetched into the cache on open, false if not<a name="line.309"></a>
+<span class="sourceLineNo">310</span> */<a name="line.310"></a>
+<span class="sourceLineNo">311</span> public boolean shouldPrefetchOnOpen() {<a name="line.311"></a>
+<span class="sourceLineNo">312</span> return this.prefetchOnOpen;<a name="line.312"></a>
+<span class="sourceLineNo">313</span> }<a name="line.313"></a>
+<span class="sourceLineNo">314</span><a name="line.314"></a>
+<span class="sourceLineNo">315</span> /**<a name="line.315"></a>
+<span class="sourceLineNo">316</span> * Return true if we may find this type of block in block cache.<a name="line.316"></a>
+<span class="sourceLineNo">317</span> * <p><a name="line.317"></a>
+<span class="sourceLineNo">318</span> * TODO: today {@code family.isBlockCacheEnabled()} only means {@code cacheDataOnRead}, so here we<a name="line.318"></a>
+<span class="sourceLineNo">319</span> * consider lots of other configurations such as {@code cacheDataOnWrite}. We should fix this in<a name="line.319"></a>
+<span class="sourceLineNo">320</span> * the future, {@code cacheDataOnWrite} should honor the CF level {@code isBlockCacheEnabled}<a name="line.320"></a>
+<span class="sourceLineNo">321</span> * configuration.<a name="line.321"></a>
<span class="sourceLineNo">322</span> */<a name="line.322"></a>
-<span class="sourceLineNo">323</span> public BlockCache getBlockCache() {<a name="line.323"></a>
-<span class="sourceLineNo">324</span> return this.blockCache;<a name="line.324"></a>
-<span class="sourceLineNo">325</span> }<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> * Returns whether the DATA blocks of this HFile should be cached on read or not (we always<a name="line.328"></a>
-<span class="sourceLineNo">329</span> * cache the meta blocks, the INDEX and BLOOM blocks).<a name="line.329"></a>
-<span class="sourceLineNo">330</span> * @return true if blocks should be cached on read, false if not<a name="line.330"></a>
-<span class="sourceLineNo">331</span> */<a name="line.331"></a>
-<span class="sourceLineNo">332</span> public boolean shouldCacheDataOnRead() {<a name="line.332"></a>
-<span class="sourceLineNo">333</span> return isBlockCacheEnabled() && cacheDataOnRead;<a name="line.333"></a>
-<span class="sourceLineNo">334</span> }<a name="line.334"></a>
-<span class="sourceLineNo">335</span><a name="line.335"></a>
-<span class="sourceLineNo">336</span> public boolean shouldDropBehindCompaction() {<a name="line.336"></a>
-<span class="sourceLineNo">337</span> return dropBehindCompaction;<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> * Should we cache a block of a particular category? We always cache<a name="line.341"></a>
-<span class="sourceLineNo">342</span> * important blocks such as index blocks, as long as the block cache is<a name="line.342"></a>
-<span class="sourceLineNo">343</span> * available.<a name="line.343"></a>
-<span class="sourceLineNo">344</span> */<a name="line.344"></a>
-<span class="sourceLineNo">345</span> public boolean shouldCacheBlockOnRead(BlockCategory category) {<a name="line.345"></a>
-<span class="sourceLineNo">346</span> return isBlockCacheEnabled()<a name="line.346"></a>
-<span class="sourceLineNo">347</span> && (cacheDataOnRead ||<a name="line.347"></a>
-<span class="sourceLineNo">348</span> category == BlockCategory.INDEX ||<a name="line.348"></a>
-<span class="sourceLineNo">349</span> category == BlockCategory.BLOOM ||<a name="line.349"></a>
-<span class="sourceLineNo">350</span> (prefetchOnOpen &&<a name="line.350"></a>
-<span class="sourceLineNo">351</span> (category != BlockCategory.META &&<a name="line.351"></a>
-<span class="sourceLineNo">352</span> category != BlockCategory.UNKNOWN)));<a name="line.352"></a>
-<span class="sourceLineNo">353</span> }<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> * @return true if blocks in this file should be flagged as in-memory<a name="line.356"></a>
-<span class="sourceLineNo">357</span> */<a name="line.357"></a>
-<span class="sourceLineNo">358</span> public boolean isInMemory() {<a name="line.358"></a>
-<span class="sourceLineNo">359</span> return isBlockCacheEnabled() && this.inMemory;<a name="line.359"></a>
-<span class="sourceLineNo">360</span> }<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> * @return true if data blocks should be written to the cache when an HFile is<a name="line.363"></a>
-<span class="sourceLineNo">364</span> * written, false if not<a name="line.364"></a>
-<span class="sourceLineNo">365</span> */<a name="line.365"></a>
-<span class="sourceLineNo">366</span> public boolean shouldCacheDataOnWrite() {<a name="line.366"></a>
-<span class="sourceLineNo">367</span> return isBlockCacheEnabled() && this.cacheDataOnWrite;<a name="line.367"></a>
-<span class="sourceLineNo">368</span> }<a name="line.368"></a>
-<span class="sourceLineNo">369</span><a name="line.369"></a>
-<span class="sourceLineNo">370</span> /**<a name="line.370"></a>
-<span class="sourceLineNo">371</span> * Only used for testing.<a name="line.371"></a>
-<span class="sourceLineNo">372</span> * @param cacheDataOnWrite whether data blocks should be written to the cache<a name="line.372"></a>
-<span class="sourceLineNo">373</span> * when an HFile is written<a name="line.373"></a>
-<span class="sourceLineNo">374</span> */<a name="line.374"></a>
-<span class="sourceLineNo">375</span> @VisibleForTesting<a name="line.375"></a>
-<span class="sourceLineNo">376</span> public void setCacheDataOnWrite(boolean cacheDataOnWrite) {<a name="line.376"></a>
-<span class="sourceLineNo">377</span> this.cacheDataOnWrite = cacheDataOnWrite;<a name="line.377"></a>
-<span class="sourceLineNo">378</span> }<a name="line.378"></a>
-<span class="sourceLineNo">379</span><a name="line.379"></a>
-<span class="sourceLineNo">380</span> /**<a name="line.380"></a>
-<span class="sourceLineNo">381</span> * @return true if index blocks should be written to the cache when an HFile<a name="line.381"></a>
-<span class="sourceLineNo">382</span> * is written, false if not<a name="line.382"></a>
-<span class="sourceLineNo">383</span> */<a name="line.383"></a>
-<span class="sourceLineNo">384</span> public boolean shouldCacheIndexesOnWrite() {<a name="line.384"></a>
-<span class="sourceLineNo">385</span> return isBlockCacheEnabled() && this.cacheIndexesOnWrite;<a name="line.385"></a>
-<span class="sourceLineNo">386</span> }<a name="line.386"></a>
-<span class="sourceLineNo">387</span><a name="line.387"></a>
-<span class="sourceLineNo">388</span> /**<a name="line.388"></a>
-<span class="sourceLineNo">389</span> * @return true if bloom blocks should be written to the cache when an HFile<a name="line.389"></a>
-<span class="sourceLineNo">390</span> * is written, false if not<a name="line.390"></a>
-<span class="sourceLineNo">391</span> */<a name="line.391"></a>
-<span class="sourceLineNo">392</span> public boolean shouldCacheBloomsOnWrite() {<a name="line.392"></a>
-<span class="sourceLineNo">393</span> return isBlockCacheEnabled() && this.cacheBloomsOnWrite;<a name="line.393"></a>
-<span class="sourceLineNo">394</span> }<a name="line.394"></a>
-<span class="sourceLineNo">395</span><a name="line.395"></a>
-<span class="sourceLineNo">396</span> /**<a name="line.396"></a>
-<span class="sourceLineNo">397</span> * @return true if blocks should be evicted from the cache when an HFile<a name="line.397"></a>
-<span class="sourceLineNo">398</span> * reader is closed, false if not<a name="line.398"></a>
-<span class="sourceLineNo">399</span> */<a name="line.399"></a>
-<span class="sourceLineNo">400</span> public boolean shouldEvictOnClose() {<a name="line.400"></a>
-<span class="sourceLineNo">401</span> return isBlockCacheEnabled() && this.evictOnClose;<a name="line.401"></a>
-<span class="sourceLineNo">402</span> }<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> * Only used for testing.<a name="line.405"></a>
-<span class="sourceLineNo">406</span> * @param evictOnClose whether blocks should be evicted from the cache when an<a name="line.406"></a>
-<span class="sourceLineNo">407</span> * HFile reader is closed<a name="line.407"></a>
-<span class="sourceLineNo">408</span> */<a name="line.408"></a>
-<span class="sourceLineNo">409</span> public void setEvictOnClose(boolean evictOnClose) {<a name="line.409"></a>
-<span class="sourceLineNo">410</span> this.evictOnClose = evictOnClose;<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> * @return true if data blocks should be compressed in the cache, false if not<a name="line.414"></a>
-<span class="sourceLineNo">415</span> */<a name="line.415"></a>
-<span class="sourceLineNo">416</span> public boolean shouldCacheDataCompressed() {<a name="line.416"></a>
-<span class="sourceLineNo">417</span> return isBlockCacheEnabled() && this.cacheDataOnRead && this.cacheDataCompressed;<a name="line.417"></a>
-<span class="sourceLineNo">418</span> }<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>
-<span class="sourceLineNo">421</span> * @return true if this {@link BlockCategory} should be compressed in blockcache, false otherwise<a name="line.421"></a>
-<span class="sourceLineNo">422</span> */<a name="line.422"></a>
-<span class="sourceLineNo">423</span> public boolean shouldCacheCompressed(BlockCategory category) {<a name="line.423"></a>
-<span class="sourceLineNo">424</span> if (!isBlockCacheEnabled()) return false;<a name="line.424"></a>
-<span class="sourceLineNo">425</span> switch (category) {<a name="line.425"></a>
-<span class="sourceLineNo">426</span> case DATA:<a name="line.426"></a>
-<span class="sourceLineNo">427</span> return this.cacheDataOnRead && this.cacheDataCompressed;<a name="line.427"></a>
-<span class="sourceLineNo">428</span> default:<a name="line.428"></a>
-<span class="sourceLineNo">429</span> return false;<a name="line.429"></a>
-<span class="sourceLineNo">430</span> }<a name="line.430"></a>
-<span class="sourceLineNo">431</span> }<a name="line.431"></a>
-<span class="sourceLineNo">432</span><a name="line.432"></a>
-<span class="sourceLineNo">433</span> /**<a name="line.433"></a>
-<span class="sourceLineNo">434</span> * @return true if blocks should be prefetched into the cache on open, false if not<a name="line.434"></a>
-<span class="sourceLineNo">435</span> */<a name="line.435"></a>
-<span class="sourceLineNo">436</span> public boolean shouldPrefetchOnOpen() {<a name="line.436"></a>
-<span class="sourceLineNo">437</span> return isBlockCacheEnabled() && this.prefetchOnOpen;<a name="line.437"></a>
-<span class="sourceLineNo">438</span> }<a name="line.438"></a>
-<span class="sourceLineNo">439</span><a name="line.439"></a>
-<span class="sourceLineNo">440</span> /**<a name="line.440"></a>
-<span class="sourceLineNo">441</span> * Return true if we may find this type of block in block cache.<a name="line.441"></a>
-<span class="sourceLineNo">442</span> * <p><a name="line.442"></a>
-<span class="sourceLineNo">443</span> * TODO: today {@code family.isBlockCacheEnabled()} only means {@code cacheDataOnRead}, so here we<a name="line.443"></a>
-<span class="sourceLineNo">444</span> * consider lots of other configurations such as {@code cacheDataOnWrite}. We should fix this in<a name="line.444"></a>
-<span class="sourceLineNo">445</span> * the future, {@code cacheDataOnWrite} should honor the CF level {@code isBlockCacheEnabled}<a name="line.445"></a>
-<span class="sourceLineNo">446</span> * configuration.<a name="line.446"></a>
-<span class="sourceLineNo">447</span> */<a name="line.447"></a>
-<span class="sourceLineNo">448</span> public boolean shouldReadBlockFromCache(BlockType blockType) {<a name="line.448"></a>
-<span class="sourceLineNo">449</span> if (!isBlockCacheEnabled()) {<a name="line.449"></a>
-<span class="sourceLineNo">450</span> return false;<a name="line.450"></a>
-<span class="sourceLineNo">451</span> }<a name="line.451"></a>
-<span class="sourceLineNo">452</span> if (cacheDataOnRead) {<a name="line.452"></a>
-<span class="sourceLineNo">453</span> return true;<a name="line.453"></a>
-<span class="sourceLineNo">454</span> }<a name="line.454"></a>
-<span class="sourceLineNo">455</span> if (prefetchOnOpen) {<a name="line.455"></a>
-<span class="sourceLineNo">456</span> return true;<a name="line.456"></a>
-<span class="sourceLineNo">457</span> }<a name="line.457"></a>
-<span class="sourceLineNo">458</span> if (cacheDataOnWrite) {<a name="line.458"></a>
-<span class="sourceLineNo">459</span> return true;<a name="line.459"></a>
-<span class="sourceLineNo">460</span> }<a name="line.460"></a>
-<span class="sourceLineNo">461</span> if (blockType == null) {<a name="line.461"></a>
-<span class="sourceLineNo">462</span> return true;<a name="line.462"></a>
-<span class="sourceLineNo">463</span> }<a name="line.463"></a>
-<span class="sourceLineNo">464</span> if (blockType.getCategory() == BlockCategory.BLOOM ||<a name="line.464"></a>
-<span class="sourceLineNo">465</span> blockType.getCategory() == BlockCategory.INDEX) {<a name="line.465"></a>
-<span class="sourceLineNo">466</span> return true;<a name="line.466"></a>
-<span class="sourceLineNo">467</span> }<a name="line.467"></a>
-<span class="sourceLineNo">468</span> return false;<a name="line.468"></a>
-<span class="sourceLineNo">469</span> }<a name="line.469"></a>
-<span class="sourceLineNo">470</span><a name="line.470"></a>
-<span class="sourceLineNo">471</span> /**<a name="line.471"></a>
-<span class="sourceLineNo">472</span> * If we make sure the block could not be cached, we will not acquire the lock<a name="line.472"></a>
-<span class="sourceLineNo">473</span> * otherwise we will acquire lock<a name="line.473"></a>
-<span class="sourceLineNo">474</span> */<a name="line.474"></a>
-<span class="sourceLineNo">475</span> public boolean shouldLockOnCacheMiss(BlockType blockType) {<a name="line.475"></a>
-<span class="sourceLineNo">476</span> if (blockType == null) {<a name="line.476"></a>
-<span class="sourceLineNo">477</span> return true;<a name="line.477"></a>
-<span class="sourceLineNo">478</span> }<a name="line.478"></a>
-<span class="sourceLineNo">479</span> return shouldCacheBlockOnRead(blockType.getCategory());<a name="line.479"></a>
-<span class="sourceLineNo">480</span> }<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 String toString() {<a name="line.483"></a>
-<span class="sourceLineNo">484</span> if (!isBlockCacheEnabled()) {<a name="line.484"></a>
-<span class="sourceLineNo">485</span> return "CacheConfig:disabled";<a name="line.485"></a>
-<span class="sourceLineNo">486</span> }<a name="line.486"></a>
-<span class="sourceLineNo">487</span> return "blockCache=" + getBlockCache() +<a name="line.487"></a>
-<span class="sourceLineNo">488</span> ", cacheDataOnRead=" + shouldCacheDataOnRead() +<a name="line.488"></a>
-<span class="sourceLineNo">489</span> ", cacheDataOnWrite=" + shouldCacheDataOnWrite() +<a name="line.489"></a>
-<span class="sourceLineNo">490</span> ", cacheIndexesOnWrite=" + shouldCacheIndexesOnWrite() +<a name="line.490"></a>
-<span class="sourceLineNo">491</span> ", cacheBloomsOnWrite=" + shouldCacheBloomsOnWrite() +<a name="line.491"></a>
-<span class="sourceLineNo">492</span> ", cacheEvictOnClose=" + shouldEvictOnClose() +<a name="line.492"></a>
-<span class="sourceLineNo">493</span> ", cacheDataCompressed=" + shouldCacheDataCompressed() +<a name="line.493"></a>
-<span class="sourceLineNo">494</span> ", prefetchOnOpen=" + shouldPrefetchOnOpen();<a name="line.494"></a>
-<span class="sourceLineNo">495</span> }<a name="line.495"></a>
-<span class="sourceLineNo">496</span><a name="line.496"></a>
-<span class="sourceLineNo">497</span> // Static block cache reference and methods<a name="line.497"></a>
-<span class="sourceLineNo">498</span><a name="line.498"></a>
-<span class="sourceLineNo">499</span> /**<a name="line.499"></a>
-<span class="sourceLineNo">500</span> * Static reference to the block cache, or null if no caching should be used<a name="line.500"></a>
-<span class="sourceLineNo">501</span> * at all.<a name="line.501"></a>
-<span class="sourceLineNo">502</span> */<a name="line.502"></a>
-<span class="sourceLineNo">503</span> // Clear this if in tests you'd make more than one block cache instance.<a name="line.503"></a>
-<span class="sourceLineNo">504</span> @VisibleForTesting<a name="line.504"></a>
-<span class="sourceLineNo">505</span> static BlockCache GLOBAL_BLOCK_CACHE_INSTANCE;<a name="line.505"></a>
-<span class="sourceLineNo">506</span> private static LruBlockCache ONHEAP_CACHE_INSTANCE = null;<a name="line.506"></a>
-<span class="sourceLineNo">507</span> private static BlockCache L2_CACHE_INSTANCE = null;// Can be BucketCache or External cache.<a name="line.507"></a>
-<span class="sourceLineNo">508</span><a name="line.508"></a>
-<span class="sourceLineNo">509</span> /** Boolean whether we have disabled the block cache entirely. */<a name="line.509"></a>
-<span class="sourceLineNo">510</span> @VisibleForTesting<a name="line.510"></a>
-<span class="sourceLineNo">511</span> static boolean blockCacheDisabled = false;<a name="line.511"></a>
-<span class="sourceLineNo">512</span><a name="line.512"></a>
-<span class="sourceLineNo">513</span> /**<a name="line.513"></a>
-<span class="sourceLineNo">514</span> * @param c Configuration to use.<a name="line.514"></a>
-<span class="sourceLineNo">515</span> * @return An L1 instance. Currently an instance of LruBlockCache.<a name="line.515"></a>
-<span class="sourceLineNo">516</span> */<a name="line.516"></a>
-<span class="sourceLineNo">517</span> public static LruBlockCache getOnHeapCache(final Configuration c) {<a name="line.517"></a>
-<span class="sourceLineNo">518</span> return getOnHeapCacheInternal(c);<a name="line.518"></a>
-<span class="sourceLineNo">519</span> }<a name="line.519"></a>
-<span class="sourceLineNo">520</span><a name="line.520"></a>
-<span class="sourceLineNo">521</span> public CacheStats getOnHeapCacheStats() {<a name="line.521"></a>
-<span class="sourceLineNo">522</span> if (ONHEAP_CACHE_INSTANCE != null) {<a name="line.522"></a>
-<span class="sourceLineNo">523</span> return ONHEAP_CACHE_INSTANCE.getStats();<a name="line.523"></a>
-<span class="sourceLineNo">524</span> }<a name="line.524"></a>
-<span class="sourceLineNo">525</span> return null;<a name="line.525"></a>
-<span class="sourceLineNo">526</span> }<a name="line.526"></a>
-<span class="sourceLineNo">527</span><a name="line.527"></a>
-<span class="sourceLineNo">528</span> public CacheStats getL2CacheStats() {<a name="line.528"></a>
-<span class="sourceLineNo">529</span> if (L2_CACHE_INSTANCE != null) {<a name="line.529"></a>
-<span class="sourceLineNo">530</span> return L2_CACHE_INSTANCE.getStats();<a name="line.530"></a>
-<span class="sourceLineNo">531</span> }<a name="line.531"></a>
-<span class="sourceLineNo">532</span> return null;<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> /**<a name="line.535"></a>
-<span class="sourceLineNo">536</span> * @param c Configuration to use.<a name="line.536"></a>
-<span class="sourceLineNo">537</span> * @return An L1 instance. Currently an instance of LruBlockCache.<a name="line.537"></a>
-<span class="sourceLineNo">538</span> */<a name="line.538"></a>
-<span class="sourceLineNo">539</span> private synchronized static LruBlockCache getOnHeapCacheInternal(final Configuration c) {<a name="line.539"></a>
-<span class="sourceLineNo">540</span> if (ONHEAP_CACHE_INSTANCE != null) {<a name="line.540"></a>
-<span class="sourceLineNo">541</span> return ONHEAP_CACHE_INSTANCE;<a name="line.541"></a>
-<span class="sourceLineNo">542</span> }<a name="line.542"></a>
-<span class="sourceLineNo">543</span> final long cacheSize = MemorySizeUtil.getOnHeapCacheSize(c);<a name="line.543"></a>
-<span class="sourceLineNo">544</span> if (cacheSize < 0) {<a name="line.544"></a>
-<span class="sourceLineNo">545</span> blockCacheDisabled = true;<a name="line.545"></a>
-<span class="sourceLineNo">546</span> }<a name="line.546"></a>
-<span class="sourceLineNo">547</span> if (blockCacheDisabled) return null;<a name="line.547"></a>
-<span class="sourceLineNo">548</span> int blockSize = c.getInt(BLOCKCACHE_BLOCKSIZE_KEY, HConstants.DEFAULT_BLOCKSIZE);<a name="line.548"></a>
-<span class="sourceLineNo">549</span> LOG.info("Allocating onheap LruBlockCache size=" +<a name="line.549"></a>
-<span class="sourceLineNo">550</span> StringUtils.byteDesc(cacheSize) + ", blockSize=" + StringUtils.byteDesc(blockSize));<a name="line.550"></a>
-<span class="sourceLineNo">551</span> ONHEAP_CACHE_INSTANCE = new LruBlockCache(cacheSize, blockSize, true, c);<a name="line.551"></a>
-<span class="sourceLineNo">552</span> return ONHEAP_CACHE_INSTANCE;<a name="line.552"></a>
-<span class="sourceLineNo">553</span> }<a name="line.553"></a>
-<span class="sourceLineNo">554</span><a name="line.554"></a>
-<span class="sourceLineNo">555</span> private static BlockCache getExternalBlockcache(Configuration c) {<a name="line.555"></a>
-<span class="sourceLineNo">556</span> if (LOG.isDebugEnabled()) {<a name="line.556"></a>
-<span class="sourceLineNo">557</span> LOG.debug("Trying to use External l2 cache");<a name="line.557"></a>
-<span class="sourceLineNo">558</span> }<a name="line.558"></a>
-<span class="sourceLineNo">559</span> Class klass = null;<a name="line.559"></a>
-<span class="sourceLineNo">560</span><a name="line.560"></a>
-<span class="sourceLineNo">561</span> // Get the class, from the config. s<a name="line.561"></a>
-<span class="sourceLineNo">562</span> try {<a name="line.562"></a>
-<span class="sourceLineNo">563</span> klass = ExternalBlockCaches.valueOf(c.get(EXTERNAL_BLOCKCACHE_CLASS_KEY, "memcache")).clazz;<a name="line.563"></a>
-<span class="sourceLineNo">564</span> } catch (IllegalArgumentException exception) {<a name="line.564"></a>
-<span class="sourceLineNo">565</span> try {<a name="line.565"></a>
-<span class="sourceLineNo">566</span> klass = c.getClass(EXTERNAL_BLOCKCACHE_CLASS_KEY, Class.forName(<a name="line.566"></a>
-<span class="sourceLineNo">567</span> "org.apache.hadoop.hbase.io.hfile.MemcachedBlockCache"));<a name="line.567"></a>
-<span class="sourceLineNo">568</span> } catch (ClassNotFoundException e) {<a name="line.568"></a>
-<span class="sourceLineNo">569</span> return null;<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><a name="line.572"></a>
-<span class="sourceLineNo">573</span> // Now try and create an instance of the block cache.<a name="line.573"></a>
-<span class="sourceLineNo">574</span> try {<a name="line.574"></a>
-<span class="sourceLineNo">575</span> LOG.info("Creating external block cache of type: " + klass);<a name="line.575"></a>
-<span class="sourceLineNo">576</span> return (BlockCache) ReflectionUtils.newInstance(klass, c);<a name="line.576"></a>
-<span class="sourceLineNo">577</span> } catch (Exception e) {<a name="line.577"></a>
-<span class="sourceLineNo">578</span> LOG.warn("Error creating external block cache", e);<a name="line.578"></a>
-<span class="sourceLineNo">579</span> }<a name="line.579"></a>
-<span class="sourceLineNo">580</span> return null;<a name="line.580"></a>
-<span class="sourceLineNo">581</span><a name="line.581"></a>
-<span class="sourceLineNo">582</span> }<a name="line.582"></a>
-<span class="sourceLineNo">583</span><a name="line.583"></a>
-<span class="sourceLineNo">584</span> @VisibleForTesting<a name="line.584"></a>
-<span class="sourceLineNo">585</span> static BucketCache getBucketCache(Configuration c) {<a name="line.585"></a>
-<span class="sourceLineNo">586</span> // Check for L2. ioengine name must be non-null.<a name="line.586"></a>
-<span class="sourceLineNo">587</span> String bucketCacheIOEngineName = c.get(BUCKET_CACHE_IOENGINE_KEY, null);<a name="line.587"></a>
-<span class="sourceLineNo">588</span> if (bucketCacheIOEngineName == null || bucketCacheIOEngineName.length() <= 0) return null;<a name="line.588"></a>
-<span class="sourceLineNo">589</span><a name="line.589"></a>
-<span class="sourceLineNo">590</span> int blockSize = c.getInt(BLOCKCACHE_BLOCKSIZE_KEY, HConstants.DEFAULT_BLOCKSIZE);<a name="line.590"></a>
-<span class="sourceLineNo">591</span> final long bucketCacheSize = MemorySizeUtil.getBucketCacheSize(c);<a name="line.591"></a>
-<span class="sourceLineNo">592</span> if (bucketCacheSize <= 0) {<a name="line.592"></a>
-<span class="sourceLineNo">593</span> throw new IllegalStateException("bucketCacheSize <= 0; Check " +<a name="line.593"></a>
-<span class="sourceLineNo">594</span> BUCKET_CACHE_SIZE_KEY + " setting and/or server java heap size");<a name="line.594"></a>
-<span class="sourceLineNo">595</span> }<a name="line.595"></a>
-<span class="sourceLineNo">596</span> if (c.get("hbase.bucketcache.percentage.in.combinedcache") != null) {<a name="line.596"></a>
-<span class="sourceLineNo">597</span> LOG.warn("Configuration 'hbase.bucketcache.percentage.in.combinedcache' is no longer "<a name="line.597"></a>
-<span class="sourceLineNo">598</span> + "respected. See comments in http://hbase.apache.org/book.html#_changes_of_note");<a name="line.598"></a>
-<span class="sourceLineNo">599</span> }<a name="line.599"></a>
-<span class="sourceLineNo">600</span> int writerThreads = c.getInt(BUCKET_CACHE_WRITER_THREADS_KEY,<a name="line.600"></a>
-<span class="sourceLineNo">601</span> DEFAULT_BUCKET_CACHE_WRITER_THREADS);<a name="line.601"></a>
-<span class="sourceLineNo">602</span> int writerQueueLen = c.getInt(BUCKET_CACHE_WRITER_QUEUE_KEY,<a name="line.602"></a>
-<span class="sourceLineNo">603</span> DEFAULT_BUCKET_CACHE_WRITER_QUEUE);<a name="line.603"></a>
-<span class="sourceLineNo">604</span> String persistentPath = c.get(BUCKET_CACHE_PERSISTENT_PATH_KEY);<a name="line.604"></a>
-<span class="sourceLineNo">605</span> String[] configuredBucketSizes = c.getStrings(BUCKET_CACHE_BUCKETS_KEY);<a name="line.605"></a>
-<span class="sourceLineNo">606</span> int [] bucketSizes = null;<a name="line.606"></a>
-<span class="sourceLineNo">607</span> if (configuredBucketSizes != null) {<a name="line.607"></a>
-<span class="sourceLineNo">608</span> bucketSizes = new int[configuredBucketSizes.length];<a name="line.608"></a>
-<span class="sourceLineNo">609</span> for (int i = 0; i < configuredBucketSizes.length; i++) {<a name="line.609"></a>
-<span class="sourceLineNo">610</span> int bucketSize = Integer.parseInt(configuredBucketSizes[i].trim());<a name="line.610"></a>
-<span class="sourceLineNo">611</span> if (bucketSize % 256 != 0) {<a name="line.611"></a>
-<span class="sourceLineNo">612</span> // We need all the bucket sizes to be multiples of 256. Having all the configured bucket<a name="line.612"></a>
-<span class="sourceLineNo">613</span> // sizes to be multiples of 256 will ensure that the block offsets within buckets,<a name="line.613"></a>
-<span class="sourceLineNo">614</span> // that are calculated, will also be multiples of 256.<a name="line.614"></a>
-<span class="sourceLineNo">615</span> // See BucketEntry where offset to each block is represented using 5 bytes (instead of 8<a name="line.615"></a>
-<span class="sourceLineNo">616</span> // bytes long). We would like to save heap overhead as less as possible.<a name="line.616"></a>
-<span class="sourceLineNo">617</span> throw new IllegalArgumentException("Illegal value: " + bucketSize + " configured for '"<a name="line.617"></a>
-<span class="sourceLineNo">618</span> + BUCKET_CACHE_BUCKETS_KEY + "'. A
<TRUNCATED>