Google Git
Sign in
apache / hbase-site / fbcf6c89b23841dd0de8ef3466b759a547994d66 / . / devapidocs / src-html / org / apache / hadoop / hbase / regionserver / storefiletracker / StoreFileTrackerBase.html
blob: 9ab215d5b55776e626062dd5334531aff04e6e75 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a>
<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a>
<span class="sourceLineNo">017</span> */<a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.regionserver.storefiletracker;<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.regionserver.storefiletracker.StoreFileTrackerFactory.TRACKER_IMPL;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.io.IOException;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.Collection;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.List;<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.fs.Path;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.client.ColumnFamilyDescriptor;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.client.TableDescriptorBuilder;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.io.compress.Compression;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.io.crypto.Encryption;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.io.hfile.CacheConfig;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.io.hfile.HFile;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.io.hfile.HFileContext;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.io.hfile.HFileContextBuilder;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.regionserver.CreateStoreFileWriterParams;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.regionserver.StoreContext;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.regionserver.StoreFileInfo;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.regionserver.StoreFileWriter;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.regionserver.StoreUtils;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.slf4j.Logger;<a name="line.42"></a>
<span class="sourceLineNo">043</span>import org.slf4j.LoggerFactory;<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span>/**<a name="line.45"></a>
<span class="sourceLineNo">046</span> * Base class for all store file tracker.<a name="line.46"></a>
<span class="sourceLineNo">047</span> * &lt;p/&gt;<a name="line.47"></a>
<span class="sourceLineNo">048</span> * Mainly used to place the common logic to skip persistent for secondary replicas.<a name="line.48"></a>
<span class="sourceLineNo">049</span> */<a name="line.49"></a>
<span class="sourceLineNo">050</span>@InterfaceAudience.Private<a name="line.50"></a>
<span class="sourceLineNo">051</span>abstract class StoreFileTrackerBase implements StoreFileTracker {<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span> private static final Logger LOG = LoggerFactory.getLogger(StoreFileTrackerBase.class);<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> protected final Configuration conf;<a name="line.55"></a>
<span class="sourceLineNo">056</span><a name="line.56"></a>
<span class="sourceLineNo">057</span> protected final boolean isPrimaryReplica;<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span> protected final StoreContext ctx;<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> private volatile boolean cacheOnWriteLogged;<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span> protected StoreFileTrackerBase(Configuration conf, boolean isPrimaryReplica, StoreContext ctx) {<a name="line.63"></a>
<span class="sourceLineNo">064</span> this.conf = conf;<a name="line.64"></a>
<span class="sourceLineNo">065</span> this.isPrimaryReplica = isPrimaryReplica;<a name="line.65"></a>
<span class="sourceLineNo">066</span> this.ctx = ctx;<a name="line.66"></a>
<span class="sourceLineNo">067</span> }<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span> @Override<a name="line.69"></a>
<span class="sourceLineNo">070</span> public final List&lt;StoreFileInfo&gt; load() throws IOException {<a name="line.70"></a>
<span class="sourceLineNo">071</span> return doLoadStoreFiles(!isPrimaryReplica);<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> @Override<a name="line.74"></a>
<span class="sourceLineNo">075</span> public final void add(Collection&lt;StoreFileInfo&gt; newFiles) throws IOException {<a name="line.75"></a>
<span class="sourceLineNo">076</span> if (isPrimaryReplica) {<a name="line.76"></a>
<span class="sourceLineNo">077</span> doAddNewStoreFiles(newFiles);<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><a name="line.80"></a>
<span class="sourceLineNo">081</span> @Override<a name="line.81"></a>
<span class="sourceLineNo">082</span> public final void replace(Collection&lt;StoreFileInfo&gt; compactedFiles,<a name="line.82"></a>
<span class="sourceLineNo">083</span> Collection&lt;StoreFileInfo&gt; newFiles) throws IOException {<a name="line.83"></a>
<span class="sourceLineNo">084</span> if (isPrimaryReplica) {<a name="line.84"></a>
<span class="sourceLineNo">085</span> doAddCompactionResults(compactedFiles, newFiles);<a name="line.85"></a>
<span class="sourceLineNo">086</span> }<a name="line.86"></a>
<span class="sourceLineNo">087</span> }<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span> @Override<a name="line.89"></a>
<span class="sourceLineNo">090</span> public final void set(List&lt;StoreFileInfo&gt; files) throws IOException {<a name="line.90"></a>
<span class="sourceLineNo">091</span> if (isPrimaryReplica) {<a name="line.91"></a>
<span class="sourceLineNo">092</span> doSetStoreFiles(files);<a name="line.92"></a>
<span class="sourceLineNo">093</span> }<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> @Override<a name="line.96"></a>
<span class="sourceLineNo">097</span> public TableDescriptorBuilder updateWithTrackerConfigs(TableDescriptorBuilder builder) {<a name="line.97"></a>
<span class="sourceLineNo">098</span> builder.setValue(TRACKER_IMPL, getTrackerName());<a name="line.98"></a>
<span class="sourceLineNo">099</span> return builder;<a name="line.99"></a>
<span class="sourceLineNo">100</span> }<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span> protected final String getTrackerName() {<a name="line.102"></a>
<span class="sourceLineNo">103</span> return StoreFileTrackerFactory.getStoreFileTrackerName(getClass());<a name="line.103"></a>
<span class="sourceLineNo">104</span> }<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span> private HFileContext createFileContext(Compression.Algorithm compression,<a name="line.106"></a>
<span class="sourceLineNo">107</span> boolean includeMVCCReadpoint, boolean includesTag, Encryption.Context encryptionContext) {<a name="line.107"></a>
<span class="sourceLineNo">108</span> if (compression == null) {<a name="line.108"></a>
<span class="sourceLineNo">109</span> compression = HFile.DEFAULT_COMPRESSION_ALGORITHM;<a name="line.109"></a>
<span class="sourceLineNo">110</span> }<a name="line.110"></a>
<span class="sourceLineNo">111</span> ColumnFamilyDescriptor family = ctx.getFamily();<a name="line.111"></a>
<span class="sourceLineNo">112</span> HFileContext hFileContext = new HFileContextBuilder().withIncludesMvcc(includeMVCCReadpoint)<a name="line.112"></a>
<span class="sourceLineNo">113</span> .withIncludesTags(includesTag).withCompression(compression)<a name="line.113"></a>
<span class="sourceLineNo">114</span> .withCompressTags(family.isCompressTags()).withChecksumType(StoreUtils.getChecksumType(conf))<a name="line.114"></a>
<span class="sourceLineNo">115</span> .withBytesPerCheckSum(StoreUtils.getBytesPerChecksum(conf))<a name="line.115"></a>
<span class="sourceLineNo">116</span> .withBlockSize(family.getBlocksize()).withHBaseCheckSum(true)<a name="line.116"></a>
<span class="sourceLineNo">117</span> .withDataBlockEncoding(family.getDataBlockEncoding()).withEncryptionContext(encryptionContext)<a name="line.117"></a>
<span class="sourceLineNo">118</span> .withCreateTime(EnvironmentEdgeManager.currentTime()).withColumnFamily(family.getName())<a name="line.118"></a>
<span class="sourceLineNo">119</span> .withTableName(ctx.getTableName().getName()).withCellComparator(ctx.getComparator())<a name="line.119"></a>
<span class="sourceLineNo">120</span> .withIndexBlockEncoding(family.getIndexBlockEncoding()).build();<a name="line.120"></a>
<span class="sourceLineNo">121</span> return hFileContext;<a name="line.121"></a>
<span class="sourceLineNo">122</span> }<a name="line.122"></a>
<span class="sourceLineNo">123</span><a name="line.123"></a>
<span class="sourceLineNo">124</span> @Override<a name="line.124"></a>
<span class="sourceLineNo">125</span> public final StoreFileWriter createWriter(CreateStoreFileWriterParams params) throws IOException {<a name="line.125"></a>
<span class="sourceLineNo">126</span> if (!isPrimaryReplica) {<a name="line.126"></a>
<span class="sourceLineNo">127</span> throw new IllegalStateException("Should not call create writer on secondary replicas");<a name="line.127"></a>
<span class="sourceLineNo">128</span> }<a name="line.128"></a>
<span class="sourceLineNo">129</span> // creating new cache config for each new writer<a name="line.129"></a>
<span class="sourceLineNo">130</span> final CacheConfig cacheConf = ctx.getCacheConf();<a name="line.130"></a>
<span class="sourceLineNo">131</span> final CacheConfig writerCacheConf = new CacheConfig(cacheConf);<a name="line.131"></a>
<span class="sourceLineNo">132</span> long totalCompactedFilesSize = params.totalCompactedFilesSize();<a name="line.132"></a>
<span class="sourceLineNo">133</span> if (params.isCompaction()) {<a name="line.133"></a>
<span class="sourceLineNo">134</span> // Don't cache data on write on compactions, unless specifically configured to do so<a name="line.134"></a>
<span class="sourceLineNo">135</span> // Cache only when total file size remains lower than configured threshold<a name="line.135"></a>
<span class="sourceLineNo">136</span> final boolean cacheCompactedBlocksOnWrite = cacheConf.shouldCacheCompactedBlocksOnWrite();<a name="line.136"></a>
<span class="sourceLineNo">137</span> // if data blocks are to be cached on write<a name="line.137"></a>
<span class="sourceLineNo">138</span> // during compaction, we should forcefully<a name="line.138"></a>
<span class="sourceLineNo">139</span> // cache index and bloom blocks as well<a name="line.139"></a>
<span class="sourceLineNo">140</span> if (<a name="line.140"></a>
<span class="sourceLineNo">141</span> cacheCompactedBlocksOnWrite<a name="line.141"></a>
<span class="sourceLineNo">142</span> &amp;&amp; totalCompactedFilesSize &lt;= cacheConf.getCacheCompactedBlocksOnWriteThreshold()<a name="line.142"></a>
<span class="sourceLineNo">143</span> ) {<a name="line.143"></a>
<span class="sourceLineNo">144</span> writerCacheConf.enableCacheOnWrite();<a name="line.144"></a>
<span class="sourceLineNo">145</span> if (!cacheOnWriteLogged) {<a name="line.145"></a>
<span class="sourceLineNo">146</span> LOG.info("For {} , cacheCompactedBlocksOnWrite is true, hence enabled "<a name="line.146"></a>
<span class="sourceLineNo">147</span> + "cacheOnWrite for Data blocks, Index blocks and Bloom filter blocks", this);<a name="line.147"></a>
<span class="sourceLineNo">148</span> cacheOnWriteLogged = true;<a name="line.148"></a>
<span class="sourceLineNo">149</span> }<a name="line.149"></a>
<span class="sourceLineNo">150</span> } else {<a name="line.150"></a>
<span class="sourceLineNo">151</span> writerCacheConf.setCacheDataOnWrite(false);<a name="line.151"></a>
<span class="sourceLineNo">152</span> if (totalCompactedFilesSize &gt; cacheConf.getCacheCompactedBlocksOnWriteThreshold()) {<a name="line.152"></a>
<span class="sourceLineNo">153</span> // checking condition once again for logging<a name="line.153"></a>
<span class="sourceLineNo">154</span> LOG.debug(<a name="line.154"></a>
<span class="sourceLineNo">155</span> "For {}, setting cacheCompactedBlocksOnWrite as false as total size of compacted "<a name="line.155"></a>
<span class="sourceLineNo">156</span> + "files - {}, is greater than cacheCompactedBlocksOnWriteThreshold - {}",<a name="line.156"></a>
<span class="sourceLineNo">157</span> this, totalCompactedFilesSize, cacheConf.getCacheCompactedBlocksOnWriteThreshold());<a name="line.157"></a>
<span class="sourceLineNo">158</span> }<a name="line.158"></a>
<span class="sourceLineNo">159</span> }<a name="line.159"></a>
<span class="sourceLineNo">160</span> } else {<a name="line.160"></a>
<span class="sourceLineNo">161</span> final boolean shouldCacheDataOnWrite = cacheConf.shouldCacheDataOnWrite();<a name="line.161"></a>
<span class="sourceLineNo">162</span> if (shouldCacheDataOnWrite) {<a name="line.162"></a>
<span class="sourceLineNo">163</span> writerCacheConf.enableCacheOnWrite();<a name="line.163"></a>
<span class="sourceLineNo">164</span> if (!cacheOnWriteLogged) {<a name="line.164"></a>
<span class="sourceLineNo">165</span> LOG.info("For {} , cacheDataOnWrite is true, hence enabled cacheOnWrite for "<a name="line.165"></a>
<span class="sourceLineNo">166</span> + "Index blocks and Bloom filter blocks", this);<a name="line.166"></a>
<span class="sourceLineNo">167</span> cacheOnWriteLogged = true;<a name="line.167"></a>
<span class="sourceLineNo">168</span> }<a name="line.168"></a>
<span class="sourceLineNo">169</span> }<a name="line.169"></a>
<span class="sourceLineNo">170</span> }<a name="line.170"></a>
<span class="sourceLineNo">171</span> Encryption.Context encryptionContext = ctx.getEncryptionContext();<a name="line.171"></a>
<span class="sourceLineNo">172</span> HFileContext hFileContext = createFileContext(params.compression(),<a name="line.172"></a>
<span class="sourceLineNo">173</span> params.includeMVCCReadpoint(), params.includesTag(), encryptionContext);<a name="line.173"></a>
<span class="sourceLineNo">174</span> Path outputDir;<a name="line.174"></a>
<span class="sourceLineNo">175</span> if (requireWritingToTmpDirFirst()) {<a name="line.175"></a>
<span class="sourceLineNo">176</span> outputDir =<a name="line.176"></a>
<span class="sourceLineNo">177</span> new Path(ctx.getRegionFileSystem().getTempDir(), ctx.getFamily().getNameAsString());<a name="line.177"></a>
<span class="sourceLineNo">178</span> } else {<a name="line.178"></a>
<span class="sourceLineNo">179</span> outputDir = ctx.getFamilyStoreDirectoryPath();<a name="line.179"></a>
<span class="sourceLineNo">180</span> }<a name="line.180"></a>
<span class="sourceLineNo">181</span> StoreFileWriter.Builder builder =<a name="line.181"></a>
<span class="sourceLineNo">182</span> new StoreFileWriter.Builder(conf, writerCacheConf, ctx.getRegionFileSystem().getFileSystem())<a name="line.182"></a>
<span class="sourceLineNo">183</span> .withOutputDir(outputDir).withBloomType(ctx.getBloomFilterType())<a name="line.183"></a>
<span class="sourceLineNo">184</span> .withMaxKeyCount(params.maxKeyCount()).withFavoredNodes(ctx.getFavoredNodes())<a name="line.184"></a>
<span class="sourceLineNo">185</span> .withFileContext(hFileContext).withShouldDropCacheBehind(params.shouldDropBehind())<a name="line.185"></a>
<span class="sourceLineNo">186</span> .withCompactedFilesSupplier(ctx.getCompactedFilesSupplier())<a name="line.186"></a>
<span class="sourceLineNo">187</span> .withFileStoragePolicy(params.fileStoragePolicy())<a name="line.187"></a>
<span class="sourceLineNo">188</span> .withWriterCreationTracker(params.writerCreationTracker())<a name="line.188"></a>
<span class="sourceLineNo">189</span> .withMaxVersions(ctx.getMaxVersions()).withNewVersionBehavior(ctx.getNewVersionBehavior())<a name="line.189"></a>
<span class="sourceLineNo">190</span> .withCellComparator(ctx.getComparator()).withIsCompaction(params.isCompaction());<a name="line.190"></a>
<span class="sourceLineNo">191</span> return builder.build();<a name="line.191"></a>
<span class="sourceLineNo">192</span> }<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> * For primary replica, we will call load once when opening a region, and the implementation could<a name="line.195"></a>
<span class="sourceLineNo">196</span> * choose to do some cleanup work. So here we use {@code readOnly} to indicate that whether you<a name="line.196"></a>
<span class="sourceLineNo">197</span> * are allowed to do the cleanup work. For secondary replicas, we will set {@code readOnly} to<a name="line.197"></a>
<span class="sourceLineNo">198</span> * {@code true}.<a name="line.198"></a>
<span class="sourceLineNo">199</span> */<a name="line.199"></a>
<span class="sourceLineNo">200</span> protected abstract List&lt;StoreFileInfo&gt; doLoadStoreFiles(boolean readOnly) throws IOException;<a name="line.200"></a>
<span class="sourceLineNo">201</span><a name="line.201"></a>
<span class="sourceLineNo">202</span> protected abstract void doAddNewStoreFiles(Collection&lt;StoreFileInfo&gt; newFiles) throws IOException;<a name="line.202"></a>
<span class="sourceLineNo">203</span><a name="line.203"></a>
<span class="sourceLineNo">204</span> protected abstract void doAddCompactionResults(Collection&lt;StoreFileInfo&gt; compactedFiles,<a name="line.204"></a>
<span class="sourceLineNo">205</span> Collection&lt;StoreFileInfo&gt; newFiles) throws IOException;<a name="line.205"></a>
<span class="sourceLineNo">206</span><a name="line.206"></a>
<span class="sourceLineNo">207</span> protected abstract void doSetStoreFiles(Collection&lt;StoreFileInfo&gt; files) throws IOException;<a name="line.207"></a>
<span class="sourceLineNo">208</span><a name="line.208"></a>
<span class="sourceLineNo">209</span>}<a name="line.209"></a>
</pre>
</div>
</body>
</html>