blob: 728c1a9d31565496319c126697b6f46c6df4c6bf [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.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.trace.HBaseSemanticAttributes.BLOCK_CACHE_KEY_KEY;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import io.opentelemetry.api.common.Attributes;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import io.opentelemetry.api.trace.Span;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.io.DataInput;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.io.IOException;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.nio.ByteBuffer;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.ArrayList;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.Optional;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hadoop.conf.Configurable;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.conf.Configuration;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.fs.Path;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.ByteBufferKeyOnlyKeyValue;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.Cell;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.CellComparator;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.CellUtil;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.HConstants;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.KeyValue;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.PrivateCellUtil;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.SizeCachedByteBufferKeyValue;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.SizeCachedKeyValue;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.SizeCachedNoTagsByteBufferKeyValue;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.SizeCachedNoTagsKeyValue;<a name="line.42"></a>
<span class="sourceLineNo">043</span>import org.apache.hadoop.hbase.io.compress.Compression;<a name="line.43"></a>
<span class="sourceLineNo">044</span>import org.apache.hadoop.hbase.io.encoding.DataBlockEncoder;<a name="line.44"></a>
<span class="sourceLineNo">045</span>import org.apache.hadoop.hbase.io.encoding.DataBlockEncoding;<a name="line.45"></a>
<span class="sourceLineNo">046</span>import org.apache.hadoop.hbase.io.encoding.HFileBlockDecodingContext;<a name="line.46"></a>
<span class="sourceLineNo">047</span>import org.apache.hadoop.hbase.nio.ByteBuff;<a name="line.47"></a>
<span class="sourceLineNo">048</span>import org.apache.hadoop.hbase.regionserver.KeyValueScanner;<a name="line.48"></a>
<span class="sourceLineNo">049</span>import org.apache.hadoop.hbase.util.ByteBufferUtils;<a name="line.49"></a>
<span class="sourceLineNo">050</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.50"></a>
<span class="sourceLineNo">051</span>import org.apache.hadoop.hbase.util.IdLock;<a name="line.51"></a>
<span class="sourceLineNo">052</span>import org.apache.hadoop.hbase.util.ObjectIntPair;<a name="line.52"></a>
<span class="sourceLineNo">053</span>import org.apache.hadoop.io.WritableUtils;<a name="line.53"></a>
<span class="sourceLineNo">054</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.54"></a>
<span class="sourceLineNo">055</span>import org.slf4j.Logger;<a name="line.55"></a>
<span class="sourceLineNo">056</span>import org.slf4j.LoggerFactory;<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span>/**<a name="line.58"></a>
<span class="sourceLineNo">059</span> * Implementation that can handle all hfile versions of {@link HFile.Reader}.<a name="line.59"></a>
<span class="sourceLineNo">060</span> */<a name="line.60"></a>
<span class="sourceLineNo">061</span>@InterfaceAudience.Private<a name="line.61"></a>
<span class="sourceLineNo">062</span>@edu.umd.cs.findbugs.annotations.SuppressWarnings(value = "URF_UNREAD_PUBLIC_OR_PROTECTED_FIELD")<a name="line.62"></a>
<span class="sourceLineNo">063</span>public abstract class HFileReaderImpl implements HFile.Reader, Configurable {<a name="line.63"></a>
<span class="sourceLineNo">064</span> // This class is HFileReaderV3 + HFileReaderV2 + AbstractHFileReader all squashed together into<a name="line.64"></a>
<span class="sourceLineNo">065</span> // one file. Ditto for all the HFileReader.ScannerV? implementations. I was running up against<a name="line.65"></a>
<span class="sourceLineNo">066</span> // the MaxInlineLevel limit because too many tiers involved reading from an hfile. Was also hard<a name="line.66"></a>
<span class="sourceLineNo">067</span> // to navigate the source code when so many classes participating in read.<a name="line.67"></a>
<span class="sourceLineNo">068</span> private static final Logger LOG = LoggerFactory.getLogger(HFileReaderImpl.class);<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span> /** Data block index reader keeping the root data index in memory */<a name="line.70"></a>
<span class="sourceLineNo">071</span> protected HFileBlockIndex.CellBasedKeyBlockIndexReader dataBlockIndexReader;<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> /** Meta block index reader -- always single level */<a name="line.73"></a>
<span class="sourceLineNo">074</span> protected HFileBlockIndex.ByteArrayKeyBlockIndexReader metaBlockIndexReader;<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span> protected FixedFileTrailer trailer;<a name="line.76"></a>
<span class="sourceLineNo">077</span><a name="line.77"></a>
<span class="sourceLineNo">078</span> private final boolean primaryReplicaReader;<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> * What kind of data block encoding should be used while reading, writing, and handling cache.<a name="line.81"></a>
<span class="sourceLineNo">082</span> */<a name="line.82"></a>
<span class="sourceLineNo">083</span> protected HFileDataBlockEncoder dataBlockEncoder = NoOpDataBlockEncoder.INSTANCE;<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span> /** Block cache configuration. */<a name="line.85"></a>
<span class="sourceLineNo">086</span> protected final CacheConfig cacheConf;<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span> protected ReaderContext context;<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span> protected final HFileInfo fileInfo;<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span> /** Path of file */<a name="line.92"></a>
<span class="sourceLineNo">093</span> protected final Path path;<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span> /** File name to be used for block names */<a name="line.95"></a>
<span class="sourceLineNo">096</span> protected final String name;<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span> private Configuration conf;<a name="line.98"></a>
<span class="sourceLineNo">099</span><a name="line.99"></a>
<span class="sourceLineNo">100</span> protected HFileContext hfileContext;<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span> /** Filesystem-level block reader. */<a name="line.102"></a>
<span class="sourceLineNo">103</span> protected HFileBlock.FSReader fsBlockReader;<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> * A "sparse lock" implementation allowing to lock on a particular block identified by offset. The<a name="line.106"></a>
<span class="sourceLineNo">107</span> * purpose of this is to avoid two clients loading the same block, and have all but one client<a name="line.107"></a>
<span class="sourceLineNo">108</span> * wait to get the block from the cache.<a name="line.108"></a>
<span class="sourceLineNo">109</span> */<a name="line.109"></a>
<span class="sourceLineNo">110</span> private IdLock offsetLock = new IdLock();<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span> /** Minimum minor version supported by this HFile format */<a name="line.112"></a>
<span class="sourceLineNo">113</span> static final int MIN_MINOR_VERSION = 0;<a name="line.113"></a>
<span class="sourceLineNo">114</span><a name="line.114"></a>
<span class="sourceLineNo">115</span> /** Maximum minor version supported by this HFile format */<a name="line.115"></a>
<span class="sourceLineNo">116</span> // We went to version 2 when we moved to pb'ing fileinfo and the trailer on<a name="line.116"></a>
<span class="sourceLineNo">117</span> // the file. This version can read Writables version 1.<a name="line.117"></a>
<span class="sourceLineNo">118</span> static final int MAX_MINOR_VERSION = 3;<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span> /** Minor versions starting with this number have faked index key */<a name="line.120"></a>
<span class="sourceLineNo">121</span> static final int MINOR_VERSION_WITH_FAKED_KEY = 3;<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> * Opens a HFile.<a name="line.124"></a>
<span class="sourceLineNo">125</span> * @param context Reader context info<a name="line.125"></a>
<span class="sourceLineNo">126</span> * @param fileInfo HFile info<a name="line.126"></a>
<span class="sourceLineNo">127</span> * @param cacheConf Cache configuration.<a name="line.127"></a>
<span class="sourceLineNo">128</span> * @param conf Configuration<a name="line.128"></a>
<span class="sourceLineNo">129</span> */<a name="line.129"></a>
<span class="sourceLineNo">130</span> @edu.umd.cs.findbugs.annotations.SuppressWarnings(value = "URF_UNREAD_PUBLIC_OR_PROTECTED_FIELD")<a name="line.130"></a>
<span class="sourceLineNo">131</span> public HFileReaderImpl(ReaderContext context, HFileInfo fileInfo, CacheConfig cacheConf,<a name="line.131"></a>
<span class="sourceLineNo">132</span> Configuration conf) throws IOException {<a name="line.132"></a>
<span class="sourceLineNo">133</span> this.cacheConf = cacheConf;<a name="line.133"></a>
<span class="sourceLineNo">134</span> this.context = context;<a name="line.134"></a>
<span class="sourceLineNo">135</span> this.path = context.getFilePath();<a name="line.135"></a>
<span class="sourceLineNo">136</span> this.name = path.getName();<a name="line.136"></a>
<span class="sourceLineNo">137</span> this.conf = conf;<a name="line.137"></a>
<span class="sourceLineNo">138</span> this.primaryReplicaReader = context.isPrimaryReplicaReader();<a name="line.138"></a>
<span class="sourceLineNo">139</span> this.fileInfo = fileInfo;<a name="line.139"></a>
<span class="sourceLineNo">140</span> this.trailer = fileInfo.getTrailer();<a name="line.140"></a>
<span class="sourceLineNo">141</span> this.hfileContext = fileInfo.getHFileContext();<a name="line.141"></a>
<span class="sourceLineNo">142</span> this.fsBlockReader =<a name="line.142"></a>
<span class="sourceLineNo">143</span> new HFileBlock.FSReaderImpl(context, hfileContext, cacheConf.getByteBuffAllocator(), conf);<a name="line.143"></a>
<span class="sourceLineNo">144</span> this.dataBlockEncoder = HFileDataBlockEncoderImpl.createFromFileInfo(fileInfo);<a name="line.144"></a>
<span class="sourceLineNo">145</span> fsBlockReader.setDataBlockEncoder(dataBlockEncoder, conf);<a name="line.145"></a>
<span class="sourceLineNo">146</span> dataBlockIndexReader = fileInfo.getDataBlockIndexReader();<a name="line.146"></a>
<span class="sourceLineNo">147</span> metaBlockIndexReader = fileInfo.getMetaBlockIndexReader();<a name="line.147"></a>
<span class="sourceLineNo">148</span> }<a name="line.148"></a>
<span class="sourceLineNo">149</span><a name="line.149"></a>
<span class="sourceLineNo">150</span> @SuppressWarnings("serial")<a name="line.150"></a>
<span class="sourceLineNo">151</span> public static class BlockIndexNotLoadedException extends IllegalStateException {<a name="line.151"></a>
<span class="sourceLineNo">152</span> public BlockIndexNotLoadedException(Path path) {<a name="line.152"></a>
<span class="sourceLineNo">153</span> // Add a message in case anyone relies on it as opposed to class name.<a name="line.153"></a>
<span class="sourceLineNo">154</span> super(path + " block index not loaded");<a name="line.154"></a>
<span class="sourceLineNo">155</span> }<a name="line.155"></a>
<span class="sourceLineNo">156</span> }<a name="line.156"></a>
<span class="sourceLineNo">157</span><a name="line.157"></a>
<span class="sourceLineNo">158</span> private Optional&lt;String&gt; toStringFirstKey() {<a name="line.158"></a>
<span class="sourceLineNo">159</span> return getFirstKey().map(CellUtil::getCellKeyAsString);<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> private Optional&lt;String&gt; toStringLastKey() {<a name="line.162"></a>
<span class="sourceLineNo">163</span> return getLastKey().map(CellUtil::getCellKeyAsString);<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> @Override<a name="line.166"></a>
<span class="sourceLineNo">167</span> public String toString() {<a name="line.167"></a>
<span class="sourceLineNo">168</span> return "reader=" + path.toString()<a name="line.168"></a>
<span class="sourceLineNo">169</span> + (!isFileInfoLoaded()<a name="line.169"></a>
<span class="sourceLineNo">170</span> ? ""<a name="line.170"></a>
<span class="sourceLineNo">171</span> : ", compression=" + trailer.getCompressionCodec().getName() + ", cacheConf=" + cacheConf<a name="line.171"></a>
<span class="sourceLineNo">172</span> + ", firstKey=" + toStringFirstKey() + ", lastKey=" + toStringLastKey())<a name="line.172"></a>
<span class="sourceLineNo">173</span> + ", avgKeyLen=" + fileInfo.getAvgKeyLen() + ", avgValueLen=" + fileInfo.getAvgValueLen()<a name="line.173"></a>
<span class="sourceLineNo">174</span> + ", entries=" + trailer.getEntryCount() + ", length=" + context.getFileSize();<a name="line.174"></a>
<span class="sourceLineNo">175</span> }<a name="line.175"></a>
<span class="sourceLineNo">176</span><a name="line.176"></a>
<span class="sourceLineNo">177</span> @Override<a name="line.177"></a>
<span class="sourceLineNo">178</span> public long length() {<a name="line.178"></a>
<span class="sourceLineNo">179</span> return context.getFileSize();<a name="line.179"></a>
<span class="sourceLineNo">180</span> }<a name="line.180"></a>
<span class="sourceLineNo">181</span><a name="line.181"></a>
<span class="sourceLineNo">182</span> /**<a name="line.182"></a>
<span class="sourceLineNo">183</span> * @return the first key in the file. May be null if file has no entries. Note that this is not<a name="line.183"></a>
<span class="sourceLineNo">184</span> * the first row key, but rather the byte form of the first KeyValue.<a name="line.184"></a>
<span class="sourceLineNo">185</span> */<a name="line.185"></a>
<span class="sourceLineNo">186</span> @Override<a name="line.186"></a>
<span class="sourceLineNo">187</span> public Optional&lt;Cell&gt; getFirstKey() {<a name="line.187"></a>
<span class="sourceLineNo">188</span> if (dataBlockIndexReader == null) {<a name="line.188"></a>
<span class="sourceLineNo">189</span> throw new BlockIndexNotLoadedException(path);<a name="line.189"></a>
<span class="sourceLineNo">190</span> }<a name="line.190"></a>
<span class="sourceLineNo">191</span> return dataBlockIndexReader.isEmpty()<a name="line.191"></a>
<span class="sourceLineNo">192</span> ? Optional.empty()<a name="line.192"></a>
<span class="sourceLineNo">193</span> : Optional.of(dataBlockIndexReader.getRootBlockKey(0));<a name="line.193"></a>
<span class="sourceLineNo">194</span> }<a name="line.194"></a>
<span class="sourceLineNo">195</span><a name="line.195"></a>
<span class="sourceLineNo">196</span> /**<a name="line.196"></a>
<span class="sourceLineNo">197</span> * TODO left from {@link HFile} version 1: move this to StoreFile after Ryan's patch goes in to<a name="line.197"></a>
<span class="sourceLineNo">198</span> * eliminate {@link KeyValue} here.<a name="line.198"></a>
<span class="sourceLineNo">199</span> * @return the first row key, or null if the file is empty.<a name="line.199"></a>
<span class="sourceLineNo">200</span> */<a name="line.200"></a>
<span class="sourceLineNo">201</span> @Override<a name="line.201"></a>
<span class="sourceLineNo">202</span> public Optional&lt;byte[]&gt; getFirstRowKey() {<a name="line.202"></a>
<span class="sourceLineNo">203</span> // We have to copy the row part to form the row key alone<a name="line.203"></a>
<span class="sourceLineNo">204</span> return getFirstKey().map(CellUtil::cloneRow);<a name="line.204"></a>
<span class="sourceLineNo">205</span> }<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> * TODO left from {@link HFile} version 1: move this to StoreFile after Ryan's patch goes in to<a name="line.208"></a>
<span class="sourceLineNo">209</span> * eliminate {@link KeyValue} here.<a name="line.209"></a>
<span class="sourceLineNo">210</span> * @return the last row key, or null if the file is empty.<a name="line.210"></a>
<span class="sourceLineNo">211</span> */<a name="line.211"></a>
<span class="sourceLineNo">212</span> @Override<a name="line.212"></a>
<span class="sourceLineNo">213</span> public Optional&lt;byte[]&gt; getLastRowKey() {<a name="line.213"></a>
<span class="sourceLineNo">214</span> // We have to copy the row part to form the row key alone<a name="line.214"></a>
<span class="sourceLineNo">215</span> return getLastKey().map(CellUtil::cloneRow);<a name="line.215"></a>
<span class="sourceLineNo">216</span> }<a name="line.216"></a>
<span class="sourceLineNo">217</span><a name="line.217"></a>
<span class="sourceLineNo">218</span> /** Returns number of KV entries in this HFile */<a name="line.218"></a>
<span class="sourceLineNo">219</span> @Override<a name="line.219"></a>
<span class="sourceLineNo">220</span> public long getEntries() {<a name="line.220"></a>
<span class="sourceLineNo">221</span> return trailer.getEntryCount();<a name="line.221"></a>
<span class="sourceLineNo">222</span> }<a name="line.222"></a>
<span class="sourceLineNo">223</span><a name="line.223"></a>
<span class="sourceLineNo">224</span> /** Returns comparator */<a name="line.224"></a>
<span class="sourceLineNo">225</span> @Override<a name="line.225"></a>
<span class="sourceLineNo">226</span> public CellComparator getComparator() {<a name="line.226"></a>
<span class="sourceLineNo">227</span> return this.hfileContext.getCellComparator();<a name="line.227"></a>
<span class="sourceLineNo">228</span> }<a name="line.228"></a>
<span class="sourceLineNo">229</span><a name="line.229"></a>
<span class="sourceLineNo">230</span> public Compression.Algorithm getCompressionAlgorithm() {<a name="line.230"></a>
<span class="sourceLineNo">231</span> return trailer.getCompressionCodec();<a name="line.231"></a>
<span class="sourceLineNo">232</span> }<a name="line.232"></a>
<span class="sourceLineNo">233</span><a name="line.233"></a>
<span class="sourceLineNo">234</span> /**<a name="line.234"></a>
<span class="sourceLineNo">235</span> * @return the total heap size of data and meta block indexes in bytes. Does not take into account<a name="line.235"></a>
<span class="sourceLineNo">236</span> * non-root blocks of a multilevel data index.<a name="line.236"></a>
<span class="sourceLineNo">237</span> */<a name="line.237"></a>
<span class="sourceLineNo">238</span> @Override<a name="line.238"></a>
<span class="sourceLineNo">239</span> public long indexSize() {<a name="line.239"></a>
<span class="sourceLineNo">240</span> return (dataBlockIndexReader != null ? dataBlockIndexReader.heapSize() : 0)<a name="line.240"></a>
<span class="sourceLineNo">241</span> + ((metaBlockIndexReader != null) ? metaBlockIndexReader.heapSize() : 0);<a name="line.241"></a>
<span class="sourceLineNo">242</span> }<a name="line.242"></a>
<span class="sourceLineNo">243</span><a name="line.243"></a>
<span class="sourceLineNo">244</span> @Override<a name="line.244"></a>
<span class="sourceLineNo">245</span> public String getName() {<a name="line.245"></a>
<span class="sourceLineNo">246</span> return name;<a name="line.246"></a>
<span class="sourceLineNo">247</span> }<a name="line.247"></a>
<span class="sourceLineNo">248</span><a name="line.248"></a>
<span class="sourceLineNo">249</span> @Override<a name="line.249"></a>
<span class="sourceLineNo">250</span> public void setDataBlockEncoder(HFileDataBlockEncoder dataBlockEncoder) {<a name="line.250"></a>
<span class="sourceLineNo">251</span> this.dataBlockEncoder = dataBlockEncoder;<a name="line.251"></a>
<span class="sourceLineNo">252</span> this.fsBlockReader.setDataBlockEncoder(dataBlockEncoder, conf);<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> @Override<a name="line.255"></a>
<span class="sourceLineNo">256</span> public void setDataBlockIndexReader(HFileBlockIndex.CellBasedKeyBlockIndexReader reader) {<a name="line.256"></a>
<span class="sourceLineNo">257</span> this.dataBlockIndexReader = reader;<a name="line.257"></a>
<span class="sourceLineNo">258</span> }<a name="line.258"></a>
<span class="sourceLineNo">259</span><a name="line.259"></a>
<span class="sourceLineNo">260</span> @Override<a name="line.260"></a>
<span class="sourceLineNo">261</span> public HFileBlockIndex.CellBasedKeyBlockIndexReader getDataBlockIndexReader() {<a name="line.261"></a>
<span class="sourceLineNo">262</span> return dataBlockIndexReader;<a name="line.262"></a>
<span class="sourceLineNo">263</span> }<a name="line.263"></a>
<span class="sourceLineNo">264</span><a name="line.264"></a>
<span class="sourceLineNo">265</span> @Override<a name="line.265"></a>
<span class="sourceLineNo">266</span> public void setMetaBlockIndexReader(HFileBlockIndex.ByteArrayKeyBlockIndexReader reader) {<a name="line.266"></a>
<span class="sourceLineNo">267</span> this.metaBlockIndexReader = reader;<a name="line.267"></a>
<span class="sourceLineNo">268</span> }<a name="line.268"></a>
<span class="sourceLineNo">269</span><a name="line.269"></a>
<span class="sourceLineNo">270</span> @Override<a name="line.270"></a>
<span class="sourceLineNo">271</span> public HFileBlockIndex.ByteArrayKeyBlockIndexReader getMetaBlockIndexReader() {<a name="line.271"></a>
<span class="sourceLineNo">272</span> return metaBlockIndexReader;<a name="line.272"></a>
<span class="sourceLineNo">273</span> }<a name="line.273"></a>
<span class="sourceLineNo">274</span><a name="line.274"></a>
<span class="sourceLineNo">275</span> @Override<a name="line.275"></a>
<span class="sourceLineNo">276</span> public FixedFileTrailer getTrailer() {<a name="line.276"></a>
<span class="sourceLineNo">277</span> return trailer;<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> @Override<a name="line.280"></a>
<span class="sourceLineNo">281</span> public ReaderContext getContext() {<a name="line.281"></a>
<span class="sourceLineNo">282</span> return this.context;<a name="line.282"></a>
<span class="sourceLineNo">283</span> }<a name="line.283"></a>
<span class="sourceLineNo">284</span><a name="line.284"></a>
<span class="sourceLineNo">285</span> @Override<a name="line.285"></a>
<span class="sourceLineNo">286</span> public HFileInfo getHFileInfo() {<a name="line.286"></a>
<span class="sourceLineNo">287</span> return this.fileInfo;<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> @Override<a name="line.290"></a>
<span class="sourceLineNo">291</span> public boolean isPrimaryReplicaReader() {<a name="line.291"></a>
<span class="sourceLineNo">292</span> return primaryReplicaReader;<a name="line.292"></a>
<span class="sourceLineNo">293</span> }<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> * An exception thrown when an operation requiring a scanner to be seeked is invoked on a scanner<a name="line.296"></a>
<span class="sourceLineNo">297</span> * that is not seeked.<a name="line.297"></a>
<span class="sourceLineNo">298</span> */<a name="line.298"></a>
<span class="sourceLineNo">299</span> @SuppressWarnings("serial")<a name="line.299"></a>
<span class="sourceLineNo">300</span> public static class NotSeekedException extends IllegalStateException {<a name="line.300"></a>
<span class="sourceLineNo">301</span> public NotSeekedException(Path path) {<a name="line.301"></a>
<span class="sourceLineNo">302</span> super(path + " not seeked to a key/value");<a name="line.302"></a>
<span class="sourceLineNo">303</span> }<a name="line.303"></a>
<span class="sourceLineNo">304</span> }<a name="line.304"></a>
<span class="sourceLineNo">305</span><a name="line.305"></a>
<span class="sourceLineNo">306</span> protected static class HFileScannerImpl implements HFileScanner {<a name="line.306"></a>
<span class="sourceLineNo">307</span> private ByteBuff blockBuffer;<a name="line.307"></a>
<span class="sourceLineNo">308</span> protected final boolean cacheBlocks;<a name="line.308"></a>
<span class="sourceLineNo">309</span> protected final boolean pread;<a name="line.309"></a>
<span class="sourceLineNo">310</span> protected final boolean isCompaction;<a name="line.310"></a>
<span class="sourceLineNo">311</span> private int currKeyLen;<a name="line.311"></a>
<span class="sourceLineNo">312</span> private int currValueLen;<a name="line.312"></a>
<span class="sourceLineNo">313</span> private int currMemstoreTSLen;<a name="line.313"></a>
<span class="sourceLineNo">314</span> private long currMemstoreTS;<a name="line.314"></a>
<span class="sourceLineNo">315</span> protected final HFile.Reader reader;<a name="line.315"></a>
<span class="sourceLineNo">316</span> private int currTagsLen;<a name="line.316"></a>
<span class="sourceLineNo">317</span> private short rowLen;<a name="line.317"></a>
<span class="sourceLineNo">318</span> // buffer backed keyonlyKV<a name="line.318"></a>
<span class="sourceLineNo">319</span> private ByteBufferKeyOnlyKeyValue bufBackedKeyOnlyKv = new ByteBufferKeyOnlyKeyValue();<a name="line.319"></a>
<span class="sourceLineNo">320</span> // A pair for reusing in blockSeek() so that we don't garbage lot of objects<a name="line.320"></a>
<span class="sourceLineNo">321</span> final ObjectIntPair&lt;ByteBuffer&gt; pair = new ObjectIntPair&lt;&gt;();<a name="line.321"></a>
<span class="sourceLineNo">322</span><a name="line.322"></a>
<span class="sourceLineNo">323</span> /**<a name="line.323"></a>
<span class="sourceLineNo">324</span> * The next indexed key is to keep track of the indexed key of the next data block. If the<a name="line.324"></a>
<span class="sourceLineNo">325</span> * nextIndexedKey is HConstants.NO_NEXT_INDEXED_KEY, it means that the current data block is the<a name="line.325"></a>
<span class="sourceLineNo">326</span> * last data block. If the nextIndexedKey is null, it means the nextIndexedKey has not been<a name="line.326"></a>
<span class="sourceLineNo">327</span> * loaded yet.<a name="line.327"></a>
<span class="sourceLineNo">328</span> */<a name="line.328"></a>
<span class="sourceLineNo">329</span> protected Cell nextIndexedKey;<a name="line.329"></a>
<span class="sourceLineNo">330</span> // Current block being used. NOTICE: DON't release curBlock separately except in shipped() or<a name="line.330"></a>
<span class="sourceLineNo">331</span> // close() methods. Because the shipped() or close() will do the release finally, even if any<a name="line.331"></a>
<span class="sourceLineNo">332</span> // exception occur the curBlock will be released by the close() method (see<a name="line.332"></a>
<span class="sourceLineNo">333</span> // RegionScannerImpl#handleException). Call the releaseIfNotCurBlock() to release the<a name="line.333"></a>
<span class="sourceLineNo">334</span> // unreferenced block please.<a name="line.334"></a>
<span class="sourceLineNo">335</span> protected HFileBlock curBlock;<a name="line.335"></a>
<span class="sourceLineNo">336</span> // Previous blocks that were used in the course of the read<a name="line.336"></a>
<span class="sourceLineNo">337</span> protected final ArrayList&lt;HFileBlock&gt; prevBlocks = new ArrayList&lt;&gt;();<a name="line.337"></a>
<span class="sourceLineNo">338</span><a name="line.338"></a>
<span class="sourceLineNo">339</span> public HFileScannerImpl(final HFile.Reader reader, final boolean cacheBlocks,<a name="line.339"></a>
<span class="sourceLineNo">340</span> final boolean pread, final boolean isCompaction) {<a name="line.340"></a>
<span class="sourceLineNo">341</span> this.reader = reader;<a name="line.341"></a>
<span class="sourceLineNo">342</span> this.cacheBlocks = cacheBlocks;<a name="line.342"></a>
<span class="sourceLineNo">343</span> this.pread = pread;<a name="line.343"></a>
<span class="sourceLineNo">344</span> this.isCompaction = isCompaction;<a name="line.344"></a>
<span class="sourceLineNo">345</span> }<a name="line.345"></a>
<span class="sourceLineNo">346</span><a name="line.346"></a>
<span class="sourceLineNo">347</span> void updateCurrBlockRef(HFileBlock block) {<a name="line.347"></a>
<span class="sourceLineNo">348</span> if (block != null &amp;&amp; curBlock != null &amp;&amp; block.getOffset() == curBlock.getOffset()) {<a name="line.348"></a>
<span class="sourceLineNo">349</span> return;<a name="line.349"></a>
<span class="sourceLineNo">350</span> }<a name="line.350"></a>
<span class="sourceLineNo">351</span> if (this.curBlock != null &amp;&amp; this.curBlock.isSharedMem()) {<a name="line.351"></a>
<span class="sourceLineNo">352</span> prevBlocks.add(this.curBlock);<a name="line.352"></a>
<span class="sourceLineNo">353</span> }<a name="line.353"></a>
<span class="sourceLineNo">354</span> this.curBlock = block;<a name="line.354"></a>
<span class="sourceLineNo">355</span> }<a name="line.355"></a>
<span class="sourceLineNo">356</span><a name="line.356"></a>
<span class="sourceLineNo">357</span> void reset() {<a name="line.357"></a>
<span class="sourceLineNo">358</span> // We don't have to keep ref to heap block<a name="line.358"></a>
<span class="sourceLineNo">359</span> if (this.curBlock != null &amp;&amp; this.curBlock.isSharedMem()) {<a name="line.359"></a>
<span class="sourceLineNo">360</span> this.prevBlocks.add(this.curBlock);<a name="line.360"></a>
<span class="sourceLineNo">361</span> }<a name="line.361"></a>
<span class="sourceLineNo">362</span> this.curBlock = null;<a name="line.362"></a>
<span class="sourceLineNo">363</span> }<a name="line.363"></a>
<span class="sourceLineNo">364</span><a name="line.364"></a>
<span class="sourceLineNo">365</span> private void returnBlocks(boolean returnAll) {<a name="line.365"></a>
<span class="sourceLineNo">366</span> this.prevBlocks.forEach(HFileBlock::release);<a name="line.366"></a>
<span class="sourceLineNo">367</span> this.prevBlocks.clear();<a name="line.367"></a>
<span class="sourceLineNo">368</span> if (returnAll &amp;&amp; this.curBlock != null) {<a name="line.368"></a>
<span class="sourceLineNo">369</span> this.curBlock.release();<a name="line.369"></a>
<span class="sourceLineNo">370</span> this.curBlock = null;<a name="line.370"></a>
<span class="sourceLineNo">371</span> }<a name="line.371"></a>
<span class="sourceLineNo">372</span> }<a name="line.372"></a>
<span class="sourceLineNo">373</span><a name="line.373"></a>
<span class="sourceLineNo">374</span> @Override<a name="line.374"></a>
<span class="sourceLineNo">375</span> public boolean isSeeked() {<a name="line.375"></a>
<span class="sourceLineNo">376</span> return blockBuffer != null;<a name="line.376"></a>
<span class="sourceLineNo">377</span> }<a name="line.377"></a>
<span class="sourceLineNo">378</span><a name="line.378"></a>
<span class="sourceLineNo">379</span> @Override<a name="line.379"></a>
<span class="sourceLineNo">380</span> public String toString() {<a name="line.380"></a>
<span class="sourceLineNo">381</span> return "HFileScanner for reader " + String.valueOf(getReader());<a name="line.381"></a>
<span class="sourceLineNo">382</span> }<a name="line.382"></a>
<span class="sourceLineNo">383</span><a name="line.383"></a>
<span class="sourceLineNo">384</span> protected void assertSeeked() {<a name="line.384"></a>
<span class="sourceLineNo">385</span> if (!isSeeked()) {<a name="line.385"></a>
<span class="sourceLineNo">386</span> throw new NotSeekedException(reader.getPath());<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><a name="line.389"></a>
<span class="sourceLineNo">390</span> @Override<a name="line.390"></a>
<span class="sourceLineNo">391</span> public HFile.Reader getReader() {<a name="line.391"></a>
<span class="sourceLineNo">392</span> return reader;<a name="line.392"></a>
<span class="sourceLineNo">393</span> }<a name="line.393"></a>
<span class="sourceLineNo">394</span><a name="line.394"></a>
<span class="sourceLineNo">395</span> // From non encoded HFiles, we always read back KeyValue or its descendant.(Note: When HFile<a name="line.395"></a>
<span class="sourceLineNo">396</span> // block is in DBB, it will be OffheapKV). So all parts of the Cell is in a contiguous<a name="line.396"></a>
<span class="sourceLineNo">397</span> // array/buffer. How many bytes we should wrap to make the KV is what this method returns.<a name="line.397"></a>
<span class="sourceLineNo">398</span> private int getKVBufSize() {<a name="line.398"></a>
<span class="sourceLineNo">399</span> int kvBufSize = KEY_VALUE_LEN_SIZE + currKeyLen + currValueLen;<a name="line.399"></a>
<span class="sourceLineNo">400</span> if (currTagsLen &gt; 0) {<a name="line.400"></a>
<span class="sourceLineNo">401</span> kvBufSize += Bytes.SIZEOF_SHORT + currTagsLen;<a name="line.401"></a>
<span class="sourceLineNo">402</span> }<a name="line.402"></a>
<span class="sourceLineNo">403</span> return kvBufSize;<a name="line.403"></a>
<span class="sourceLineNo">404</span> }<a name="line.404"></a>
<span class="sourceLineNo">405</span><a name="line.405"></a>
<span class="sourceLineNo">406</span> @Override<a name="line.406"></a>
<span class="sourceLineNo">407</span> public void close() {<a name="line.407"></a>
<span class="sourceLineNo">408</span> if (!pread) {<a name="line.408"></a>
<span class="sourceLineNo">409</span> // For seek + pread stream socket should be closed when the scanner is closed. HBASE-9393<a name="line.409"></a>
<span class="sourceLineNo">410</span> reader.unbufferStream();<a name="line.410"></a>
<span class="sourceLineNo">411</span> }<a name="line.411"></a>
<span class="sourceLineNo">412</span> this.returnBlocks(true);<a name="line.412"></a>
<span class="sourceLineNo">413</span> }<a name="line.413"></a>
<span class="sourceLineNo">414</span><a name="line.414"></a>
<span class="sourceLineNo">415</span> // Returns the #bytes in HFile for the current cell. Used to skip these many bytes in current<a name="line.415"></a>
<span class="sourceLineNo">416</span> // HFile block's buffer so as to position to the next cell.<a name="line.416"></a>
<span class="sourceLineNo">417</span> private int getCurCellSerializedSize() {<a name="line.417"></a>
<span class="sourceLineNo">418</span> int curCellSize = KEY_VALUE_LEN_SIZE + currKeyLen + currValueLen + currMemstoreTSLen;<a name="line.418"></a>
<span class="sourceLineNo">419</span> if (this.reader.getFileContext().isIncludesTags()) {<a name="line.419"></a>
<span class="sourceLineNo">420</span> curCellSize += Bytes.SIZEOF_SHORT + currTagsLen;<a name="line.420"></a>
<span class="sourceLineNo">421</span> }<a name="line.421"></a>
<span class="sourceLineNo">422</span> return curCellSize;<a name="line.422"></a>
<span class="sourceLineNo">423</span> }<a name="line.423"></a>
<span class="sourceLineNo">424</span><a name="line.424"></a>
<span class="sourceLineNo">425</span> protected void readKeyValueLen() {<a name="line.425"></a>
<span class="sourceLineNo">426</span> // This is a hot method. We go out of our way to make this method short so it can be<a name="line.426"></a>
<span class="sourceLineNo">427</span> // inlined and is not too big to compile. We also manage position in ByteBuffer ourselves<a name="line.427"></a>
<span class="sourceLineNo">428</span> // because it is faster than going via range-checked ByteBuffer methods or going through a<a name="line.428"></a>
<span class="sourceLineNo">429</span> // byte buffer array a byte at a time.<a name="line.429"></a>
<span class="sourceLineNo">430</span> // Get a long at a time rather than read two individual ints. In micro-benchmarking, even<a name="line.430"></a>
<span class="sourceLineNo">431</span> // with the extra bit-fiddling, this is order-of-magnitude faster than getting two ints.<a name="line.431"></a>
<span class="sourceLineNo">432</span> // Trying to imitate what was done - need to profile if this is better or<a name="line.432"></a>
<span class="sourceLineNo">433</span> // earlier way is better by doing mark and reset?<a name="line.433"></a>
<span class="sourceLineNo">434</span> // But ensure that you read long instead of two ints<a name="line.434"></a>
<span class="sourceLineNo">435</span> long ll = blockBuffer.getLongAfterPosition(0);<a name="line.435"></a>
<span class="sourceLineNo">436</span> // Read top half as an int of key length and bottom int as value length<a name="line.436"></a>
<span class="sourceLineNo">437</span> this.currKeyLen = (int) (ll &gt;&gt; Integer.SIZE);<a name="line.437"></a>
<span class="sourceLineNo">438</span> this.currValueLen = (int) (Bytes.MASK_FOR_LOWER_INT_IN_LONG ^ ll);<a name="line.438"></a>
<span class="sourceLineNo">439</span> checkKeyValueLen();<a name="line.439"></a>
<span class="sourceLineNo">440</span> this.rowLen = blockBuffer.getShortAfterPosition(Bytes.SIZEOF_LONG);<a name="line.440"></a>
<span class="sourceLineNo">441</span> // Move position past the key and value lengths and then beyond the key and value<a name="line.441"></a>
<span class="sourceLineNo">442</span> int p = (Bytes.SIZEOF_LONG + currKeyLen + currValueLen);<a name="line.442"></a>
<span class="sourceLineNo">443</span> if (reader.getFileContext().isIncludesTags()) {<a name="line.443"></a>
<span class="sourceLineNo">444</span> // Tags length is a short.<a name="line.444"></a>
<span class="sourceLineNo">445</span> this.currTagsLen = blockBuffer.getShortAfterPosition(p);<a name="line.445"></a>
<span class="sourceLineNo">446</span> checkTagsLen();<a name="line.446"></a>
<span class="sourceLineNo">447</span> p += (Bytes.SIZEOF_SHORT + currTagsLen);<a name="line.447"></a>
<span class="sourceLineNo">448</span> }<a name="line.448"></a>
<span class="sourceLineNo">449</span> readMvccVersion(p);<a name="line.449"></a>
<span class="sourceLineNo">450</span> }<a name="line.450"></a>
<span class="sourceLineNo">451</span><a name="line.451"></a>
<span class="sourceLineNo">452</span> private final void checkTagsLen() {<a name="line.452"></a>
<span class="sourceLineNo">453</span> if (checkLen(this.currTagsLen)) {<a name="line.453"></a>
<span class="sourceLineNo">454</span> throw new IllegalStateException(<a name="line.454"></a>
<span class="sourceLineNo">455</span> "Invalid currTagsLen " + this.currTagsLen + ". Block offset: " + curBlock.getOffset()<a name="line.455"></a>
<span class="sourceLineNo">456</span> + ", block length: " + this.blockBuffer.limit() + ", position: "<a name="line.456"></a>
<span class="sourceLineNo">457</span> + this.blockBuffer.position() + " (without header)." + " path=" + reader.getPath());<a name="line.457"></a>
<span class="sourceLineNo">458</span> }<a name="line.458"></a>
<span class="sourceLineNo">459</span> }<a name="line.459"></a>
<span class="sourceLineNo">460</span><a name="line.460"></a>
<span class="sourceLineNo">461</span> /**<a name="line.461"></a>
<span class="sourceLineNo">462</span> * Read mvcc. Does checks to see if we even need to read the mvcc at all.<a name="line.462"></a>
<span class="sourceLineNo">463</span> */<a name="line.463"></a>
<span class="sourceLineNo">464</span> protected void readMvccVersion(final int offsetFromPos) {<a name="line.464"></a>
<span class="sourceLineNo">465</span> // See if we even need to decode mvcc.<a name="line.465"></a>
<span class="sourceLineNo">466</span> if (!this.reader.getHFileInfo().shouldIncludeMemStoreTS()) {<a name="line.466"></a>
<span class="sourceLineNo">467</span> return;<a name="line.467"></a>
<span class="sourceLineNo">468</span> }<a name="line.468"></a>
<span class="sourceLineNo">469</span> if (!this.reader.getHFileInfo().isDecodeMemstoreTS()) {<a name="line.469"></a>
<span class="sourceLineNo">470</span> currMemstoreTS = 0;<a name="line.470"></a>
<span class="sourceLineNo">471</span> currMemstoreTSLen = 1;<a name="line.471"></a>
<span class="sourceLineNo">472</span> return;<a name="line.472"></a>
<span class="sourceLineNo">473</span> }<a name="line.473"></a>
<span class="sourceLineNo">474</span> _readMvccVersion(offsetFromPos);<a name="line.474"></a>
<span class="sourceLineNo">475</span> }<a name="line.475"></a>
<span class="sourceLineNo">476</span><a name="line.476"></a>
<span class="sourceLineNo">477</span> /**<a name="line.477"></a>
<span class="sourceLineNo">478</span> * Actually do the mvcc read. Does no checks.<a name="line.478"></a>
<span class="sourceLineNo">479</span> */<a name="line.479"></a>
<span class="sourceLineNo">480</span> private void _readMvccVersion(int offsetFromPos) {<a name="line.480"></a>
<span class="sourceLineNo">481</span> // This is Bytes#bytesToVint inlined so can save a few instructions in this hot method; i.e.<a name="line.481"></a>
<span class="sourceLineNo">482</span> // previous if one-byte vint, we'd redo the vint call to find int size.<a name="line.482"></a>
<span class="sourceLineNo">483</span> // Also the method is kept small so can be inlined.<a name="line.483"></a>
<span class="sourceLineNo">484</span> byte firstByte = blockBuffer.getByteAfterPosition(offsetFromPos);<a name="line.484"></a>
<span class="sourceLineNo">485</span> int len = WritableUtils.decodeVIntSize(firstByte);<a name="line.485"></a>
<span class="sourceLineNo">486</span> if (len == 1) {<a name="line.486"></a>
<span class="sourceLineNo">487</span> this.currMemstoreTS = firstByte;<a name="line.487"></a>
<span class="sourceLineNo">488</span> } else {<a name="line.488"></a>
<span class="sourceLineNo">489</span> int remaining = len - 1;<a name="line.489"></a>
<span class="sourceLineNo">490</span> long i = 0;<a name="line.490"></a>
<span class="sourceLineNo">491</span> offsetFromPos++;<a name="line.491"></a>
<span class="sourceLineNo">492</span> if (remaining &gt;= Bytes.SIZEOF_INT) {<a name="line.492"></a>
<span class="sourceLineNo">493</span> // The int read has to be converted to unsigned long so the &amp; op<a name="line.493"></a>
<span class="sourceLineNo">494</span> i = (blockBuffer.getIntAfterPosition(offsetFromPos) &amp; 0x00000000ffffffffL);<a name="line.494"></a>
<span class="sourceLineNo">495</span> remaining -= Bytes.SIZEOF_INT;<a name="line.495"></a>
<span class="sourceLineNo">496</span> offsetFromPos += Bytes.SIZEOF_INT;<a name="line.496"></a>
<span class="sourceLineNo">497</span> }<a name="line.497"></a>
<span class="sourceLineNo">498</span> if (remaining &gt;= Bytes.SIZEOF_SHORT) {<a name="line.498"></a>
<span class="sourceLineNo">499</span> short s = blockBuffer.getShortAfterPosition(offsetFromPos);<a name="line.499"></a>
<span class="sourceLineNo">500</span> i = i &lt;&lt; 16;<a name="line.500"></a>
<span class="sourceLineNo">501</span> i = i | (s &amp; 0xFFFF);<a name="line.501"></a>
<span class="sourceLineNo">502</span> remaining -= Bytes.SIZEOF_SHORT;<a name="line.502"></a>
<span class="sourceLineNo">503</span> offsetFromPos += Bytes.SIZEOF_SHORT;<a name="line.503"></a>
<span class="sourceLineNo">504</span> }<a name="line.504"></a>
<span class="sourceLineNo">505</span> for (int idx = 0; idx &lt; remaining; idx++) {<a name="line.505"></a>
<span class="sourceLineNo">506</span> byte b = blockBuffer.getByteAfterPosition(offsetFromPos + idx);<a name="line.506"></a>
<span class="sourceLineNo">507</span> i = i &lt;&lt; 8;<a name="line.507"></a>
<span class="sourceLineNo">508</span> i = i | (b &amp; 0xFF);<a name="line.508"></a>
<span class="sourceLineNo">509</span> }<a name="line.509"></a>
<span class="sourceLineNo">510</span> currMemstoreTS = (WritableUtils.isNegativeVInt(firstByte) ? ~i : i);<a name="line.510"></a>
<span class="sourceLineNo">511</span> }<a name="line.511"></a>
<span class="sourceLineNo">512</span> this.currMemstoreTSLen = len;<a name="line.512"></a>
<span class="sourceLineNo">513</span> }<a name="line.513"></a>
<span class="sourceLineNo">514</span><a name="line.514"></a>
<span class="sourceLineNo">515</span> /**<a name="line.515"></a>
<span class="sourceLineNo">516</span> * Within a loaded block, seek looking for the last key that is smaller than (or equal to?) the<a name="line.516"></a>
<span class="sourceLineNo">517</span> * key we are interested in. A note on the seekBefore: if you have seekBefore = true, AND the<a name="line.517"></a>
<span class="sourceLineNo">518</span> * first key in the block = key, then you'll get thrown exceptions. The caller has to check for<a name="line.518"></a>
<span class="sourceLineNo">519</span> * that case and load the previous block as appropriate. n * the key to find n * find the key<a name="line.519"></a>
<span class="sourceLineNo">520</span> * before the given key in case of exact match.<a name="line.520"></a>
<span class="sourceLineNo">521</span> * @return 0 in case of an exact key match, 1 in case of an inexact match, -2 in case of an<a name="line.521"></a>
<span class="sourceLineNo">522</span> * inexact match and furthermore, the input key less than the first key of current<a name="line.522"></a>
<span class="sourceLineNo">523</span> * block(e.g. using a faked index key)<a name="line.523"></a>
<span class="sourceLineNo">524</span> */<a name="line.524"></a>
<span class="sourceLineNo">525</span> protected int blockSeek(Cell key, boolean seekBefore) {<a name="line.525"></a>
<span class="sourceLineNo">526</span> int klen, vlen, tlen = 0;<a name="line.526"></a>
<span class="sourceLineNo">527</span> int lastKeyValueSize = -1;<a name="line.527"></a>
<span class="sourceLineNo">528</span> int offsetFromPos;<a name="line.528"></a>
<span class="sourceLineNo">529</span> do {<a name="line.529"></a>
<span class="sourceLineNo">530</span> offsetFromPos = 0;<a name="line.530"></a>
<span class="sourceLineNo">531</span> // Better to ensure that we use the BB Utils here<a name="line.531"></a>
<span class="sourceLineNo">532</span> long ll = blockBuffer.getLongAfterPosition(offsetFromPos);<a name="line.532"></a>
<span class="sourceLineNo">533</span> klen = (int) (ll &gt;&gt; Integer.SIZE);<a name="line.533"></a>
<span class="sourceLineNo">534</span> vlen = (int) (Bytes.MASK_FOR_LOWER_INT_IN_LONG ^ ll);<a name="line.534"></a>
<span class="sourceLineNo">535</span> if (checkKeyLen(klen) || checkLen(vlen)) {<a name="line.535"></a>
<span class="sourceLineNo">536</span> throw new IllegalStateException(<a name="line.536"></a>
<span class="sourceLineNo">537</span> "Invalid klen " + klen + " or vlen " + vlen + ". Block offset: " + curBlock.getOffset()<a name="line.537"></a>
<span class="sourceLineNo">538</span> + ", block length: " + blockBuffer.limit() + ", position: " + blockBuffer.position()<a name="line.538"></a>
<span class="sourceLineNo">539</span> + " (without header)." + " path=" + reader.getPath());<a name="line.539"></a>
<span class="sourceLineNo">540</span> }<a name="line.540"></a>
<span class="sourceLineNo">541</span> offsetFromPos += Bytes.SIZEOF_LONG;<a name="line.541"></a>
<span class="sourceLineNo">542</span> this.rowLen = blockBuffer.getShortAfterPosition(offsetFromPos);<a name="line.542"></a>
<span class="sourceLineNo">543</span> blockBuffer.asSubByteBuffer(blockBuffer.position() + offsetFromPos, klen, pair);<a name="line.543"></a>
<span class="sourceLineNo">544</span> bufBackedKeyOnlyKv.setKey(pair.getFirst(), pair.getSecond(), klen, rowLen);<a name="line.544"></a>
<span class="sourceLineNo">545</span> int comp =<a name="line.545"></a>
<span class="sourceLineNo">546</span> PrivateCellUtil.compareKeyIgnoresMvcc(reader.getComparator(), key, bufBackedKeyOnlyKv);<a name="line.546"></a>
<span class="sourceLineNo">547</span> offsetFromPos += klen + vlen;<a name="line.547"></a>
<span class="sourceLineNo">548</span> if (this.reader.getFileContext().isIncludesTags()) {<a name="line.548"></a>
<span class="sourceLineNo">549</span> // Read short as unsigned, high byte first<a name="line.549"></a>
<span class="sourceLineNo">550</span> tlen = ((blockBuffer.getByteAfterPosition(offsetFromPos) &amp; 0xff) &lt;&lt; 8)<a name="line.550"></a>
<span class="sourceLineNo">551</span> ^ (blockBuffer.getByteAfterPosition(offsetFromPos + 1) &amp; 0xff);<a name="line.551"></a>
<span class="sourceLineNo">552</span> if (checkLen(tlen)) {<a name="line.552"></a>
<span class="sourceLineNo">553</span> throw new IllegalStateException("Invalid tlen " + tlen + ". Block offset: "<a name="line.553"></a>
<span class="sourceLineNo">554</span> + curBlock.getOffset() + ", block length: " + blockBuffer.limit() + ", position: "<a name="line.554"></a>
<span class="sourceLineNo">555</span> + blockBuffer.position() + " (without header)." + " path=" + reader.getPath());<a name="line.555"></a>
<span class="sourceLineNo">556</span> }<a name="line.556"></a>
<span class="sourceLineNo">557</span> // add the two bytes read for the tags.<a name="line.557"></a>
<span class="sourceLineNo">558</span> offsetFromPos += tlen + (Bytes.SIZEOF_SHORT);<a name="line.558"></a>
<span class="sourceLineNo">559</span> }<a name="line.559"></a>
<span class="sourceLineNo">560</span> if (this.reader.getHFileInfo().shouldIncludeMemStoreTS()) {<a name="line.560"></a>
<span class="sourceLineNo">561</span> // Directly read the mvcc based on current position<a name="line.561"></a>
<span class="sourceLineNo">562</span> readMvccVersion(offsetFromPos);<a name="line.562"></a>
<span class="sourceLineNo">563</span> }<a name="line.563"></a>
<span class="sourceLineNo">564</span> if (comp == 0) {<a name="line.564"></a>
<span class="sourceLineNo">565</span> if (seekBefore) {<a name="line.565"></a>
<span class="sourceLineNo">566</span> if (lastKeyValueSize &lt; 0) {<a name="line.566"></a>
<span class="sourceLineNo">567</span> throw new IllegalStateException("blockSeek with seekBefore "<a name="line.567"></a>
<span class="sourceLineNo">568</span> + "at the first key of the block: key=" + CellUtil.getCellKeyAsString(key)<a name="line.568"></a>
<span class="sourceLineNo">569</span> + ", blockOffset=" + curBlock.getOffset() + ", onDiskSize="<a name="line.569"></a>
<span class="sourceLineNo">570</span> + curBlock.getOnDiskSizeWithHeader() + ", path=" + reader.getPath());<a name="line.570"></a>
<span class="sourceLineNo">571</span> }<a name="line.571"></a>
<span class="sourceLineNo">572</span> blockBuffer.moveBack(lastKeyValueSize);<a name="line.572"></a>
<span class="sourceLineNo">573</span> readKeyValueLen();<a name="line.573"></a>
<span class="sourceLineNo">574</span> return 1; // non exact match.<a name="line.574"></a>
<span class="sourceLineNo">575</span> }<a name="line.575"></a>
<span class="sourceLineNo">576</span> currKeyLen = klen;<a name="line.576"></a>
<span class="sourceLineNo">577</span> currValueLen = vlen;<a name="line.577"></a>
<span class="sourceLineNo">578</span> currTagsLen = tlen;<a name="line.578"></a>
<span class="sourceLineNo">579</span> return 0; // indicate exact match<a name="line.579"></a>
<span class="sourceLineNo">580</span> } else if (comp &lt; 0) {<a name="line.580"></a>
<span class="sourceLineNo">581</span> if (lastKeyValueSize &gt; 0) {<a name="line.581"></a>
<span class="sourceLineNo">582</span> blockBuffer.moveBack(lastKeyValueSize);<a name="line.582"></a>
<span class="sourceLineNo">583</span> }<a name="line.583"></a>
<span class="sourceLineNo">584</span> readKeyValueLen();<a name="line.584"></a>
<span class="sourceLineNo">585</span> if (lastKeyValueSize == -1 &amp;&amp; blockBuffer.position() == 0) {<a name="line.585"></a>
<span class="sourceLineNo">586</span> return HConstants.INDEX_KEY_MAGIC;<a name="line.586"></a>
<span class="sourceLineNo">587</span> }<a name="line.587"></a>
<span class="sourceLineNo">588</span> return 1;<a name="line.588"></a>
<span class="sourceLineNo">589</span> }<a name="line.589"></a>
<span class="sourceLineNo">590</span> // The size of this key/value tuple, including key/value length fields.<a name="line.590"></a>
<span class="sourceLineNo">591</span> lastKeyValueSize = klen + vlen + currMemstoreTSLen + KEY_VALUE_LEN_SIZE;<a name="line.591"></a>
<span class="sourceLineNo">592</span> // include tag length also if tags included with KV<a name="line.592"></a>
<span class="sourceLineNo">593</span> if (reader.getFileContext().isIncludesTags()) {<a name="line.593"></a>
<span class="sourceLineNo">594</span> lastKeyValueSize += tlen + Bytes.SIZEOF_SHORT;<a name="line.594"></a>
<span class="sourceLineNo">595</span> }<a name="line.595"></a>
<span class="sourceLineNo">596</span> blockBuffer.skip(lastKeyValueSize);<a name="line.596"></a>
<span class="sourceLineNo">597</span> } while (blockBuffer.hasRemaining());<a name="line.597"></a>
<span class="sourceLineNo">598</span><a name="line.598"></a>
<span class="sourceLineNo">599</span> // Seek to the last key we successfully read. This will happen if this is<a name="line.599"></a>
<span class="sourceLineNo">600</span> // the last key/value pair in the file, in which case the following call<a name="line.600"></a>
<span class="sourceLineNo">601</span> // to next() has to return false.<a name="line.601"></a>
<span class="sourceLineNo">602</span> blockBuffer.moveBack(lastKeyValueSize);<a name="line.602"></a>
<span class="sourceLineNo">603</span> readKeyValueLen();<a name="line.603"></a>
<span class="sourceLineNo">604</span> return 1; // didn't exactly find it.<a name="line.604"></a>
<span class="sourceLineNo">605</span> }<a name="line.605"></a>
<span class="sourceLineNo">606</span><a name="line.606"></a>
<span class="sourceLineNo">607</span> @Override<a name="line.607"></a>
<span class="sourceLineNo">608</span> public Cell getNextIndexedKey() {<a name="line.608"></a>
<span class="sourceLineNo">609</span> return nextIndexedKey;<a name="line.609"></a>
<span class="sourceLineNo">610</span> }<a name="line.610"></a>
<span class="sourceLineNo">611</span><a name="line.611"></a>
<span class="sourceLineNo">612</span> @Override<a name="line.612"></a>
<span class="sourceLineNo">613</span> public int seekTo(Cell key) throws IOException {<a name="line.613"></a>
<span class="sourceLineNo">614</span> return seekTo(key, true);<a name="line.614"></a>
<span class="sourceLineNo">615</span> }<a name="line.615"></a>
<span class="sourceLineNo">616</span><a name="line.616"></a>
<span class="sourceLineNo">617</span> @Override<a name="line.617"></a>
<span class="sourceLineNo">618</span> public int reseekTo(Cell key) throws IOException {<a name="line.618"></a>
<span class="sourceLineNo">619</span> int compared;<a name="line.619"></a>
<span class="sourceLineNo">620</span> if (isSeeked()) {<a name="line.620"></a>
<span class="sourceLineNo">621</span> compared = compareKey(reader.getComparator(), key);<a name="line.621"></a>
<span class="sourceLineNo">622</span> if (compared &lt; 1) {<a name="line.622"></a>
<span class="sourceLineNo">623</span> // If the required key is less than or equal to current key, then<a name="line.623"></a>
<span class="sourceLineNo">624</span> // don't do anything.<a name="line.624"></a>
<span class="sourceLineNo">625</span> return compared;<a name="line.625"></a>
<span class="sourceLineNo">626</span> } else {<a name="line.626"></a>
<span class="sourceLineNo">627</span> // The comparison with no_next_index_key has to be checked<a name="line.627"></a>
<span class="sourceLineNo">628</span> if (<a name="line.628"></a>
<span class="sourceLineNo">629</span> this.nextIndexedKey != null &amp;&amp; (this.nextIndexedKey<a name="line.629"></a>
<span class="sourceLineNo">630</span> == KeyValueScanner.NO_NEXT_INDEXED_KEY<a name="line.630"></a>
<span class="sourceLineNo">631</span> || PrivateCellUtil.compareKeyIgnoresMvcc(reader.getComparator(), key, nextIndexedKey)<a name="line.631"></a>
<span class="sourceLineNo">632</span> &lt; 0)<a name="line.632"></a>
<span class="sourceLineNo">633</span> ) {<a name="line.633"></a>
<span class="sourceLineNo">634</span> // The reader shall continue to scan the current data block instead<a name="line.634"></a>
<span class="sourceLineNo">635</span> // of querying the<a name="line.635"></a>
<span class="sourceLineNo">636</span> // block index as long as it knows the target key is strictly<a name="line.636"></a>
<span class="sourceLineNo">637</span> // smaller than<a name="line.637"></a>
<span class="sourceLineNo">638</span> // the next indexed key or the current data block is the last data<a name="line.638"></a>
<span class="sourceLineNo">639</span> // block.<a name="line.639"></a>
<span class="sourceLineNo">640</span> return loadBlockAndSeekToKey(this.curBlock, nextIndexedKey, false, key, false);<a name="line.640"></a>
<span class="sourceLineNo">641</span> }<a name="line.641"></a>
<span class="sourceLineNo">642</span> }<a name="line.642"></a>
<span class="sourceLineNo">643</span> }<a name="line.643"></a>
<span class="sourceLineNo">644</span> // Don't rewind on a reseek operation, because reseek implies that we are<a name="line.644"></a>
<span class="sourceLineNo">645</span> // always going forward in the file.<a name="line.645"></a>
<span class="sourceLineNo">646</span> return seekTo(key, false);<a name="line.646"></a>
<span class="sourceLineNo">647</span> }<a name="line.647"></a>
<span class="sourceLineNo">648</span><a name="line.648"></a>
<span class="sourceLineNo">649</span> /**<a name="line.649"></a>
<span class="sourceLineNo">650</span> * An internal API function. Seek to the given key, optionally rewinding to the first key of the<a name="line.650"></a>
<span class="sourceLineNo">651</span> * block before doing the seek.<a name="line.651"></a>
<span class="sourceLineNo">652</span> * @param key - a cell representing the key that we need to fetch<a name="line.652"></a>
<span class="sourceLineNo">653</span> * @param rewind whether to rewind to the first key of the block before doing the seek. If this<a name="line.653"></a>
<span class="sourceLineNo">654</span> * is false, we are assuming we never go back, otherwise the result is undefined.<a name="line.654"></a>
<span class="sourceLineNo">655</span> * @return -1 if the key is earlier than the first key of the file, 0 if we are at the given<a name="line.655"></a>
<span class="sourceLineNo">656</span> * key, 1 if we are past the given key -2 if the key is earlier than the first key of<a name="line.656"></a>
<span class="sourceLineNo">657</span> * the file while using a faked index key<a name="line.657"></a>
<span class="sourceLineNo">658</span> */<a name="line.658"></a>
<span class="sourceLineNo">659</span> public int seekTo(Cell key, boolean rewind) throws IOException {<a name="line.659"></a>
<span class="sourceLineNo">660</span> HFileBlockIndex.BlockIndexReader indexReader = reader.getDataBlockIndexReader();<a name="line.660"></a>
<span class="sourceLineNo">661</span> BlockWithScanInfo blockWithScanInfo = indexReader.loadDataBlockWithScanInfo(key, curBlock,<a name="line.661"></a>
<span class="sourceLineNo">662</span> cacheBlocks, pread, isCompaction, getEffectiveDataBlockEncoding(), reader);<a name="line.662"></a>
<span class="sourceLineNo">663</span> if (blockWithScanInfo == null || blockWithScanInfo.getHFileBlock() == null) {<a name="line.663"></a>
<span class="sourceLineNo">664</span> // This happens if the key e.g. falls before the beginning of the file.<a name="line.664"></a>
<span class="sourceLineNo">665</span> return -1;<a name="line.665"></a>
<span class="sourceLineNo">666</span> }<a name="line.666"></a>
<span class="sourceLineNo">667</span> return loadBlockAndSeekToKey(blockWithScanInfo.getHFileBlock(),<a name="line.667"></a>
<span class="sourceLineNo">668</span> blockWithScanInfo.getNextIndexedKey(), rewind, key, false);<a name="line.668"></a>
<span class="sourceLineNo">669</span> }<a name="line.669"></a>
<span class="sourceLineNo">670</span><a name="line.670"></a>
<span class="sourceLineNo">671</span> @Override<a name="line.671"></a>
<span class="sourceLineNo">672</span> public boolean seekBefore(Cell key) throws IOException {<a name="line.672"></a>
<span class="sourceLineNo">673</span> HFileBlock seekToBlock = reader.getDataBlockIndexReader().seekToDataBlock(key, curBlock,<a name="line.673"></a>
<span class="sourceLineNo">674</span> cacheBlocks, pread, isCompaction, reader.getEffectiveEncodingInCache(isCompaction), reader);<a name="line.674"></a>
<span class="sourceLineNo">675</span> if (seekToBlock == null) {<a name="line.675"></a>
<span class="sourceLineNo">676</span> return false;<a name="line.676"></a>
<span class="sourceLineNo">677</span> }<a name="line.677"></a>
<span class="sourceLineNo">678</span> Cell firstKey = getFirstKeyCellInBlock(seekToBlock);<a name="line.678"></a>
<span class="sourceLineNo">679</span> if (PrivateCellUtil.compareKeyIgnoresMvcc(reader.getComparator(), firstKey, key) &gt;= 0) {<a name="line.679"></a>
<span class="sourceLineNo">680</span> long previousBlockOffset = seekToBlock.getPrevBlockOffset();<a name="line.680"></a>
<span class="sourceLineNo">681</span> // The key we are interested in<a name="line.681"></a>
<span class="sourceLineNo">682</span> if (previousBlockOffset == -1) {<a name="line.682"></a>
<span class="sourceLineNo">683</span> // we have a 'problem', the key we want is the first of the file.<a name="line.683"></a>
<span class="sourceLineNo">684</span> releaseIfNotCurBlock(seekToBlock);<a name="line.684"></a>
<span class="sourceLineNo">685</span> return false;<a name="line.685"></a>
<span class="sourceLineNo">686</span> }<a name="line.686"></a>
<span class="sourceLineNo">687</span><a name="line.687"></a>
<span class="sourceLineNo">688</span> // The first key in the current block 'seekToBlock' is greater than the given<a name="line.688"></a>
<span class="sourceLineNo">689</span> // seekBefore key. We will go ahead by reading the next block that satisfies the<a name="line.689"></a>
<span class="sourceLineNo">690</span> // given key. Return the current block before reading the next one.<a name="line.690"></a>
<span class="sourceLineNo">691</span> releaseIfNotCurBlock(seekToBlock);<a name="line.691"></a>
<span class="sourceLineNo">692</span> // It is important that we compute and pass onDiskSize to the block<a name="line.692"></a>
<span class="sourceLineNo">693</span> // reader so that it does not have to read the header separately to<a name="line.693"></a>
<span class="sourceLineNo">694</span> // figure out the size. Currently, we do not have a way to do this<a name="line.694"></a>
<span class="sourceLineNo">695</span> // correctly in the general case however.<a name="line.695"></a>
<span class="sourceLineNo">696</span> // TODO: See https://issues.apache.org/jira/browse/HBASE-14576<a name="line.696"></a>
<span class="sourceLineNo">697</span> int prevBlockSize = -1;<a name="line.697"></a>
<span class="sourceLineNo">698</span> seekToBlock = reader.readBlock(previousBlockOffset, prevBlockSize, cacheBlocks, pread,<a name="line.698"></a>
<span class="sourceLineNo">699</span> isCompaction, true, BlockType.DATA, getEffectiveDataBlockEncoding());<a name="line.699"></a>
<span class="sourceLineNo">700</span> // TODO shortcut: seek forward in this block to the last key of the<a name="line.700"></a>
<span class="sourceLineNo">701</span> // block.<a name="line.701"></a>
<span class="sourceLineNo">702</span> }<a name="line.702"></a>
<span class="sourceLineNo">703</span> loadBlockAndSeekToKey(seekToBlock, firstKey, true, key, true);<a name="line.703"></a>
<span class="sourceLineNo">704</span> return true;<a name="line.704"></a>
<span class="sourceLineNo">705</span> }<a name="line.705"></a>
<span class="sourceLineNo">706</span><a name="line.706"></a>
<span class="sourceLineNo">707</span> /**<a name="line.707"></a>
<span class="sourceLineNo">708</span> * The curBlock will be released by shipping or close method, so only need to consider releasing<a name="line.708"></a>
<span class="sourceLineNo">709</span> * the block, which was read from HFile before and not referenced by curBlock.<a name="line.709"></a>
<span class="sourceLineNo">710</span> */<a name="line.710"></a>
<span class="sourceLineNo">711</span> protected void releaseIfNotCurBlock(HFileBlock block) {<a name="line.711"></a>
<span class="sourceLineNo">712</span> if (curBlock != block) {<a name="line.712"></a>
<span class="sourceLineNo">713</span> block.release();<a name="line.713"></a>
<span class="sourceLineNo">714</span> }<a name="line.714"></a>
<span class="sourceLineNo">715</span> }<a name="line.715"></a>
<span class="sourceLineNo">716</span><a name="line.716"></a>
<span class="sourceLineNo">717</span> /**<a name="line.717"></a>
<span class="sourceLineNo">718</span> * Scans blocks in the "scanned" section of the {@link HFile} until the next data block is<a name="line.718"></a>
<span class="sourceLineNo">719</span> * found.<a name="line.719"></a>
<span class="sourceLineNo">720</span> * @return the next block, or null if there are no more data blocks<a name="line.720"></a>
<span class="sourceLineNo">721</span> */<a name="line.721"></a>
<span class="sourceLineNo">722</span> @edu.umd.cs.findbugs.annotations.SuppressWarnings(value = "NP_NULL_ON_SOME_PATH",<a name="line.722"></a>
<span class="sourceLineNo">723</span> justification = "Yeah, unnecessary null check; could do w/ clean up")<a name="line.723"></a>
<span class="sourceLineNo">724</span> protected HFileBlock readNextDataBlock() throws IOException {<a name="line.724"></a>
<span class="sourceLineNo">725</span> long lastDataBlockOffset = reader.getTrailer().getLastDataBlockOffset();<a name="line.725"></a>
<span class="sourceLineNo">726</span> if (curBlock == null) {<a name="line.726"></a>
<span class="sourceLineNo">727</span> return null;<a name="line.727"></a>
<span class="sourceLineNo">728</span> }<a name="line.728"></a>
<span class="sourceLineNo">729</span> HFileBlock block = this.curBlock;<a name="line.729"></a>
<span class="sourceLineNo">730</span> do {<a name="line.730"></a>
<span class="sourceLineNo">731</span> if (block.getOffset() &gt;= lastDataBlockOffset) {<a name="line.731"></a>
<span class="sourceLineNo">732</span> releaseIfNotCurBlock(block);<a name="line.732"></a>
<span class="sourceLineNo">733</span> return null;<a name="line.733"></a>
<span class="sourceLineNo">734</span> }<a name="line.734"></a>
<span class="sourceLineNo">735</span> if (block.getOffset() &lt; 0) {<a name="line.735"></a>
<span class="sourceLineNo">736</span> releaseIfNotCurBlock(block);<a name="line.736"></a>
<span class="sourceLineNo">737</span> throw new IOException("Invalid block offset: " + block + ", path=" + reader.getPath());<a name="line.737"></a>
<span class="sourceLineNo">738</span> }<a name="line.738"></a>
<span class="sourceLineNo">739</span> // We are reading the next block without block type validation, because<a name="line.739"></a>
<span class="sourceLineNo">740</span> // it might turn out to be a non-data block.<a name="line.740"></a>
<span class="sourceLineNo">741</span> block = reader.readBlock(block.getOffset() + block.getOnDiskSizeWithHeader(),<a name="line.741"></a>
<span class="sourceLineNo">742</span> block.getNextBlockOnDiskSize(), cacheBlocks, pread, isCompaction, true, null,<a name="line.742"></a>
<span class="sourceLineNo">743</span> getEffectiveDataBlockEncoding());<a name="line.743"></a>
<span class="sourceLineNo">744</span> if (block != null &amp;&amp; !block.getBlockType().isData()) {<a name="line.744"></a>
<span class="sourceLineNo">745</span> // Whatever block we read we will be returning it unless<a name="line.745"></a>
<span class="sourceLineNo">746</span> // it is a datablock. Just in case the blocks are non data blocks<a name="line.746"></a>
<span class="sourceLineNo">747</span> block.release();<a name="line.747"></a>
<span class="sourceLineNo">748</span> }<a name="line.748"></a>
<span class="sourceLineNo">749</span> } while (!block.getBlockType().isData());<a name="line.749"></a>
<span class="sourceLineNo">750</span> return block;<a name="line.750"></a>
<span class="sourceLineNo">751</span> }<a name="line.751"></a>
<span class="sourceLineNo">752</span><a name="line.752"></a>
<span class="sourceLineNo">753</span> public DataBlockEncoding getEffectiveDataBlockEncoding() {<a name="line.753"></a>
<span class="sourceLineNo">754</span> return this.reader.getEffectiveEncodingInCache(isCompaction);<a name="line.754"></a>
<span class="sourceLineNo">755</span> }<a name="line.755"></a>
<span class="sourceLineNo">756</span><a name="line.756"></a>
<span class="sourceLineNo">757</span> @Override<a name="line.757"></a>
<span class="sourceLineNo">758</span> public Cell getCell() {<a name="line.758"></a>
<span class="sourceLineNo">759</span> if (!isSeeked()) {<a name="line.759"></a>
<span class="sourceLineNo">760</span> return null;<a name="line.760"></a>
<span class="sourceLineNo">761</span> }<a name="line.761"></a>
<span class="sourceLineNo">762</span><a name="line.762"></a>
<span class="sourceLineNo">763</span> Cell ret;<a name="line.763"></a>
<span class="sourceLineNo">764</span> int cellBufSize = getKVBufSize();<a name="line.764"></a>
<span class="sourceLineNo">765</span> long seqId = 0L;<a name="line.765"></a>
<span class="sourceLineNo">766</span> if (this.reader.getHFileInfo().shouldIncludeMemStoreTS()) {<a name="line.766"></a>
<span class="sourceLineNo">767</span> seqId = currMemstoreTS;<a name="line.767"></a>
<span class="sourceLineNo">768</span> }<a name="line.768"></a>
<span class="sourceLineNo">769</span> if (blockBuffer.hasArray()) {<a name="line.769"></a>
<span class="sourceLineNo">770</span> // TODO : reduce the varieties of KV here. Check if based on a boolean<a name="line.770"></a>
<span class="sourceLineNo">771</span> // we can handle the 'no tags' case.<a name="line.771"></a>
<span class="sourceLineNo">772</span> if (currTagsLen &gt; 0) {<a name="line.772"></a>
<span class="sourceLineNo">773</span> ret = new SizeCachedKeyValue(blockBuffer.array(),<a name="line.773"></a>
<span class="sourceLineNo">774</span> blockBuffer.arrayOffset() + blockBuffer.position(), cellBufSize, seqId, currKeyLen,<a name="line.774"></a>
<span class="sourceLineNo">775</span> rowLen);<a name="line.775"></a>
<span class="sourceLineNo">776</span> } else {<a name="line.776"></a>
<span class="sourceLineNo">777</span> ret = new SizeCachedNoTagsKeyValue(blockBuffer.array(),<a name="line.777"></a>
<span class="sourceLineNo">778</span> blockBuffer.arrayOffset() + blockBuffer.position(), cellBufSize, seqId, currKeyLen,<a name="line.778"></a>
<span class="sourceLineNo">779</span> rowLen);<a name="line.779"></a>
<span class="sourceLineNo">780</span> }<a name="line.780"></a>
<span class="sourceLineNo">781</span> } else {<a name="line.781"></a>
<span class="sourceLineNo">782</span> ByteBuffer buf = blockBuffer.asSubByteBuffer(cellBufSize);<a name="line.782"></a>
<span class="sourceLineNo">783</span> if (buf.isDirect()) {<a name="line.783"></a>
<span class="sourceLineNo">784</span> ret = currTagsLen &gt; 0<a name="line.784"></a>
<span class="sourceLineNo">785</span> ? new SizeCachedByteBufferKeyValue(buf, buf.position(), cellBufSize, seqId, currKeyLen,<a name="line.785"></a>
<span class="sourceLineNo">786</span> rowLen)<a name="line.786"></a>
<span class="sourceLineNo">787</span> : new SizeCachedNoTagsByteBufferKeyValue(buf, buf.position(), cellBufSize, seqId,<a name="line.787"></a>
<span class="sourceLineNo">788</span> currKeyLen, rowLen);<a name="line.788"></a>
<span class="sourceLineNo">789</span> } else {<a name="line.789"></a>
<span class="sourceLineNo">790</span> if (currTagsLen &gt; 0) {<a name="line.790"></a>
<span class="sourceLineNo">791</span> ret = new SizeCachedKeyValue(buf.array(), buf.arrayOffset() + buf.position(),<a name="line.791"></a>
<span class="sourceLineNo">792</span> cellBufSize, seqId, currKeyLen, rowLen);<a name="line.792"></a>
<span class="sourceLineNo">793</span> } else {<a name="line.793"></a>
<span class="sourceLineNo">794</span> ret = new SizeCachedNoTagsKeyValue(buf.array(), buf.arrayOffset() + buf.position(),<a name="line.794"></a>
<span class="sourceLineNo">795</span> cellBufSize, seqId, currKeyLen, rowLen);<a name="line.795"></a>
<span class="sourceLineNo">796</span> }<a name="line.796"></a>
<span class="sourceLineNo">797</span> }<a name="line.797"></a>
<span class="sourceLineNo">798</span> }<a name="line.798"></a>
<span class="sourceLineNo">799</span> return ret;<a name="line.799"></a>
<span class="sourceLineNo">800</span> }<a name="line.800"></a>
<span class="sourceLineNo">801</span><a name="line.801"></a>
<span class="sourceLineNo">802</span> @Override<a name="line.802"></a>
<span class="sourceLineNo">803</span> public Cell getKey() {<a name="line.803"></a>
<span class="sourceLineNo">804</span> assertSeeked();<a name="line.804"></a>
<span class="sourceLineNo">805</span> // Create a new object so that this getKey is cached as firstKey, lastKey<a name="line.805"></a>
<span class="sourceLineNo">806</span> ObjectIntPair&lt;ByteBuffer&gt; keyPair = new ObjectIntPair&lt;&gt;();<a name="line.806"></a>
<span class="sourceLineNo">807</span> blockBuffer.asSubByteBuffer(blockBuffer.position() + KEY_VALUE_LEN_SIZE, currKeyLen, keyPair);<a name="line.807"></a>
<span class="sourceLineNo">808</span> ByteBuffer keyBuf = keyPair.getFirst();<a name="line.808"></a>
<span class="sourceLineNo">809</span> if (keyBuf.hasArray()) {<a name="line.809"></a>
<span class="sourceLineNo">810</span> return new KeyValue.KeyOnlyKeyValue(keyBuf.array(),<a name="line.810"></a>
<span class="sourceLineNo">811</span> keyBuf.arrayOffset() + keyPair.getSecond(), currKeyLen);<a name="line.811"></a>
<span class="sourceLineNo">812</span> } else {<a name="line.812"></a>
<span class="sourceLineNo">813</span> // Better to do a copy here instead of holding on to this BB so that<a name="line.813"></a>
<span class="sourceLineNo">814</span> // we could release the blocks referring to this key. This key is specifically used<a name="line.814"></a>
<span class="sourceLineNo">815</span> // in HalfStoreFileReader to get the firstkey and lastkey by creating a new scanner<a name="line.815"></a>
<span class="sourceLineNo">816</span> // every time. So holding onto the BB (incase of DBB) is not advised here.<a name="line.816"></a>
<span class="sourceLineNo">817</span> byte[] key = new byte[currKeyLen];<a name="line.817"></a>
<span class="sourceLineNo">818</span> ByteBufferUtils.copyFromBufferToArray(key, keyBuf, keyPair.getSecond(), 0, currKeyLen);<a name="line.818"></a>
<span class="sourceLineNo">819</span> return new KeyValue.KeyOnlyKeyValue(key, 0, currKeyLen);<a name="line.819"></a>
<span class="sourceLineNo">820</span> }<a name="line.820"></a>
<span class="sourceLineNo">821</span> }<a name="line.821"></a>
<span class="sourceLineNo">822</span><a name="line.822"></a>
<span class="sourceLineNo">823</span> @Override<a name="line.823"></a>
<span class="sourceLineNo">824</span> public ByteBuffer getValue() {<a name="line.824"></a>
<span class="sourceLineNo">825</span> assertSeeked();<a name="line.825"></a>
<span class="sourceLineNo">826</span> // Okie to create new Pair. Not used in hot path<a name="line.826"></a>
<span class="sourceLineNo">827</span> ObjectIntPair&lt;ByteBuffer&gt; valuePair = new ObjectIntPair&lt;&gt;();<a name="line.827"></a>
<span class="sourceLineNo">828</span> this.blockBuffer.asSubByteBuffer(blockBuffer.position() + KEY_VALUE_LEN_SIZE + currKeyLen,<a name="line.828"></a>
<span class="sourceLineNo">829</span> currValueLen, valuePair);<a name="line.829"></a>
<span class="sourceLineNo">830</span> ByteBuffer valBuf = valuePair.getFirst().duplicate();<a name="line.830"></a>
<span class="sourceLineNo">831</span> valBuf.position(valuePair.getSecond());<a name="line.831"></a>
<span class="sourceLineNo">832</span> valBuf.limit(currValueLen + valuePair.getSecond());<a name="line.832"></a>
<span class="sourceLineNo">833</span> return valBuf.slice();<a name="line.833"></a>
<span class="sourceLineNo">834</span> }<a name="line.834"></a>
<span class="sourceLineNo">835</span><a name="line.835"></a>
<span class="sourceLineNo">836</span> protected void setNonSeekedState() {<a name="line.836"></a>
<span class="sourceLineNo">837</span> reset();<a name="line.837"></a>
<span class="sourceLineNo">838</span> blockBuffer = null;<a name="line.838"></a>
<span class="sourceLineNo">839</span> currKeyLen = 0;<a name="line.839"></a>
<span class="sourceLineNo">840</span> currValueLen = 0;<a name="line.840"></a>
<span class="sourceLineNo">841</span> currMemstoreTS = 0;<a name="line.841"></a>
<span class="sourceLineNo">842</span> currMemstoreTSLen = 0;<a name="line.842"></a>
<span class="sourceLineNo">843</span> currTagsLen = 0;<a name="line.843"></a>
<span class="sourceLineNo">844</span> }<a name="line.844"></a>
<span class="sourceLineNo">845</span><a name="line.845"></a>
<span class="sourceLineNo">846</span> /**<a name="line.846"></a>
<span class="sourceLineNo">847</span> * Set the position on current backing blockBuffer.<a name="line.847"></a>
<span class="sourceLineNo">848</span> */<a name="line.848"></a>
<span class="sourceLineNo">849</span> private void positionThisBlockBuffer() {<a name="line.849"></a>
<span class="sourceLineNo">850</span> try {<a name="line.850"></a>
<span class="sourceLineNo">851</span> blockBuffer.skip(getCurCellSerializedSize());<a name="line.851"></a>
<span class="sourceLineNo">852</span> } catch (IllegalArgumentException e) {<a name="line.852"></a>
<span class="sourceLineNo">853</span> LOG.error("Current pos = " + blockBuffer.position() + "; currKeyLen = " + currKeyLen<a name="line.853"></a>
<span class="sourceLineNo">854</span> + "; currValLen = " + currValueLen + "; block limit = " + blockBuffer.limit()<a name="line.854"></a>
<span class="sourceLineNo">855</span> + "; currBlock currBlockOffset = " + this.curBlock.getOffset() + "; path="<a name="line.855"></a>
<span class="sourceLineNo">856</span> + reader.getPath());<a name="line.856"></a>
<span class="sourceLineNo">857</span> throw e;<a name="line.857"></a>
<span class="sourceLineNo">858</span> }<a name="line.858"></a>
<span class="sourceLineNo">859</span> }<a name="line.859"></a>
<span class="sourceLineNo">860</span><a name="line.860"></a>
<span class="sourceLineNo">861</span> /**<a name="line.861"></a>
<span class="sourceLineNo">862</span> * Set our selves up for the next 'next' invocation, set up next block.<a name="line.862"></a>
<span class="sourceLineNo">863</span> * @return True is more to read else false if at the end.<a name="line.863"></a>
<span class="sourceLineNo">864</span> */<a name="line.864"></a>
<span class="sourceLineNo">865</span> private boolean positionForNextBlock() throws IOException {<a name="line.865"></a>
<span class="sourceLineNo">866</span> // Methods are small so they get inlined because they are 'hot'.<a name="line.866"></a>
<span class="sourceLineNo">867</span> long lastDataBlockOffset = reader.getTrailer().getLastDataBlockOffset();<a name="line.867"></a>
<span class="sourceLineNo">868</span> if (this.curBlock.getOffset() &gt;= lastDataBlockOffset) {<a name="line.868"></a>
<span class="sourceLineNo">869</span> setNonSeekedState();<a name="line.869"></a>
<span class="sourceLineNo">870</span> return false;<a name="line.870"></a>
<span class="sourceLineNo">871</span> }<a name="line.871"></a>
<span class="sourceLineNo">872</span> return isNextBlock();<a name="line.872"></a>
<span class="sourceLineNo">873</span> }<a name="line.873"></a>
<span class="sourceLineNo">874</span><a name="line.874"></a>
<span class="sourceLineNo">875</span> private boolean isNextBlock() throws IOException {<a name="line.875"></a>
<span class="sourceLineNo">876</span> // Methods are small so they get inlined because they are 'hot'.<a name="line.876"></a>
<span class="sourceLineNo">877</span> HFileBlock nextBlock = readNextDataBlock();<a name="line.877"></a>
<span class="sourceLineNo">878</span> if (nextBlock == null) {<a name="line.878"></a>
<span class="sourceLineNo">879</span> setNonSeekedState();<a name="line.879"></a>
<span class="sourceLineNo">880</span> return false;<a name="line.880"></a>
<span class="sourceLineNo">881</span> }<a name="line.881"></a>
<span class="sourceLineNo">882</span> updateCurrentBlock(nextBlock);<a name="line.882"></a>
<span class="sourceLineNo">883</span> return true;<a name="line.883"></a>
<span class="sourceLineNo">884</span> }<a name="line.884"></a>
<span class="sourceLineNo">885</span><a name="line.885"></a>
<span class="sourceLineNo">886</span> private final boolean _next() throws IOException {<a name="line.886"></a>
<span class="sourceLineNo">887</span> // Small method so can be inlined. It is a hot one.<a name="line.887"></a>
<span class="sourceLineNo">888</span> if (blockBuffer.remaining() &lt;= 0) {<a name="line.888"></a>
<span class="sourceLineNo">889</span> return positionForNextBlock();<a name="line.889"></a>
<span class="sourceLineNo">890</span> }<a name="line.890"></a>
<span class="sourceLineNo">891</span><a name="line.891"></a>
<span class="sourceLineNo">892</span> // We are still in the same block.<a name="line.892"></a>
<span class="sourceLineNo">893</span> readKeyValueLen();<a name="line.893"></a>
<span class="sourceLineNo">894</span> return true;<a name="line.894"></a>
<span class="sourceLineNo">895</span> }<a name="line.895"></a>
<span class="sourceLineNo">896</span><a name="line.896"></a>
<span class="sourceLineNo">897</span> /**<a name="line.897"></a>
<span class="sourceLineNo">898</span> * Go to the next key/value in the block section. Loads the next block if necessary. If<a name="line.898"></a>
<span class="sourceLineNo">899</span> * successful, {@link #getKey()} and {@link #getValue()} can be called.<a name="line.899"></a>
<span class="sourceLineNo">900</span> * @return true if successfully navigated to the next key/value<a name="line.900"></a>
<span class="sourceLineNo">901</span> */<a name="line.901"></a>
<span class="sourceLineNo">902</span> @Override<a name="line.902"></a>
<span class="sourceLineNo">903</span> public boolean next() throws IOException {<a name="line.903"></a>
<span class="sourceLineNo">904</span> // This is a hot method so extreme measures taken to ensure it is small and inlineable.<a name="line.904"></a>
<span class="sourceLineNo">905</span> // Checked by setting: -XX:+UnlockDiagnosticVMOptions -XX:+PrintInlining -XX:+PrintCompilation<a name="line.905"></a>
<span class="sourceLineNo">906</span> assertSeeked();<a name="line.906"></a>
<span class="sourceLineNo">907</span> positionThisBlockBuffer();<a name="line.907"></a>
<span class="sourceLineNo">908</span> return _next();<a name="line.908"></a>
<span class="sourceLineNo">909</span> }<a name="line.909"></a>
<span class="sourceLineNo">910</span><a name="line.910"></a>
<span class="sourceLineNo">911</span> /**<a name="line.911"></a>
<span class="sourceLineNo">912</span> * Positions this scanner at the start of the file.<a name="line.912"></a>
<span class="sourceLineNo">913</span> * @return false if empty file; i.e. a call to next would return false and the current key and<a name="line.913"></a>
<span class="sourceLineNo">914</span> * value are undefined.<a name="line.914"></a>
<span class="sourceLineNo">915</span> */<a name="line.915"></a>
<span class="sourceLineNo">916</span> @Override<a name="line.916"></a>
<span class="sourceLineNo">917</span> public boolean seekTo() throws IOException {<a name="line.917"></a>
<span class="sourceLineNo">918</span> if (reader == null) {<a name="line.918"></a>
<span class="sourceLineNo">919</span> return false;<a name="line.919"></a>
<span class="sourceLineNo">920</span> }<a name="line.920"></a>
<span class="sourceLineNo">921</span><a name="line.921"></a>
<span class="sourceLineNo">922</span> if (reader.getTrailer().getEntryCount() == 0) {<a name="line.922"></a>
<span class="sourceLineNo">923</span> // No data blocks.<a name="line.923"></a>
<span class="sourceLineNo">924</span> return false;<a name="line.924"></a>
<span class="sourceLineNo">925</span> }<a name="line.925"></a>
<span class="sourceLineNo">926</span><a name="line.926"></a>
<span class="sourceLineNo">927</span> long firstDataBlockOffset = reader.getTrailer().getFirstDataBlockOffset();<a name="line.927"></a>
<span class="sourceLineNo">928</span> if (curBlock != null &amp;&amp; curBlock.getOffset() == firstDataBlockOffset) {<a name="line.928"></a>
<span class="sourceLineNo">929</span> return processFirstDataBlock();<a name="line.929"></a>
<span class="sourceLineNo">930</span> }<a name="line.930"></a>
<span class="sourceLineNo">931</span><a name="line.931"></a>
<span class="sourceLineNo">932</span> readAndUpdateNewBlock(firstDataBlockOffset);<a name="line.932"></a>
<span class="sourceLineNo">933</span> return true;<a name="line.933"></a>
<span class="sourceLineNo">934</span> }<a name="line.934"></a>
<span class="sourceLineNo">935</span><a name="line.935"></a>
<span class="sourceLineNo">936</span> protected boolean processFirstDataBlock() throws IOException {<a name="line.936"></a>
<span class="sourceLineNo">937</span> blockBuffer.rewind();<a name="line.937"></a>
<span class="sourceLineNo">938</span> readKeyValueLen();<a name="line.938"></a>
<span class="sourceLineNo">939</span> return true;<a name="line.939"></a>
<span class="sourceLineNo">940</span> }<a name="line.940"></a>
<span class="sourceLineNo">941</span><a name="line.941"></a>
<span class="sourceLineNo">942</span> protected void readAndUpdateNewBlock(long firstDataBlockOffset) throws IOException {<a name="line.942"></a>
<span class="sourceLineNo">943</span> HFileBlock newBlock = reader.readBlock(firstDataBlockOffset, -1, cacheBlocks, pread,<a name="line.943"></a>
<span class="sourceLineNo">944</span> isCompaction, true, BlockType.DATA, getEffectiveDataBlockEncoding());<a name="line.944"></a>
<span class="sourceLineNo">945</span> if (newBlock.getOffset() &lt; 0) {<a name="line.945"></a>
<span class="sourceLineNo">946</span> releaseIfNotCurBlock(newBlock);<a name="line.946"></a>
<span class="sourceLineNo">947</span> throw new IOException(<a name="line.947"></a>
<span class="sourceLineNo">948</span> "Invalid offset=" + newBlock.getOffset() + ", path=" + reader.getPath());<a name="line.948"></a>
<span class="sourceLineNo">949</span> }<a name="line.949"></a>
<span class="sourceLineNo">950</span> updateCurrentBlock(newBlock);<a name="line.950"></a>
<span class="sourceLineNo">951</span> }<a name="line.951"></a>
<span class="sourceLineNo">952</span><a name="line.952"></a>
<span class="sourceLineNo">953</span> protected int loadBlockAndSeekToKey(HFileBlock seekToBlock, Cell nextIndexedKey, boolean rewind,<a name="line.953"></a>
<span class="sourceLineNo">954</span> Cell key, boolean seekBefore) throws IOException {<a name="line.954"></a>
<span class="sourceLineNo">955</span> if (this.curBlock == null || this.curBlock.getOffset() != seekToBlock.getOffset()) {<a name="line.955"></a>
<span class="sourceLineNo">956</span> updateCurrentBlock(seekToBlock);<a name="line.956"></a>
<span class="sourceLineNo">957</span> } else if (rewind) {<a name="line.957"></a>
<span class="sourceLineNo">958</span> blockBuffer.rewind();<a name="line.958"></a>
<span class="sourceLineNo">959</span> }<a name="line.959"></a>
<span class="sourceLineNo">960</span> // Update the nextIndexedKey<a name="line.960"></a>
<span class="sourceLineNo">961</span> this.nextIndexedKey = nextIndexedKey;<a name="line.961"></a>
<span class="sourceLineNo">962</span> return blockSeek(key, seekBefore);<a name="line.962"></a>
<span class="sourceLineNo">963</span> }<a name="line.963"></a>
<span class="sourceLineNo">964</span><a name="line.964"></a>
<span class="sourceLineNo">965</span> /** Returns True if v &amp;lt;= 0 or v &amp;gt; current block buffer limit. */<a name="line.965"></a>
<span class="sourceLineNo">966</span> protected final boolean checkKeyLen(final int v) {<a name="line.966"></a>
<span class="sourceLineNo">967</span> return v &lt;= 0 || v &gt; this.blockBuffer.limit();<a name="line.967"></a>
<span class="sourceLineNo">968</span> }<a name="line.968"></a>
<span class="sourceLineNo">969</span><a name="line.969"></a>
<span class="sourceLineNo">970</span> /** Returns True if v &amp;lt; 0 or v &amp;gt; current block buffer limit. */<a name="line.970"></a>
<span class="sourceLineNo">971</span> protected final boolean checkLen(final int v) {<a name="line.971"></a>
<span class="sourceLineNo">972</span> return v &lt; 0 || v &gt; this.blockBuffer.limit();<a name="line.972"></a>
<span class="sourceLineNo">973</span> }<a name="line.973"></a>
<span class="sourceLineNo">974</span><a name="line.974"></a>
<span class="sourceLineNo">975</span> /**<a name="line.975"></a>
<span class="sourceLineNo">976</span> * Check key and value lengths are wholesome.<a name="line.976"></a>
<span class="sourceLineNo">977</span> */<a name="line.977"></a>
<span class="sourceLineNo">978</span> protected final void checkKeyValueLen() {<a name="line.978"></a>
<span class="sourceLineNo">979</span> if (checkKeyLen(this.currKeyLen) || checkLen(this.currValueLen)) {<a name="line.979"></a>
<span class="sourceLineNo">980</span> throw new IllegalStateException("Invalid currKeyLen " + this.currKeyLen<a name="line.980"></a>
<span class="sourceLineNo">981</span> + " or currValueLen " + this.currValueLen + ". Block offset: " + this.curBlock.getOffset()<a name="line.981"></a>
<span class="sourceLineNo">982</span> + ", block length: " + this.blockBuffer.limit() + ", position: "<a name="line.982"></a>
<span class="sourceLineNo">983</span> + this.blockBuffer.position() + " (without header)." + ", path=" + reader.getPath());<a name="line.983"></a>
<span class="sourceLineNo">984</span> }<a name="line.984"></a>
<span class="sourceLineNo">985</span> }<a name="line.985"></a>
<span class="sourceLineNo">986</span><a name="line.986"></a>
<span class="sourceLineNo">987</span> /**<a name="line.987"></a>
<span class="sourceLineNo">988</span> * Updates the current block to be the given {@link HFileBlock}. Seeks to the the first<a name="line.988"></a>
<span class="sourceLineNo">989</span> * key/value pair.<a name="line.989"></a>
<span class="sourceLineNo">990</span> * @param newBlock the block read by {@link HFileReaderImpl#readBlock}, it's a totally new block<a name="line.990"></a>
<span class="sourceLineNo">991</span> * with new allocated {@link ByteBuff}, so if no further reference to this<a name="line.991"></a>
<span class="sourceLineNo">992</span> * block, we should release it carefully.<a name="line.992"></a>
<span class="sourceLineNo">993</span> */<a name="line.993"></a>
<span class="sourceLineNo">994</span> protected void updateCurrentBlock(HFileBlock newBlock) throws IOException {<a name="line.994"></a>
<span class="sourceLineNo">995</span> try {<a name="line.995"></a>
<span class="sourceLineNo">996</span> if (newBlock.getBlockType() != BlockType.DATA) {<a name="line.996"></a>
<span class="sourceLineNo">997</span> throw new IllegalStateException(<a name="line.997"></a>
<span class="sourceLineNo">998</span> "ScannerV2 works only on data blocks, got " + newBlock.getBlockType() + "; "<a name="line.998"></a>
<span class="sourceLineNo">999</span> + "HFileName=" + reader.getPath() + ", " + "dataBlockEncoder="<a name="line.999"></a>
<span class="sourceLineNo">1000</span> + reader.getDataBlockEncoding() + ", " + "isCompaction=" + isCompaction);<a name="line.1000"></a>
<span class="sourceLineNo">1001</span> }<a name="line.1001"></a>
<span class="sourceLineNo">1002</span> updateCurrBlockRef(newBlock);<a name="line.1002"></a>
<span class="sourceLineNo">1003</span> blockBuffer = newBlock.getBufferWithoutHeader();<a name="line.1003"></a>
<span class="sourceLineNo">1004</span> readKeyValueLen();<a name="line.1004"></a>
<span class="sourceLineNo">1005</span> } finally {<a name="line.1005"></a>
<span class="sourceLineNo">1006</span> releaseIfNotCurBlock(newBlock);<a name="line.1006"></a>
<span class="sourceLineNo">1007</span> }<a name="line.1007"></a>
<span class="sourceLineNo">1008</span> // Reset the next indexed key<a name="line.1008"></a>
<span class="sourceLineNo">1009</span> this.nextIndexedKey = null;<a name="line.1009"></a>
<span class="sourceLineNo">1010</span> }<a name="line.1010"></a>
<span class="sourceLineNo">1011</span><a name="line.1011"></a>
<span class="sourceLineNo">1012</span> protected Cell getFirstKeyCellInBlock(HFileBlock curBlock) {<a name="line.1012"></a>
<span class="sourceLineNo">1013</span> ByteBuff buffer = curBlock.getBufferWithoutHeader();<a name="line.1013"></a>
<span class="sourceLineNo">1014</span> // It is safe to manipulate this buffer because we own the buffer object.<a name="line.1014"></a>
<span class="sourceLineNo">1015</span> buffer.rewind();<a name="line.1015"></a>
<span class="sourceLineNo">1016</span> int klen = buffer.getInt();<a name="line.1016"></a>
<span class="sourceLineNo">1017</span> buffer.skip(Bytes.SIZEOF_INT);// Skip value len part<a name="line.1017"></a>
<span class="sourceLineNo">1018</span> ByteBuffer keyBuff = buffer.asSubByteBuffer(klen);<a name="line.1018"></a>
<span class="sourceLineNo">1019</span> if (keyBuff.hasArray()) {<a name="line.1019"></a>
<span class="sourceLineNo">1020</span> return new KeyValue.KeyOnlyKeyValue(keyBuff.array(),<a name="line.1020"></a>
<span class="sourceLineNo">1021</span> keyBuff.arrayOffset() + keyBuff.position(), klen);<a name="line.1021"></a>
<span class="sourceLineNo">1022</span> } else {<a name="line.1022"></a>
<span class="sourceLineNo">1023</span> return new ByteBufferKeyOnlyKeyValue(keyBuff, keyBuff.position(), klen);<a name="line.1023"></a>
<span class="sourceLineNo">1024</span> }<a name="line.1024"></a>
<span class="sourceLineNo">1025</span> }<a name="line.1025"></a>
<span class="sourceLineNo">1026</span><a name="line.1026"></a>
<span class="sourceLineNo">1027</span> @Override<a name="line.1027"></a>
<span class="sourceLineNo">1028</span> public String getKeyString() {<a name="line.1028"></a>
<span class="sourceLineNo">1029</span> return CellUtil.toString(getKey(), false);<a name="line.1029"></a>
<span class="sourceLineNo">1030</span> }<a name="line.1030"></a>
<span class="sourceLineNo">1031</span><a name="line.1031"></a>
<span class="sourceLineNo">1032</span> @Override<a name="line.1032"></a>
<span class="sourceLineNo">1033</span> public String getValueString() {<a name="line.1033"></a>
<span class="sourceLineNo">1034</span> return ByteBufferUtils.toStringBinary(getValue());<a name="line.1034"></a>
<span class="sourceLineNo">1035</span> }<a name="line.1035"></a>
<span class="sourceLineNo">1036</span><a name="line.1036"></a>
<span class="sourceLineNo">1037</span> public int compareKey(CellComparator comparator, Cell key) {<a name="line.1037"></a>
<span class="sourceLineNo">1038</span> blockBuffer.asSubByteBuffer(blockBuffer.position() + KEY_VALUE_LEN_SIZE, currKeyLen, pair);<a name="line.1038"></a>
<span class="sourceLineNo">1039</span> this.bufBackedKeyOnlyKv.setKey(pair.getFirst(), pair.getSecond(), currKeyLen, rowLen);<a name="line.1039"></a>
<span class="sourceLineNo">1040</span> return PrivateCellUtil.compareKeyIgnoresMvcc(comparator, key, this.bufBackedKeyOnlyKv);<a name="line.1040"></a>
<span class="sourceLineNo">1041</span> }<a name="line.1041"></a>
<span class="sourceLineNo">1042</span><a name="line.1042"></a>
<span class="sourceLineNo">1043</span> @Override<a name="line.1043"></a>
<span class="sourceLineNo">1044</span> public void shipped() throws IOException {<a name="line.1044"></a>
<span class="sourceLineNo">1045</span> this.returnBlocks(false);<a name="line.1045"></a>
<span class="sourceLineNo">1046</span> }<a name="line.1046"></a>
<span class="sourceLineNo">1047</span> }<a name="line.1047"></a>
<span class="sourceLineNo">1048</span><a name="line.1048"></a>
<span class="sourceLineNo">1049</span> @Override<a name="line.1049"></a>
<span class="sourceLineNo">1050</span> public Path getPath() {<a name="line.1050"></a>
<span class="sourceLineNo">1051</span> return path;<a name="line.1051"></a>
<span class="sourceLineNo">1052</span> }<a name="line.1052"></a>
<span class="sourceLineNo">1053</span><a name="line.1053"></a>
<span class="sourceLineNo">1054</span> @Override<a name="line.1054"></a>
<span class="sourceLineNo">1055</span> public DataBlockEncoding getDataBlockEncoding() {<a name="line.1055"></a>
<span class="sourceLineNo">1056</span> return dataBlockEncoder.getDataBlockEncoding();<a name="line.1056"></a>
<span class="sourceLineNo">1057</span> }<a name="line.1057"></a>
<span class="sourceLineNo">1058</span><a name="line.1058"></a>
<span class="sourceLineNo">1059</span> @Override<a name="line.1059"></a>
<span class="sourceLineNo">1060</span> public Configuration getConf() {<a name="line.1060"></a>
<span class="sourceLineNo">1061</span> return conf;<a name="line.1061"></a>
<span class="sourceLineNo">1062</span> }<a name="line.1062"></a>
<span class="sourceLineNo">1063</span><a name="line.1063"></a>
<span class="sourceLineNo">1064</span> @Override<a name="line.1064"></a>
<span class="sourceLineNo">1065</span> public void setConf(Configuration conf) {<a name="line.1065"></a>
<span class="sourceLineNo">1066</span> this.conf = conf;<a name="line.1066"></a>
<span class="sourceLineNo">1067</span> }<a name="line.1067"></a>
<span class="sourceLineNo">1068</span><a name="line.1068"></a>
<span class="sourceLineNo">1069</span> /** Minor versions in HFile starting with this number have hbase checksums */<a name="line.1069"></a>
<span class="sourceLineNo">1070</span> public static final int MINOR_VERSION_WITH_CHECKSUM = 1;<a name="line.1070"></a>
<span class="sourceLineNo">1071</span> /** In HFile minor version that does not support checksums */<a name="line.1071"></a>
<span class="sourceLineNo">1072</span> public static final int MINOR_VERSION_NO_CHECKSUM = 0;<a name="line.1072"></a>
<span class="sourceLineNo">1073</span><a name="line.1073"></a>
<span class="sourceLineNo">1074</span> /** HFile minor version that introduced pbuf filetrailer */<a name="line.1074"></a>
<span class="sourceLineNo">1075</span> public static final int PBUF_TRAILER_MINOR_VERSION = 2;<a name="line.1075"></a>
<span class="sourceLineNo">1076</span><a name="line.1076"></a>
<span class="sourceLineNo">1077</span> /**<a name="line.1077"></a>
<span class="sourceLineNo">1078</span> * The size of a (key length, value length) tuple that prefixes each entry in a data block.<a name="line.1078"></a>
<span class="sourceLineNo">1079</span> */<a name="line.1079"></a>
<span class="sourceLineNo">1080</span> public final static int KEY_VALUE_LEN_SIZE = 2 * Bytes.SIZEOF_INT;<a name="line.1080"></a>
<span class="sourceLineNo">1081</span><a name="line.1081"></a>
<span class="sourceLineNo">1082</span> /**<a name="line.1082"></a>
<span class="sourceLineNo">1083</span> * Retrieve block from cache. Validates the retrieved block's type vs {@code expectedBlockType}<a name="line.1083"></a>
<span class="sourceLineNo">1084</span> * and its encoding vs. {@code expectedDataBlockEncoding}. Unpacks the block as necessary.<a name="line.1084"></a>
<span class="sourceLineNo">1085</span> */<a name="line.1085"></a>
<span class="sourceLineNo">1086</span> private HFileBlock getCachedBlock(BlockCacheKey cacheKey, boolean cacheBlock, boolean useLock,<a name="line.1086"></a>
<span class="sourceLineNo">1087</span> boolean isCompaction, boolean updateCacheMetrics, BlockType expectedBlockType,<a name="line.1087"></a>
<span class="sourceLineNo">1088</span> DataBlockEncoding expectedDataBlockEncoding) throws IOException {<a name="line.1088"></a>
<span class="sourceLineNo">1089</span> // Check cache for block. If found return.<a name="line.1089"></a>
<span class="sourceLineNo">1090</span> BlockCache cache = cacheConf.getBlockCache().orElse(null);<a name="line.1090"></a>
<span class="sourceLineNo">1091</span> if (cache != null) {<a name="line.1091"></a>
<span class="sourceLineNo">1092</span> HFileBlock cachedBlock = (HFileBlock) cache.getBlock(cacheKey, cacheBlock, useLock,<a name="line.1092"></a>
<span class="sourceLineNo">1093</span> updateCacheMetrics, expectedBlockType);<a name="line.1093"></a>
<span class="sourceLineNo">1094</span> if (cachedBlock != null) {<a name="line.1094"></a>
<span class="sourceLineNo">1095</span> if (cacheConf.shouldCacheCompressed(cachedBlock.getBlockType().getCategory())) {<a name="line.1095"></a>
<span class="sourceLineNo">1096</span> HFileBlock compressedBlock = cachedBlock;<a name="line.1096"></a>
<span class="sourceLineNo">1097</span> cachedBlock = compressedBlock.unpack(hfileContext, fsBlockReader);<a name="line.1097"></a>
<span class="sourceLineNo">1098</span> // In case of compressed block after unpacking we can release the compressed block<a name="line.1098"></a>
<span class="sourceLineNo">1099</span> if (compressedBlock != cachedBlock) {<a name="line.1099"></a>
<span class="sourceLineNo">1100</span> compressedBlock.release();<a name="line.1100"></a>
<span class="sourceLineNo">1101</span> }<a name="line.1101"></a>
<span class="sourceLineNo">1102</span> }<a name="line.1102"></a>
<span class="sourceLineNo">1103</span> try {<a name="line.1103"></a>
<span class="sourceLineNo">1104</span> validateBlockType(cachedBlock, expectedBlockType);<a name="line.1104"></a>
<span class="sourceLineNo">1105</span> } catch (IOException e) {<a name="line.1105"></a>
<span class="sourceLineNo">1106</span> returnAndEvictBlock(cache, cacheKey, cachedBlock);<a name="line.1106"></a>
<span class="sourceLineNo">1107</span> throw e;<a name="line.1107"></a>
<span class="sourceLineNo">1108</span> }<a name="line.1108"></a>
<span class="sourceLineNo">1109</span><a name="line.1109"></a>
<span class="sourceLineNo">1110</span> if (expectedDataBlockEncoding == null) {<a name="line.1110"></a>
<span class="sourceLineNo">1111</span> return cachedBlock;<a name="line.1111"></a>
<span class="sourceLineNo">1112</span> }<a name="line.1112"></a>
<span class="sourceLineNo">1113</span> DataBlockEncoding actualDataBlockEncoding = cachedBlock.getDataBlockEncoding();<a name="line.1113"></a>
<span class="sourceLineNo">1114</span> // Block types other than data blocks always have<a name="line.1114"></a>
<span class="sourceLineNo">1115</span> // DataBlockEncoding.NONE. To avoid false negative cache misses, only<a name="line.1115"></a>
<span class="sourceLineNo">1116</span> // perform this check if cached block is a data block.<a name="line.1116"></a>
<span class="sourceLineNo">1117</span> if (<a name="line.1117"></a>
<span class="sourceLineNo">1118</span> cachedBlock.getBlockType().isData()<a name="line.1118"></a>
<span class="sourceLineNo">1119</span> &amp;&amp; !actualDataBlockEncoding.equals(expectedDataBlockEncoding)<a name="line.1119"></a>
<span class="sourceLineNo">1120</span> ) {<a name="line.1120"></a>
<span class="sourceLineNo">1121</span> // This mismatch may happen if a Scanner, which is used for say a<a name="line.1121"></a>
<span class="sourceLineNo">1122</span> // compaction, tries to read an encoded block from the block cache.<a name="line.1122"></a>
<span class="sourceLineNo">1123</span> // The reverse might happen when an EncodedScanner tries to read<a name="line.1123"></a>
<span class="sourceLineNo">1124</span> // un-encoded blocks which were cached earlier.<a name="line.1124"></a>
<span class="sourceLineNo">1125</span> //<a name="line.1125"></a>
<span class="sourceLineNo">1126</span> // Because returning a data block with an implicit BlockType mismatch<a name="line.1126"></a>
<span class="sourceLineNo">1127</span> // will cause the requesting scanner to throw a disk read should be<a name="line.1127"></a>
<span class="sourceLineNo">1128</span> // forced here. This will potentially cause a significant number of<a name="line.1128"></a>
<span class="sourceLineNo">1129</span> // cache misses, so update so we should keep track of this as it might<a name="line.1129"></a>
<span class="sourceLineNo">1130</span> // justify the work on a CompoundScanner.<a name="line.1130"></a>
<span class="sourceLineNo">1131</span> if (<a name="line.1131"></a>
<span class="sourceLineNo">1132</span> !expectedDataBlockEncoding.equals(DataBlockEncoding.NONE)<a name="line.1132"></a>
<span class="sourceLineNo">1133</span> &amp;&amp; !actualDataBlockEncoding.equals(DataBlockEncoding.NONE)<a name="line.1133"></a>
<span class="sourceLineNo">1134</span> ) {<a name="line.1134"></a>
<span class="sourceLineNo">1135</span> // If the block is encoded but the encoding does not match the<a name="line.1135"></a>
<span class="sourceLineNo">1136</span> // expected encoding it is likely the encoding was changed but the<a name="line.1136"></a>
<span class="sourceLineNo">1137</span> // block was not yet evicted. Evictions on file close happen async<a name="line.1137"></a>
<span class="sourceLineNo">1138</span> // so blocks with the old encoding still linger in cache for some<a name="line.1138"></a>
<span class="sourceLineNo">1139</span> // period of time. This event should be rare as it only happens on<a name="line.1139"></a>
<span class="sourceLineNo">1140</span> // schema definition change.<a name="line.1140"></a>
<span class="sourceLineNo">1141</span> LOG.info(<a name="line.1141"></a>
<span class="sourceLineNo">1142</span> "Evicting cached block with key {} because data block encoding mismatch; "<a name="line.1142"></a>
<span class="sourceLineNo">1143</span> + "expected {}, actual {}, path={}",<a name="line.1143"></a>
<span class="sourceLineNo">1144</span> cacheKey, actualDataBlockEncoding, expectedDataBlockEncoding, path);<a name="line.1144"></a>
<span class="sourceLineNo">1145</span> // This is an error scenario. so here we need to release the block.<a name="line.1145"></a>
<span class="sourceLineNo">1146</span> returnAndEvictBlock(cache, cacheKey, cachedBlock);<a name="line.1146"></a>
<span class="sourceLineNo">1147</span> }<a name="line.1147"></a>
<span class="sourceLineNo">1148</span> return null;<a name="line.1148"></a>
<span class="sourceLineNo">1149</span> }<a name="line.1149"></a>
<span class="sourceLineNo">1150</span> return cachedBlock;<a name="line.1150"></a>
<span class="sourceLineNo">1151</span> }<a name="line.1151"></a>
<span class="sourceLineNo">1152</span> }<a name="line.1152"></a>
<span class="sourceLineNo">1153</span> return null;<a name="line.1153"></a>
<span class="sourceLineNo">1154</span> }<a name="line.1154"></a>
<span class="sourceLineNo">1155</span><a name="line.1155"></a>
<span class="sourceLineNo">1156</span> private void returnAndEvictBlock(BlockCache cache, BlockCacheKey cacheKey, Cacheable block) {<a name="line.1156"></a>
<span class="sourceLineNo">1157</span> block.release();<a name="line.1157"></a>
<span class="sourceLineNo">1158</span> cache.evictBlock(cacheKey);<a name="line.1158"></a>
<span class="sourceLineNo">1159</span> }<a name="line.1159"></a>
<span class="sourceLineNo">1160</span><a name="line.1160"></a>
<span class="sourceLineNo">1161</span> /**<a name="line.1161"></a>
<span class="sourceLineNo">1162</span> * @param cacheBlock Add block to cache, if found<a name="line.1162"></a>
<span class="sourceLineNo">1163</span> * @return block wrapped in a ByteBuffer, with header skipped<a name="line.1163"></a>
<span class="sourceLineNo">1164</span> */<a name="line.1164"></a>
<span class="sourceLineNo">1165</span> @Override<a name="line.1165"></a>
<span class="sourceLineNo">1166</span> public HFileBlock getMetaBlock(String metaBlockName, boolean cacheBlock) throws IOException {<a name="line.1166"></a>
<span class="sourceLineNo">1167</span> if (trailer.getMetaIndexCount() == 0) {<a name="line.1167"></a>
<span class="sourceLineNo">1168</span> return null; // there are no meta blocks<a name="line.1168"></a>
<span class="sourceLineNo">1169</span> }<a name="line.1169"></a>
<span class="sourceLineNo">1170</span> if (metaBlockIndexReader == null) {<a name="line.1170"></a>
<span class="sourceLineNo">1171</span> throw new IOException(path + " meta index not loaded");<a name="line.1171"></a>
<span class="sourceLineNo">1172</span> }<a name="line.1172"></a>
<span class="sourceLineNo">1173</span><a name="line.1173"></a>
<span class="sourceLineNo">1174</span> byte[] mbname = Bytes.toBytes(metaBlockName);<a name="line.1174"></a>
<span class="sourceLineNo">1175</span> int block = metaBlockIndexReader.rootBlockContainingKey(mbname, 0, mbname.length);<a name="line.1175"></a>
<span class="sourceLineNo">1176</span> if (block == -1) {<a name="line.1176"></a>
<span class="sourceLineNo">1177</span> return null;<a name="line.1177"></a>
<span class="sourceLineNo">1178</span> }<a name="line.1178"></a>
<span class="sourceLineNo">1179</span> long blockSize = metaBlockIndexReader.getRootBlockDataSize(block);<a name="line.1179"></a>
<span class="sourceLineNo">1180</span><a name="line.1180"></a>
<span class="sourceLineNo">1181</span> // Per meta key from any given file, synchronize reads for said block. This<a name="line.1181"></a>
<span class="sourceLineNo">1182</span> // is OK to do for meta blocks because the meta block index is always<a name="line.1182"></a>
<span class="sourceLineNo">1183</span> // single-level.<a name="line.1183"></a>
<span class="sourceLineNo">1184</span> synchronized (metaBlockIndexReader.getRootBlockKey(block)) {<a name="line.1184"></a>
<span class="sourceLineNo">1185</span> // Check cache for block. If found return.<a name="line.1185"></a>
<span class="sourceLineNo">1186</span> long metaBlockOffset = metaBlockIndexReader.getRootBlockOffset(block);<a name="line.1186"></a>
<span class="sourceLineNo">1187</span> BlockCacheKey cacheKey =<a name="line.1187"></a>
<span class="sourceLineNo">1188</span> new BlockCacheKey(name, metaBlockOffset, this.isPrimaryReplicaReader(), BlockType.META);<a name="line.1188"></a>
<span class="sourceLineNo">1189</span><a name="line.1189"></a>
<span class="sourceLineNo">1190</span> cacheBlock &amp;= cacheConf.shouldCacheBlockOnRead(BlockType.META.getCategory());<a name="line.1190"></a>
<span class="sourceLineNo">1191</span> HFileBlock cachedBlock =<a name="line.1191"></a>
<span class="sourceLineNo">1192</span> getCachedBlock(cacheKey, cacheBlock, false, true, true, BlockType.META, null);<a name="line.1192"></a>
<span class="sourceLineNo">1193</span> if (cachedBlock != null) {<a name="line.1193"></a>
<span class="sourceLineNo">1194</span> assert cachedBlock.isUnpacked() : "Packed block leak.";<a name="line.1194"></a>
<span class="sourceLineNo">1195</span> // Return a distinct 'shallow copy' of the block,<a name="line.1195"></a>
<span class="sourceLineNo">1196</span> // so pos does not get messed by the scanner<a name="line.1196"></a>
<span class="sourceLineNo">1197</span> return cachedBlock;<a name="line.1197"></a>
<span class="sourceLineNo">1198</span> }<a name="line.1198"></a>
<span class="sourceLineNo">1199</span> // Cache Miss, please load.<a name="line.1199"></a>
<span class="sourceLineNo">1200</span><a name="line.1200"></a>
<span class="sourceLineNo">1201</span> HFileBlock compressedBlock =<a name="line.1201"></a>
<span class="sourceLineNo">1202</span> fsBlockReader.readBlockData(metaBlockOffset, blockSize, true, false, true);<a name="line.1202"></a>
<span class="sourceLineNo">1203</span> HFileBlock uncompressedBlock = compressedBlock.unpack(hfileContext, fsBlockReader);<a name="line.1203"></a>
<span class="sourceLineNo">1204</span> if (compressedBlock != uncompressedBlock) {<a name="line.1204"></a>
<span class="sourceLineNo">1205</span> compressedBlock.release();<a name="line.1205"></a>
<span class="sourceLineNo">1206</span> }<a name="line.1206"></a>
<span class="sourceLineNo">1207</span><a name="line.1207"></a>
<span class="sourceLineNo">1208</span> // Cache the block<a name="line.1208"></a>
<span class="sourceLineNo">1209</span> if (cacheBlock) {<a name="line.1209"></a>
<span class="sourceLineNo">1210</span> cacheConf.getBlockCache().ifPresent(<a name="line.1210"></a>
<span class="sourceLineNo">1211</span> cache -&gt; cache.cacheBlock(cacheKey, uncompressedBlock, cacheConf.isInMemory()));<a name="line.1211"></a>
<span class="sourceLineNo">1212</span> }<a name="line.1212"></a>
<span class="sourceLineNo">1213</span> return uncompressedBlock;<a name="line.1213"></a>
<span class="sourceLineNo">1214</span> }<a name="line.1214"></a>
<span class="sourceLineNo">1215</span> }<a name="line.1215"></a>
<span class="sourceLineNo">1216</span><a name="line.1216"></a>
<span class="sourceLineNo">1217</span> /**<a name="line.1217"></a>
<span class="sourceLineNo">1218</span> * If expected block is data block, we'll allocate the ByteBuff of block from<a name="line.1218"></a>
<span class="sourceLineNo">1219</span> * {@link org.apache.hadoop.hbase.io.ByteBuffAllocator} and it's usually an off-heap one,<a name="line.1219"></a>
<span class="sourceLineNo">1220</span> * otherwise it will allocate from heap.<a name="line.1220"></a>
<span class="sourceLineNo">1221</span> * @see org.apache.hadoop.hbase.io.hfile.HFileBlock.FSReader#readBlockData(long, long, boolean,<a name="line.1221"></a>
<span class="sourceLineNo">1222</span> * boolean, boolean)<a name="line.1222"></a>
<span class="sourceLineNo">1223</span> */<a name="line.1223"></a>
<span class="sourceLineNo">1224</span> private boolean shouldUseHeap(BlockType expectedBlockType) {<a name="line.1224"></a>
<span class="sourceLineNo">1225</span> if (!cacheConf.getBlockCache().isPresent()) {<a name="line.1225"></a>
<span class="sourceLineNo">1226</span> return false;<a name="line.1226"></a>
<span class="sourceLineNo">1227</span> } else if (!cacheConf.isCombinedBlockCache()) {<a name="line.1227"></a>
<span class="sourceLineNo">1228</span> // Block to cache in LruBlockCache must be an heap one. So just allocate block memory from<a name="line.1228"></a>
<span class="sourceLineNo">1229</span> // heap for saving an extra off-heap to heap copying.<a name="line.1229"></a>
<span class="sourceLineNo">1230</span> return true;<a name="line.1230"></a>
<span class="sourceLineNo">1231</span> }<a name="line.1231"></a>
<span class="sourceLineNo">1232</span> return expectedBlockType != null &amp;&amp; !expectedBlockType.isData();<a name="line.1232"></a>
<span class="sourceLineNo">1233</span> }<a name="line.1233"></a>
<span class="sourceLineNo">1234</span><a name="line.1234"></a>
<span class="sourceLineNo">1235</span> @Override<a name="line.1235"></a>
<span class="sourceLineNo">1236</span> public HFileBlock readBlock(long dataBlockOffset, long onDiskBlockSize, final boolean cacheBlock,<a name="line.1236"></a>
<span class="sourceLineNo">1237</span> boolean pread, final boolean isCompaction, boolean updateCacheMetrics,<a name="line.1237"></a>
<span class="sourceLineNo">1238</span> BlockType expectedBlockType, DataBlockEncoding expectedDataBlockEncoding) throws IOException {<a name="line.1238"></a>
<span class="sourceLineNo">1239</span> if (dataBlockIndexReader == null) {<a name="line.1239"></a>
<span class="sourceLineNo">1240</span> throw new IOException(path + " block index not loaded");<a name="line.1240"></a>
<span class="sourceLineNo">1241</span> }<a name="line.1241"></a>
<span class="sourceLineNo">1242</span> long trailerOffset = trailer.getLoadOnOpenDataOffset();<a name="line.1242"></a>
<span class="sourceLineNo">1243</span> if (dataBlockOffset &lt; 0 || dataBlockOffset &gt;= trailerOffset) {<a name="line.1243"></a>
<span class="sourceLineNo">1244</span> throw new IOException("Requested block is out of range: " + dataBlockOffset<a name="line.1244"></a>
<span class="sourceLineNo">1245</span> + ", lastDataBlockOffset: " + trailer.getLastDataBlockOffset()<a name="line.1245"></a>
<span class="sourceLineNo">1246</span> + ", trailer.getLoadOnOpenDataOffset: " + trailerOffset + ", path=" + path);<a name="line.1246"></a>
<span class="sourceLineNo">1247</span> }<a name="line.1247"></a>
<span class="sourceLineNo">1248</span> // For any given block from any given file, synchronize reads for said<a name="line.1248"></a>
<span class="sourceLineNo">1249</span> // block.<a name="line.1249"></a>
<span class="sourceLineNo">1250</span> // Without a cache, this synchronizing is needless overhead, but really<a name="line.1250"></a>
<span class="sourceLineNo">1251</span> // the other choice is to duplicate work (which the cache would prevent you<a name="line.1251"></a>
<span class="sourceLineNo">1252</span> // from doing).<a name="line.1252"></a>
<span class="sourceLineNo">1253</span><a name="line.1253"></a>
<span class="sourceLineNo">1254</span> BlockCacheKey cacheKey =<a name="line.1254"></a>
<span class="sourceLineNo">1255</span> new BlockCacheKey(name, dataBlockOffset, this.isPrimaryReplicaReader(), expectedBlockType);<a name="line.1255"></a>
<span class="sourceLineNo">1256</span> Attributes attributes = Attributes.of(BLOCK_CACHE_KEY_KEY, cacheKey.toString());<a name="line.1256"></a>
<span class="sourceLineNo">1257</span><a name="line.1257"></a>
<span class="sourceLineNo">1258</span> boolean useLock = false;<a name="line.1258"></a>
<span class="sourceLineNo">1259</span> IdLock.Entry lockEntry = null;<a name="line.1259"></a>
<span class="sourceLineNo">1260</span> final Span span = Span.current();<a name="line.1260"></a>
<span class="sourceLineNo">1261</span> try {<a name="line.1261"></a>
<span class="sourceLineNo">1262</span> while (true) {<a name="line.1262"></a>
<span class="sourceLineNo">1263</span> // Check cache for block. If found return.<a name="line.1263"></a>
<span class="sourceLineNo">1264</span> if (cacheConf.shouldReadBlockFromCache(expectedBlockType)) {<a name="line.1264"></a>
<span class="sourceLineNo">1265</span> if (useLock) {<a name="line.1265"></a>
<span class="sourceLineNo">1266</span> lockEntry = offsetLock.getLockEntry(dataBlockOffset);<a name="line.1266"></a>
<span class="sourceLineNo">1267</span> }<a name="line.1267"></a>
<span class="sourceLineNo">1268</span> // Try and get the block from the block cache. If the useLock variable is true then this<a name="line.1268"></a>
<span class="sourceLineNo">1269</span> // is the second time through the loop and it should not be counted as a block cache miss.<a name="line.1269"></a>
<span class="sourceLineNo">1270</span> HFileBlock cachedBlock = getCachedBlock(cacheKey, cacheBlock, useLock, isCompaction,<a name="line.1270"></a>
<span class="sourceLineNo">1271</span> updateCacheMetrics, expectedBlockType, expectedDataBlockEncoding);<a name="line.1271"></a>
<span class="sourceLineNo">1272</span> if (cachedBlock != null) {<a name="line.1272"></a>
<span class="sourceLineNo">1273</span> if (LOG.isTraceEnabled()) {<a name="line.1273"></a>
<span class="sourceLineNo">1274</span> LOG.trace("From Cache {}", cachedBlock);<a name="line.1274"></a>
<span class="sourceLineNo">1275</span> }<a name="line.1275"></a>
<span class="sourceLineNo">1276</span> span.addEvent("block cache hit", attributes);<a name="line.1276"></a>
<span class="sourceLineNo">1277</span> assert cachedBlock.isUnpacked() : "Packed block leak.";<a name="line.1277"></a>
<span class="sourceLineNo">1278</span> if (cachedBlock.getBlockType().isData()) {<a name="line.1278"></a>
<span class="sourceLineNo">1279</span> if (updateCacheMetrics) {<a name="line.1279"></a>
<span class="sourceLineNo">1280</span> HFile.DATABLOCK_READ_COUNT.increment();<a name="line.1280"></a>
<span class="sourceLineNo">1281</span> }<a name="line.1281"></a>
<span class="sourceLineNo">1282</span> // Validate encoding type for data blocks. We include encoding<a name="line.1282"></a>
<span class="sourceLineNo">1283</span> // type in the cache key, and we expect it to match on a cache hit.<a name="line.1283"></a>
<span class="sourceLineNo">1284</span> if (cachedBlock.getDataBlockEncoding() != dataBlockEncoder.getDataBlockEncoding()) {<a name="line.1284"></a>
<span class="sourceLineNo">1285</span> // Remember to release the block when in exceptional path.<a name="line.1285"></a>
<span class="sourceLineNo">1286</span> cacheConf.getBlockCache().ifPresent(cache -&gt; {<a name="line.1286"></a>
<span class="sourceLineNo">1287</span> returnAndEvictBlock(cache, cacheKey, cachedBlock);<a name="line.1287"></a>
<span class="sourceLineNo">1288</span> });<a name="line.1288"></a>
<span class="sourceLineNo">1289</span> throw new IOException("Cached block under key " + cacheKey + " "<a name="line.1289"></a>
<span class="sourceLineNo">1290</span> + "has wrong encoding: " + cachedBlock.getDataBlockEncoding() + " (expected: "<a name="line.1290"></a>
<span class="sourceLineNo">1291</span> + dataBlockEncoder.getDataBlockEncoding() + "), path=" + path);<a name="line.1291"></a>
<span class="sourceLineNo">1292</span> }<a name="line.1292"></a>
<span class="sourceLineNo">1293</span> }<a name="line.1293"></a>
<span class="sourceLineNo">1294</span> // Cache-hit. Return!<a name="line.1294"></a>
<span class="sourceLineNo">1295</span> return cachedBlock;<a name="line.1295"></a>
<span class="sourceLineNo">1296</span> }<a name="line.1296"></a>
<span class="sourceLineNo">1297</span><a name="line.1297"></a>
<span class="sourceLineNo">1298</span> if (!useLock &amp;&amp; cacheBlock &amp;&amp; cacheConf.shouldLockOnCacheMiss(expectedBlockType)) {<a name="line.1298"></a>
<span class="sourceLineNo">1299</span> // check cache again with lock<a name="line.1299"></a>
<span class="sourceLineNo">1300</span> useLock = true;<a name="line.1300"></a>
<span class="sourceLineNo">1301</span> continue;<a name="line.1301"></a>
<span class="sourceLineNo">1302</span> }<a name="line.1302"></a>
<span class="sourceLineNo">1303</span> // Carry on, please load.<a name="line.1303"></a>
<span class="sourceLineNo">1304</span> }<a name="line.1304"></a>
<span class="sourceLineNo">1305</span><a name="line.1305"></a>
<span class="sourceLineNo">1306</span> span.addEvent("block cache miss", attributes);<a name="line.1306"></a>
<span class="sourceLineNo">1307</span> // Load block from filesystem.<a name="line.1307"></a>
<span class="sourceLineNo">1308</span> HFileBlock hfileBlock = fsBlockReader.readBlockData(dataBlockOffset, onDiskBlockSize, pread,<a name="line.1308"></a>
<span class="sourceLineNo">1309</span> !isCompaction, shouldUseHeap(expectedBlockType));<a name="line.1309"></a>
<span class="sourceLineNo">1310</span> validateBlockType(hfileBlock, expectedBlockType);<a name="line.1310"></a>
<span class="sourceLineNo">1311</span> HFileBlock unpacked = hfileBlock.unpack(hfileContext, fsBlockReader);<a name="line.1311"></a>
<span class="sourceLineNo">1312</span> BlockType.BlockCategory category = hfileBlock.getBlockType().getCategory();<a name="line.1312"></a>
<span class="sourceLineNo">1313</span><a name="line.1313"></a>
<span class="sourceLineNo">1314</span> // Cache the block if necessary<a name="line.1314"></a>
<span class="sourceLineNo">1315</span> cacheConf.getBlockCache().ifPresent(cache -&gt; {<a name="line.1315"></a>
<span class="sourceLineNo">1316</span> if (cacheBlock &amp;&amp; cacheConf.shouldCacheBlockOnRead(category)) {<a name="line.1316"></a>
<span class="sourceLineNo">1317</span> cache.cacheBlock(cacheKey,<a name="line.1317"></a>
<span class="sourceLineNo">1318</span> cacheConf.shouldCacheCompressed(category) ? hfileBlock : unpacked,<a name="line.1318"></a>
<span class="sourceLineNo">1319</span> cacheConf.isInMemory());<a name="line.1319"></a>
<span class="sourceLineNo">1320</span> }<a name="line.1320"></a>
<span class="sourceLineNo">1321</span> });<a name="line.1321"></a>
<span class="sourceLineNo">1322</span> if (unpacked != hfileBlock) {<a name="line.1322"></a>
<span class="sourceLineNo">1323</span> // End of life here if hfileBlock is an independent block.<a name="line.1323"></a>
<span class="sourceLineNo">1324</span> hfileBlock.release();<a name="line.1324"></a>
<span class="sourceLineNo">1325</span> }<a name="line.1325"></a>
<span class="sourceLineNo">1326</span> if (updateCacheMetrics &amp;&amp; hfileBlock.getBlockType().isData()) {<a name="line.1326"></a>
<span class="sourceLineNo">1327</span> HFile.DATABLOCK_READ_COUNT.increment();<a name="line.1327"></a>
<span class="sourceLineNo">1328</span> }<a name="line.1328"></a>
<span class="sourceLineNo">1329</span><a name="line.1329"></a>
<span class="sourceLineNo">1330</span> return unpacked;<a name="line.1330"></a>
<span class="sourceLineNo">1331</span> }<a name="line.1331"></a>
<span class="sourceLineNo">1332</span> } finally {<a name="line.1332"></a>
<span class="sourceLineNo">1333</span> if (lockEntry != null) {<a name="line.1333"></a>
<span class="sourceLineNo">1334</span> offsetLock.releaseLockEntry(lockEntry);<a name="line.1334"></a>
<span class="sourceLineNo">1335</span> }<a name="line.1335"></a>
<span class="sourceLineNo">1336</span> }<a name="line.1336"></a>
<span class="sourceLineNo">1337</span> }<a name="line.1337"></a>
<span class="sourceLineNo">1338</span><a name="line.1338"></a>
<span class="sourceLineNo">1339</span> @Override<a name="line.1339"></a>
<span class="sourceLineNo">1340</span> public boolean hasMVCCInfo() {<a name="line.1340"></a>
<span class="sourceLineNo">1341</span> return fileInfo.shouldIncludeMemStoreTS() &amp;&amp; fileInfo.isDecodeMemstoreTS();<a name="line.1341"></a>
<span class="sourceLineNo">1342</span> }<a name="line.1342"></a>
<span class="sourceLineNo">1343</span><a name="line.1343"></a>
<span class="sourceLineNo">1344</span> /**<a name="line.1344"></a>
<span class="sourceLineNo">1345</span> * Compares the actual type of a block retrieved from cache or disk with its expected type and<a name="line.1345"></a>
<span class="sourceLineNo">1346</span> * throws an exception in case of a mismatch. Expected block type of {@link BlockType#DATA} is<a name="line.1346"></a>
<span class="sourceLineNo">1347</span> * considered to match the actual block type [@link {@link BlockType#ENCODED_DATA} as well.<a name="line.1347"></a>
<span class="sourceLineNo">1348</span> * @param block a block retrieved from cache or disk<a name="line.1348"></a>
<span class="sourceLineNo">1349</span> * @param expectedBlockType the expected block type, or null to skip the check<a name="line.1349"></a>
<span class="sourceLineNo">1350</span> */<a name="line.1350"></a>
<span class="sourceLineNo">1351</span> private void validateBlockType(HFileBlock block, BlockType expectedBlockType) throws IOException {<a name="line.1351"></a>
<span class="sourceLineNo">1352</span> if (expectedBlockType == null) {<a name="line.1352"></a>
<span class="sourceLineNo">1353</span> return;<a name="line.1353"></a>
<span class="sourceLineNo">1354</span> }<a name="line.1354"></a>
<span class="sourceLineNo">1355</span> BlockType actualBlockType = block.getBlockType();<a name="line.1355"></a>
<span class="sourceLineNo">1356</span> if (expectedBlockType.isData() &amp;&amp; actualBlockType.isData()) {<a name="line.1356"></a>
<span class="sourceLineNo">1357</span> // We consider DATA to match ENCODED_DATA for the purpose of this<a name="line.1357"></a>
<span class="sourceLineNo">1358</span> // verification.<a name="line.1358"></a>
<span class="sourceLineNo">1359</span> return;<a name="line.1359"></a>
<span class="sourceLineNo">1360</span> }<a name="line.1360"></a>
<span class="sourceLineNo">1361</span> if (actualBlockType != expectedBlockType) {<a name="line.1361"></a>
<span class="sourceLineNo">1362</span> throw new IOException("Expected block type " + expectedBlockType + ", " + "but got "<a name="line.1362"></a>
<span class="sourceLineNo">1363</span> + actualBlockType + ": " + block + ", path=" + path);<a name="line.1363"></a>
<span class="sourceLineNo">1364</span> }<a name="line.1364"></a>
<span class="sourceLineNo">1365</span> }<a name="line.1365"></a>
<span class="sourceLineNo">1366</span><a name="line.1366"></a>
<span class="sourceLineNo">1367</span> /**<a name="line.1367"></a>
<span class="sourceLineNo">1368</span> * @return Last key as cell in the file. May be null if file has no entries. Note that this is not<a name="line.1368"></a>
<span class="sourceLineNo">1369</span> * the last row key, but it is the Cell representation of the last key<a name="line.1369"></a>
<span class="sourceLineNo">1370</span> */<a name="line.1370"></a>
<span class="sourceLineNo">1371</span> @Override<a name="line.1371"></a>
<span class="sourceLineNo">1372</span> public Optional&lt;Cell&gt; getLastKey() {<a name="line.1372"></a>
<span class="sourceLineNo">1373</span> return dataBlockIndexReader.isEmpty()<a name="line.1373"></a>
<span class="sourceLineNo">1374</span> ? Optional.empty()<a name="line.1374"></a>
<span class="sourceLineNo">1375</span> : Optional.of(fileInfo.getLastKeyCell());<a name="line.1375"></a>
<span class="sourceLineNo">1376</span> }<a name="line.1376"></a>
<span class="sourceLineNo">1377</span><a name="line.1377"></a>
<span class="sourceLineNo">1378</span> /**<a name="line.1378"></a>
<span class="sourceLineNo">1379</span> * @return Midkey for this file. We work with block boundaries only so returned midkey is an<a name="line.1379"></a>
<span class="sourceLineNo">1380</span> * approximation only.<a name="line.1380"></a>
<span class="sourceLineNo">1381</span> */<a name="line.1381"></a>
<span class="sourceLineNo">1382</span> @Override<a name="line.1382"></a>
<span class="sourceLineNo">1383</span> public Optional&lt;Cell&gt; midKey() throws IOException {<a name="line.1383"></a>
<span class="sourceLineNo">1384</span> return Optional.ofNullable(dataBlockIndexReader.midkey(this));<a name="line.1384"></a>
<span class="sourceLineNo">1385</span> }<a name="line.1385"></a>
<span class="sourceLineNo">1386</span><a name="line.1386"></a>
<span class="sourceLineNo">1387</span> @Override<a name="line.1387"></a>
<span class="sourceLineNo">1388</span> public void close() throws IOException {<a name="line.1388"></a>
<span class="sourceLineNo">1389</span> close(cacheConf.shouldEvictOnClose());<a name="line.1389"></a>
<span class="sourceLineNo">1390</span> }<a name="line.1390"></a>
<span class="sourceLineNo">1391</span><a name="line.1391"></a>
<span class="sourceLineNo">1392</span> @Override<a name="line.1392"></a>
<span class="sourceLineNo">1393</span> public DataBlockEncoding getEffectiveEncodingInCache(boolean isCompaction) {<a name="line.1393"></a>
<span class="sourceLineNo">1394</span> return dataBlockEncoder.getEffectiveEncodingInCache(isCompaction);<a name="line.1394"></a>
<span class="sourceLineNo">1395</span> }<a name="line.1395"></a>
<span class="sourceLineNo">1396</span><a name="line.1396"></a>
<span class="sourceLineNo">1397</span> /** For testing */<a name="line.1397"></a>
<span class="sourceLineNo">1398</span> @Override<a name="line.1398"></a>
<span class="sourceLineNo">1399</span> public HFileBlock.FSReader getUncachedBlockReader() {<a name="line.1399"></a>
<span class="sourceLineNo">1400</span> return fsBlockReader;<a name="line.1400"></a>
<span class="sourceLineNo">1401</span> }<a name="line.1401"></a>
<span class="sourceLineNo">1402</span><a name="line.1402"></a>
<span class="sourceLineNo">1403</span> /**<a name="line.1403"></a>
<span class="sourceLineNo">1404</span> * Scanner that operates on encoded data blocks.<a name="line.1404"></a>
<span class="sourceLineNo">1405</span> */<a name="line.1405"></a>
<span class="sourceLineNo">1406</span> protected static class EncodedScanner extends HFileScannerImpl {<a name="line.1406"></a>
<span class="sourceLineNo">1407</span> private final HFileBlockDecodingContext decodingCtx;<a name="line.1407"></a>
<span class="sourceLineNo">1408</span> private final DataBlockEncoder.EncodedSeeker seeker;<a name="line.1408"></a>
<span class="sourceLineNo">1409</span> private final DataBlockEncoder dataBlockEncoder;<a name="line.1409"></a>
<span class="sourceLineNo">1410</span><a name="line.1410"></a>
<span class="sourceLineNo">1411</span> public EncodedScanner(HFile.Reader reader, boolean cacheBlocks, boolean pread,<a name="line.1411"></a>
<span class="sourceLineNo">1412</span> boolean isCompaction, HFileContext meta, Configuration conf) {<a name="line.1412"></a>
<span class="sourceLineNo">1413</span> super(reader, cacheBlocks, pread, isCompaction);<a name="line.1413"></a>
<span class="sourceLineNo">1414</span> DataBlockEncoding encoding = reader.getDataBlockEncoding();<a name="line.1414"></a>
<span class="sourceLineNo">1415</span> dataBlockEncoder = encoding.getEncoder();<a name="line.1415"></a>
<span class="sourceLineNo">1416</span> decodingCtx = dataBlockEncoder.newDataBlockDecodingContext(conf, meta);<a name="line.1416"></a>
<span class="sourceLineNo">1417</span> seeker = dataBlockEncoder.createSeeker(decodingCtx);<a name="line.1417"></a>
<span class="sourceLineNo">1418</span> }<a name="line.1418"></a>
<span class="sourceLineNo">1419</span><a name="line.1419"></a>
<span class="sourceLineNo">1420</span> @Override<a name="line.1420"></a>
<span class="sourceLineNo">1421</span> public boolean isSeeked() {<a name="line.1421"></a>
<span class="sourceLineNo">1422</span> return curBlock != null;<a name="line.1422"></a>
<span class="sourceLineNo">1423</span> }<a name="line.1423"></a>
<span class="sourceLineNo">1424</span><a name="line.1424"></a>
<span class="sourceLineNo">1425</span> @Override<a name="line.1425"></a>
<span class="sourceLineNo">1426</span> public void setNonSeekedState() {<a name="line.1426"></a>
<span class="sourceLineNo">1427</span> reset();<a name="line.1427"></a>
<span class="sourceLineNo">1428</span> }<a name="line.1428"></a>
<span class="sourceLineNo">1429</span><a name="line.1429"></a>
<span class="sourceLineNo">1430</span> /**<a name="line.1430"></a>
<span class="sourceLineNo">1431</span> * Updates the current block to be the given {@link HFileBlock}. Seeks to the the first<a name="line.1431"></a>
<span class="sourceLineNo">1432</span> * key/value pair.<a name="line.1432"></a>
<span class="sourceLineNo">1433</span> * @param newBlock the block to make current, and read by {@link HFileReaderImpl#readBlock},<a name="line.1433"></a>
<span class="sourceLineNo">1434</span> * it's a totally new block with new allocated {@link ByteBuff}, so if no<a name="line.1434"></a>
<span class="sourceLineNo">1435</span> * further reference to this block, we should release it carefully.<a name="line.1435"></a>
<span class="sourceLineNo">1436</span> */<a name="line.1436"></a>
<span class="sourceLineNo">1437</span> @Override<a name="line.1437"></a>
<span class="sourceLineNo">1438</span> protected void updateCurrentBlock(HFileBlock newBlock) throws CorruptHFileException {<a name="line.1438"></a>
<span class="sourceLineNo">1439</span> try {<a name="line.1439"></a>
<span class="sourceLineNo">1440</span> // sanity checks<a name="line.1440"></a>
<span class="sourceLineNo">1441</span> if (newBlock.getBlockType() != BlockType.ENCODED_DATA) {<a name="line.1441"></a>
<span class="sourceLineNo">1442</span> throw new IllegalStateException("EncodedScanner works only on encoded data blocks");<a name="line.1442"></a>
<span class="sourceLineNo">1443</span> }<a name="line.1443"></a>
<span class="sourceLineNo">1444</span> short dataBlockEncoderId = newBlock.getDataBlockEncodingId();<a name="line.1444"></a>
<span class="sourceLineNo">1445</span> if (!DataBlockEncoding.isCorrectEncoder(dataBlockEncoder, dataBlockEncoderId)) {<a name="line.1445"></a>
<span class="sourceLineNo">1446</span> String encoderCls = dataBlockEncoder.getClass().getName();<a name="line.1446"></a>
<span class="sourceLineNo">1447</span> throw new CorruptHFileException(<a name="line.1447"></a>
<span class="sourceLineNo">1448</span> "Encoder " + encoderCls + " doesn't support data block encoding "<a name="line.1448"></a>
<span class="sourceLineNo">1449</span> + DataBlockEncoding.getNameFromId(dataBlockEncoderId) + ",path=" + reader.getPath());<a name="line.1449"></a>
<span class="sourceLineNo">1450</span> }<a name="line.1450"></a>
<span class="sourceLineNo">1451</span> updateCurrBlockRef(newBlock);<a name="line.1451"></a>
<span class="sourceLineNo">1452</span> ByteBuff encodedBuffer = getEncodedBuffer(newBlock);<a name="line.1452"></a>
<span class="sourceLineNo">1453</span> seeker.setCurrentBuffer(encodedBuffer);<a name="line.1453"></a>
<span class="sourceLineNo">1454</span> } finally {<a name="line.1454"></a>
<span class="sourceLineNo">1455</span> releaseIfNotCurBlock(newBlock);<a name="line.1455"></a>
<span class="sourceLineNo">1456</span> }<a name="line.1456"></a>
<span class="sourceLineNo">1457</span> // Reset the next indexed key<a name="line.1457"></a>
<span class="sourceLineNo">1458</span> this.nextIndexedKey = null;<a name="line.1458"></a>
<span class="sourceLineNo">1459</span> }<a name="line.1459"></a>
<span class="sourceLineNo">1460</span><a name="line.1460"></a>
<span class="sourceLineNo">1461</span> private ByteBuff getEncodedBuffer(HFileBlock newBlock) {<a name="line.1461"></a>
<span class="sourceLineNo">1462</span> ByteBuff origBlock = newBlock.getBufferReadOnly();<a name="line.1462"></a>
<span class="sourceLineNo">1463</span> int pos = newBlock.headerSize() + DataBlockEncoding.ID_SIZE;<a name="line.1463"></a>
<span class="sourceLineNo">1464</span> origBlock.position(pos);<a name="line.1464"></a>
<span class="sourceLineNo">1465</span> origBlock<a name="line.1465"></a>
<span class="sourceLineNo">1466</span> .limit(pos + newBlock.getUncompressedSizeWithoutHeader() - DataBlockEncoding.ID_SIZE);<a name="line.1466"></a>
<span class="sourceLineNo">1467</span> return origBlock.slice();<a name="line.1467"></a>
<span class="sourceLineNo">1468</span> }<a name="line.1468"></a>
<span class="sourceLineNo">1469</span><a name="line.1469"></a>
<span class="sourceLineNo">1470</span> @Override<a name="line.1470"></a>
<span class="sourceLineNo">1471</span> protected boolean processFirstDataBlock() throws IOException {<a name="line.1471"></a>
<span class="sourceLineNo">1472</span> seeker.rewind();<a name="line.1472"></a>
<span class="sourceLineNo">1473</span> return true;<a name="line.1473"></a>
<span class="sourceLineNo">1474</span> }<a name="line.1474"></a>
<span class="sourceLineNo">1475</span><a name="line.1475"></a>
<span class="sourceLineNo">1476</span> @Override<a name="line.1476"></a>
<span class="sourceLineNo">1477</span> public boolean next() throws IOException {<a name="line.1477"></a>
<span class="sourceLineNo">1478</span> boolean isValid = seeker.next();<a name="line.1478"></a>
<span class="sourceLineNo">1479</span> if (!isValid) {<a name="line.1479"></a>
<span class="sourceLineNo">1480</span> HFileBlock newBlock = readNextDataBlock();<a name="line.1480"></a>
<span class="sourceLineNo">1481</span> isValid = newBlock != null;<a name="line.1481"></a>
<span class="sourceLineNo">1482</span> if (isValid) {<a name="line.1482"></a>
<span class="sourceLineNo">1483</span> updateCurrentBlock(newBlock);<a name="line.1483"></a>
<span class="sourceLineNo">1484</span> } else {<a name="line.1484"></a>
<span class="sourceLineNo">1485</span> setNonSeekedState();<a name="line.1485"></a>
<span class="sourceLineNo">1486</span> }<a name="line.1486"></a>
<span class="sourceLineNo">1487</span> }<a name="line.1487"></a>
<span class="sourceLineNo">1488</span> return isValid;<a name="line.1488"></a>
<span class="sourceLineNo">1489</span> }<a name="line.1489"></a>
<span class="sourceLineNo">1490</span><a name="line.1490"></a>
<span class="sourceLineNo">1491</span> @Override<a name="line.1491"></a>
<span class="sourceLineNo">1492</span> public Cell getKey() {<a name="line.1492"></a>
<span class="sourceLineNo">1493</span> assertValidSeek();<a name="line.1493"></a>
<span class="sourceLineNo">1494</span> return seeker.getKey();<a name="line.1494"></a>
<span class="sourceLineNo">1495</span> }<a name="line.1495"></a>
<span class="sourceLineNo">1496</span><a name="line.1496"></a>
<span class="sourceLineNo">1497</span> @Override<a name="line.1497"></a>
<span class="sourceLineNo">1498</span> public ByteBuffer getValue() {<a name="line.1498"></a>
<span class="sourceLineNo">1499</span> assertValidSeek();<a name="line.1499"></a>
<span class="sourceLineNo">1500</span> return seeker.getValueShallowCopy();<a name="line.1500"></a>
<span class="sourceLineNo">1501</span> }<a name="line.1501"></a>
<span class="sourceLineNo">1502</span><a name="line.1502"></a>
<span class="sourceLineNo">1503</span> @Override<a name="line.1503"></a>
<span class="sourceLineNo">1504</span> public Cell getCell() {<a name="line.1504"></a>
<span class="sourceLineNo">1505</span> if (this.curBlock == null) {<a name="line.1505"></a>
<span class="sourceLineNo">1506</span> return null;<a name="line.1506"></a>
<span class="sourceLineNo">1507</span> }<a name="line.1507"></a>
<span class="sourceLineNo">1508</span> return seeker.getCell();<a name="line.1508"></a>
<span class="sourceLineNo">1509</span> }<a name="line.1509"></a>
<span class="sourceLineNo">1510</span><a name="line.1510"></a>
<span class="sourceLineNo">1511</span> @Override<a name="line.1511"></a>
<span class="sourceLineNo">1512</span> public String getKeyString() {<a name="line.1512"></a>
<span class="sourceLineNo">1513</span> return CellUtil.toString(getKey(), false);<a name="line.1513"></a>
<span class="sourceLineNo">1514</span> }<a name="line.1514"></a>
<span class="sourceLineNo">1515</span><a name="line.1515"></a>
<span class="sourceLineNo">1516</span> @Override<a name="line.1516"></a>
<span class="sourceLineNo">1517</span> public String getValueString() {<a name="line.1517"></a>
<span class="sourceLineNo">1518</span> ByteBuffer valueBuffer = getValue();<a name="line.1518"></a>
<span class="sourceLineNo">1519</span> return ByteBufferUtils.toStringBinary(valueBuffer);<a name="line.1519"></a>
<span class="sourceLineNo">1520</span> }<a name="line.1520"></a>
<span class="sourceLineNo">1521</span><a name="line.1521"></a>
<span class="sourceLineNo">1522</span> private void assertValidSeek() {<a name="line.1522"></a>
<span class="sourceLineNo">1523</span> if (this.curBlock == null) {<a name="line.1523"></a>
<span class="sourceLineNo">1524</span> throw new NotSeekedException(reader.getPath());<a name="line.1524"></a>
<span class="sourceLineNo">1525</span> }<a name="line.1525"></a>
<span class="sourceLineNo">1526</span> }<a name="line.1526"></a>
<span class="sourceLineNo">1527</span><a name="line.1527"></a>
<span class="sourceLineNo">1528</span> @Override<a name="line.1528"></a>
<span class="sourceLineNo">1529</span> protected Cell getFirstKeyCellInBlock(HFileBlock curBlock) {<a name="line.1529"></a>
<span class="sourceLineNo">1530</span> return dataBlockEncoder.getFirstKeyCellInBlock(getEncodedBuffer(curBlock));<a name="line.1530"></a>
<span class="sourceLineNo">1531</span> }<a name="line.1531"></a>
<span class="sourceLineNo">1532</span><a name="line.1532"></a>
<span class="sourceLineNo">1533</span> @Override<a name="line.1533"></a>
<span class="sourceLineNo">1534</span> protected int loadBlockAndSeekToKey(HFileBlock seekToBlock, Cell nextIndexedKey, boolean rewind,<a name="line.1534"></a>
<span class="sourceLineNo">1535</span> Cell key, boolean seekBefore) throws IOException {<a name="line.1535"></a>
<span class="sourceLineNo">1536</span> if (this.curBlock == null || this.curBlock.getOffset() != seekToBlock.getOffset()) {<a name="line.1536"></a>
<span class="sourceLineNo">1537</span> updateCurrentBlock(seekToBlock);<a name="line.1537"></a>
<span class="sourceLineNo">1538</span> } else if (rewind) {<a name="line.1538"></a>
<span class="sourceLineNo">1539</span> seeker.rewind();<a name="line.1539"></a>
<span class="sourceLineNo">1540</span> }<a name="line.1540"></a>
<span class="sourceLineNo">1541</span> this.nextIndexedKey = nextIndexedKey;<a name="line.1541"></a>
<span class="sourceLineNo">1542</span> return seeker.seekToKeyInBlock(key, seekBefore);<a name="line.1542"></a>
<span class="sourceLineNo">1543</span> }<a name="line.1543"></a>
<span class="sourceLineNo">1544</span><a name="line.1544"></a>
<span class="sourceLineNo">1545</span> @Override<a name="line.1545"></a>
<span class="sourceLineNo">1546</span> public int compareKey(CellComparator comparator, Cell key) {<a name="line.1546"></a>
<span class="sourceLineNo">1547</span> return seeker.compareKey(comparator, key);<a name="line.1547"></a>
<span class="sourceLineNo">1548</span> }<a name="line.1548"></a>
<span class="sourceLineNo">1549</span> }<a name="line.1549"></a>
<span class="sourceLineNo">1550</span><a name="line.1550"></a>
<span class="sourceLineNo">1551</span> /**<a name="line.1551"></a>
<span class="sourceLineNo">1552</span> * Returns a buffer with the Bloom filter metadata. The caller takes ownership of the buffer.<a name="line.1552"></a>
<span class="sourceLineNo">1553</span> */<a name="line.1553"></a>
<span class="sourceLineNo">1554</span> @Override<a name="line.1554"></a>
<span class="sourceLineNo">1555</span> public DataInput getGeneralBloomFilterMetadata() throws IOException {<a name="line.1555"></a>
<span class="sourceLineNo">1556</span> return this.getBloomFilterMetadata(BlockType.GENERAL_BLOOM_META);<a name="line.1556"></a>
<span class="sourceLineNo">1557</span> }<a name="line.1557"></a>
<span class="sourceLineNo">1558</span><a name="line.1558"></a>
<span class="sourceLineNo">1559</span> @Override<a name="line.1559"></a>
<span class="sourceLineNo">1560</span> public DataInput getDeleteBloomFilterMetadata() throws IOException {<a name="line.1560"></a>
<span class="sourceLineNo">1561</span> return this.getBloomFilterMetadata(BlockType.DELETE_FAMILY_BLOOM_META);<a name="line.1561"></a>
<span class="sourceLineNo">1562</span> }<a name="line.1562"></a>
<span class="sourceLineNo">1563</span><a name="line.1563"></a>
<span class="sourceLineNo">1564</span> private DataInput getBloomFilterMetadata(BlockType blockType) throws IOException {<a name="line.1564"></a>
<span class="sourceLineNo">1565</span> if (<a name="line.1565"></a>
<span class="sourceLineNo">1566</span> blockType != BlockType.GENERAL_BLOOM_META &amp;&amp; blockType != BlockType.DELETE_FAMILY_BLOOM_META<a name="line.1566"></a>
<span class="sourceLineNo">1567</span> ) {<a name="line.1567"></a>
<span class="sourceLineNo">1568</span> throw new RuntimeException(<a name="line.1568"></a>
<span class="sourceLineNo">1569</span> "Block Type: " + blockType.toString() + " is not supported, path=" + path);<a name="line.1569"></a>
<span class="sourceLineNo">1570</span> }<a name="line.1570"></a>
<span class="sourceLineNo">1571</span><a name="line.1571"></a>
<span class="sourceLineNo">1572</span> for (HFileBlock b : fileInfo.getLoadOnOpenBlocks()) {<a name="line.1572"></a>
<span class="sourceLineNo">1573</span> if (b.getBlockType() == blockType) {<a name="line.1573"></a>
<span class="sourceLineNo">1574</span> return b.getByteStream();<a name="line.1574"></a>
<span class="sourceLineNo">1575</span> }<a name="line.1575"></a>
<span class="sourceLineNo">1576</span> }<a name="line.1576"></a>
<span class="sourceLineNo">1577</span> return null;<a name="line.1577"></a>
<span class="sourceLineNo">1578</span> }<a name="line.1578"></a>
<span class="sourceLineNo">1579</span><a name="line.1579"></a>
<span class="sourceLineNo">1580</span> public boolean isFileInfoLoaded() {<a name="line.1580"></a>
<span class="sourceLineNo">1581</span> return true; // We load file info in constructor in version 2.<a name="line.1581"></a>
<span class="sourceLineNo">1582</span> }<a name="line.1582"></a>
<span class="sourceLineNo">1583</span><a name="line.1583"></a>
<span class="sourceLineNo">1584</span> @Override<a name="line.1584"></a>
<span class="sourceLineNo">1585</span> public HFileContext getFileContext() {<a name="line.1585"></a>
<span class="sourceLineNo">1586</span> return hfileContext;<a name="line.1586"></a>
<span class="sourceLineNo">1587</span> }<a name="line.1587"></a>
<span class="sourceLineNo">1588</span><a name="line.1588"></a>
<span class="sourceLineNo">1589</span> /**<a name="line.1589"></a>
<span class="sourceLineNo">1590</span> * Returns false if block prefetching was requested for this file and has not completed, true<a name="line.1590"></a>
<span class="sourceLineNo">1591</span> * otherwise<a name="line.1591"></a>
<span class="sourceLineNo">1592</span> */<a name="line.1592"></a>
<span class="sourceLineNo">1593</span> @Override<a name="line.1593"></a>
<span class="sourceLineNo">1594</span> public boolean prefetchComplete() {<a name="line.1594"></a>
<span class="sourceLineNo">1595</span> return PrefetchExecutor.isCompleted(path);<a name="line.1595"></a>
<span class="sourceLineNo">1596</span> }<a name="line.1596"></a>
<span class="sourceLineNo">1597</span><a name="line.1597"></a>
<span class="sourceLineNo">1598</span> /**<a name="line.1598"></a>
<span class="sourceLineNo">1599</span> * Create a Scanner on this file. No seeks or reads are done on creation. Call<a name="line.1599"></a>
<span class="sourceLineNo">1600</span> * {@link HFileScanner#seekTo(Cell)} to position an start the read. There is nothing to clean up<a name="line.1600"></a>
<span class="sourceLineNo">1601</span> * in a Scanner. Letting go of your references to the scanner is sufficient. NOTE: Do not use this<a name="line.1601"></a>
<span class="sourceLineNo">1602</span> * overload of getScanner for compactions. See<a name="line.1602"></a>
<span class="sourceLineNo">1603</span> * {@link #getScanner(Configuration, boolean, boolean, boolean)}<a name="line.1603"></a>
<span class="sourceLineNo">1604</span> * @param conf Store configuration.<a name="line.1604"></a>
<span class="sourceLineNo">1605</span> * @param cacheBlocks True if we should cache blocks read in by this scanner.<a name="line.1605"></a>
<span class="sourceLineNo">1606</span> * @param pread Use positional read rather than seek+read if true (pread is better for<a name="line.1606"></a>
<span class="sourceLineNo">1607</span> * random reads, seek+read is better scanning).<a name="line.1607"></a>
<span class="sourceLineNo">1608</span> * @return Scanner on this file.<a name="line.1608"></a>
<span class="sourceLineNo">1609</span> */<a name="line.1609"></a>
<span class="sourceLineNo">1610</span> @Override<a name="line.1610"></a>
<span class="sourceLineNo">1611</span> public HFileScanner getScanner(Configuration conf, boolean cacheBlocks, final boolean pread) {<a name="line.1611"></a>
<span class="sourceLineNo">1612</span> return getScanner(conf, cacheBlocks, pread, false);<a name="line.1612"></a>
<span class="sourceLineNo">1613</span> }<a name="line.1613"></a>
<span class="sourceLineNo">1614</span><a name="line.1614"></a>
<span class="sourceLineNo">1615</span> /**<a name="line.1615"></a>
<span class="sourceLineNo">1616</span> * Create a Scanner on this file. No seeks or reads are done on creation. Call<a name="line.1616"></a>
<span class="sourceLineNo">1617</span> * {@link HFileScanner#seekTo(Cell)} to position an start the read. There is nothing to clean up<a name="line.1617"></a>
<span class="sourceLineNo">1618</span> * in a Scanner. Letting go of your references to the scanner is sufficient. n * Store<a name="line.1618"></a>
<span class="sourceLineNo">1619</span> * configuration. n * True if we should cache blocks read in by this scanner. n * Use positional<a name="line.1619"></a>
<span class="sourceLineNo">1620</span> * read rather than seek+read if true (pread is better for random reads, seek+read is better<a name="line.1620"></a>
<span class="sourceLineNo">1621</span> * scanning). n * is scanner being used for a compaction?<a name="line.1621"></a>
<span class="sourceLineNo">1622</span> * @return Scanner on this file.<a name="line.1622"></a>
<span class="sourceLineNo">1623</span> */<a name="line.1623"></a>
<span class="sourceLineNo">1624</span> @Override<a name="line.1624"></a>
<span class="sourceLineNo">1625</span> public HFileScanner getScanner(Configuration conf, boolean cacheBlocks, final boolean pread,<a name="line.1625"></a>
<span class="sourceLineNo">1626</span> final boolean isCompaction) {<a name="line.1626"></a>
<span class="sourceLineNo">1627</span> if (dataBlockEncoder.useEncodedScanner()) {<a name="line.1627"></a>
<span class="sourceLineNo">1628</span> return new EncodedScanner(this, cacheBlocks, pread, isCompaction, this.hfileContext, conf);<a name="line.1628"></a>
<span class="sourceLineNo">1629</span> }<a name="line.1629"></a>
<span class="sourceLineNo">1630</span> return new HFileScannerImpl(this, cacheBlocks, pread, isCompaction);<a name="line.1630"></a>
<span class="sourceLineNo">1631</span> }<a name="line.1631"></a>
<span class="sourceLineNo">1632</span><a name="line.1632"></a>
<span class="sourceLineNo">1633</span> public int getMajorVersion() {<a name="line.1633"></a>
<span class="sourceLineNo">1634</span> return 3;<a name="line.1634"></a>
<span class="sourceLineNo">1635</span> }<a name="line.1635"></a>
<span class="sourceLineNo">1636</span><a name="line.1636"></a>
<span class="sourceLineNo">1637</span> @Override<a name="line.1637"></a>
<span class="sourceLineNo">1638</span> public void unbufferStream() {<a name="line.1638"></a>
<span class="sourceLineNo">1639</span> fsBlockReader.unbufferStream();<a name="line.1639"></a>
<span class="sourceLineNo">1640</span> }<a name="line.1640"></a>
<span class="sourceLineNo">1641</span>}<a name="line.1641"></a>
</pre>
</div>
</body>
</html>