blob: 1f775a7c3786bd750b6742bd026bca4c2dce5e0b [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Source code</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="source: package: org.apache.hadoop.hbase.regionserver.wal, class: WALCellCodec, class: EnsureKvEncoder">
<meta name="generator" content="javadoc/SourceToHTMLConverter">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body class="source-page">
<main role="main">
<div class="source-container">
<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span>
<span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span>
<span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span>
<span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span>
<span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span>
<span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span>
<span class="source-line-no">009</span><span id="line-9"> *</span>
<span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="source-line-no">011</span><span id="line-11"> *</span>
<span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span>
<span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span>
<span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span>
<span class="source-line-no">017</span><span id="line-17"> */</span>
<span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.regionserver.wal;</span>
<span class="source-line-no">019</span><span id="line-19"></span>
<span class="source-line-no">020</span><span id="line-20">import java.io.ByteArrayOutputStream;</span>
<span class="source-line-no">021</span><span id="line-21">import java.io.IOException;</span>
<span class="source-line-no">022</span><span id="line-22">import java.io.InputStream;</span>
<span class="source-line-no">023</span><span id="line-23">import java.io.OutputStream;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.Cell;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.ExtendedCell;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.HBaseInterfaceAudience;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.KeyValue;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.KeyValueUtil;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.PrivateCellUtil;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.codec.BaseDecoder;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.codec.BaseEncoder;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.codec.Codec;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.codec.KeyValueCodecWithTags;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.io.ByteBuffInputStream;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.io.ByteBufferWriter;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.io.ByteBufferWriterOutputStream;</span>
<span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.io.util.Dictionary;</span>
<span class="source-line-no">039</span><span id="line-39">import org.apache.hadoop.hbase.io.util.StreamUtils;</span>
<span class="source-line-no">040</span><span id="line-40">import org.apache.hadoop.hbase.nio.ByteBuff;</span>
<span class="source-line-no">041</span><span id="line-41">import org.apache.hadoop.hbase.util.ByteBufferUtils;</span>
<span class="source-line-no">042</span><span id="line-42">import org.apache.hadoop.hbase.util.Bytes;</span>
<span class="source-line-no">043</span><span id="line-43">import org.apache.hadoop.hbase.util.ReflectionUtils;</span>
<span class="source-line-no">044</span><span id="line-44">import org.apache.hadoop.io.IOUtils;</span>
<span class="source-line-no">045</span><span id="line-45">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">046</span><span id="line-46"></span>
<span class="source-line-no">047</span><span id="line-47">import org.apache.hbase.thirdparty.com.google.protobuf.ByteString;</span>
<span class="source-line-no">048</span><span id="line-48">import org.apache.hbase.thirdparty.com.google.protobuf.UnsafeByteOperations;</span>
<span class="source-line-no">049</span><span id="line-49"></span>
<span class="source-line-no">050</span><span id="line-50">/**</span>
<span class="source-line-no">051</span><span id="line-51"> * Compression in this class is lifted off Compressor/KeyValueCompression. This is a pure</span>
<span class="source-line-no">052</span><span id="line-52"> * coincidence... they are independent and don't have to be compatible. This codec is used at server</span>
<span class="source-line-no">053</span><span id="line-53"> * side for writing cells to WAL as well as for sending edits as part of the distributed splitting</span>
<span class="source-line-no">054</span><span id="line-54"> * process.</span>
<span class="source-line-no">055</span><span id="line-55"> */</span>
<span class="source-line-no">056</span><span id="line-56">@InterfaceAudience.LimitedPrivate({ HBaseInterfaceAudience.COPROC, HBaseInterfaceAudience.PHOENIX,</span>
<span class="source-line-no">057</span><span id="line-57"> HBaseInterfaceAudience.CONFIG })</span>
<span class="source-line-no">058</span><span id="line-58">public class WALCellCodec implements Codec {</span>
<span class="source-line-no">059</span><span id="line-59"> /** Configuration key for the class to use when encoding cells in the WAL */</span>
<span class="source-line-no">060</span><span id="line-60"> public static final String WAL_CELL_CODEC_CLASS_KEY = "hbase.regionserver.wal.codec";</span>
<span class="source-line-no">061</span><span id="line-61"></span>
<span class="source-line-no">062</span><span id="line-62"> protected final CompressionContext compression;</span>
<span class="source-line-no">063</span><span id="line-63"></span>
<span class="source-line-no">064</span><span id="line-64"> /**</span>
<span class="source-line-no">065</span><span id="line-65"> * &lt;b&gt;All subclasses must implement a no argument constructor&lt;/b&gt;</span>
<span class="source-line-no">066</span><span id="line-66"> */</span>
<span class="source-line-no">067</span><span id="line-67"> public WALCellCodec() {</span>
<span class="source-line-no">068</span><span id="line-68"> this.compression = null;</span>
<span class="source-line-no">069</span><span id="line-69"> }</span>
<span class="source-line-no">070</span><span id="line-70"></span>
<span class="source-line-no">071</span><span id="line-71"> /**</span>
<span class="source-line-no">072</span><span id="line-72"> * Default constructor - &lt;b&gt;all subclasses must implement a constructor with this signature &lt;/b&gt;</span>
<span class="source-line-no">073</span><span id="line-73"> * if they are to be dynamically loaded from the {@link Configuration}.</span>
<span class="source-line-no">074</span><span id="line-74"> * @param conf configuration to configure &lt;tt&gt;this&lt;/tt&gt;</span>
<span class="source-line-no">075</span><span id="line-75"> * @param compression compression the codec should support, can be &lt;tt&gt;null&lt;/tt&gt; to indicate no</span>
<span class="source-line-no">076</span><span id="line-76"> * compression</span>
<span class="source-line-no">077</span><span id="line-77"> */</span>
<span class="source-line-no">078</span><span id="line-78"> public WALCellCodec(Configuration conf, CompressionContext compression) {</span>
<span class="source-line-no">079</span><span id="line-79"> this.compression = compression;</span>
<span class="source-line-no">080</span><span id="line-80"> }</span>
<span class="source-line-no">081</span><span id="line-81"></span>
<span class="source-line-no">082</span><span id="line-82"> public static Class&lt;?&gt; getWALCellCodecClass(Configuration conf) {</span>
<span class="source-line-no">083</span><span id="line-83"> return conf.getClass(WAL_CELL_CODEC_CLASS_KEY, WALCellCodec.class);</span>
<span class="source-line-no">084</span><span id="line-84"> }</span>
<span class="source-line-no">085</span><span id="line-85"></span>
<span class="source-line-no">086</span><span id="line-86"> /**</span>
<span class="source-line-no">087</span><span id="line-87"> * Create and setup a {@link WALCellCodec} from the {@code cellCodecClsName} and</span>
<span class="source-line-no">088</span><span id="line-88"> * CompressionContext, if {@code cellCodecClsName} is specified. Otherwise Cell Codec classname is</span>
<span class="source-line-no">089</span><span id="line-89"> * read from {@link Configuration}. Fully prepares the codec for use.</span>
<span class="source-line-no">090</span><span id="line-90"> * @param conf {@link Configuration} to read for the user-specified codec. If none is</span>
<span class="source-line-no">091</span><span id="line-91"> * specified, uses a {@link WALCellCodec}.</span>
<span class="source-line-no">092</span><span id="line-92"> * @param cellCodecClsName name of codec</span>
<span class="source-line-no">093</span><span id="line-93"> * @param compression compression the codec should use</span>
<span class="source-line-no">094</span><span id="line-94"> * @return a {@link WALCellCodec} ready for use.</span>
<span class="source-line-no">095</span><span id="line-95"> * @throws UnsupportedOperationException if the codec cannot be instantiated</span>
<span class="source-line-no">096</span><span id="line-96"> */</span>
<span class="source-line-no">097</span><span id="line-97"></span>
<span class="source-line-no">098</span><span id="line-98"> public static WALCellCodec create(Configuration conf, String cellCodecClsName,</span>
<span class="source-line-no">099</span><span id="line-99"> CompressionContext compression) throws UnsupportedOperationException {</span>
<span class="source-line-no">100</span><span id="line-100"> if (cellCodecClsName == null) {</span>
<span class="source-line-no">101</span><span id="line-101"> cellCodecClsName = getWALCellCodecClass(conf).getName();</span>
<span class="source-line-no">102</span><span id="line-102"> }</span>
<span class="source-line-no">103</span><span id="line-103"> return ReflectionUtils.instantiateWithCustomCtor(cellCodecClsName,</span>
<span class="source-line-no">104</span><span id="line-104"> new Class[] { Configuration.class, CompressionContext.class },</span>
<span class="source-line-no">105</span><span id="line-105"> new Object[] { conf, compression });</span>
<span class="source-line-no">106</span><span id="line-106"> }</span>
<span class="source-line-no">107</span><span id="line-107"></span>
<span class="source-line-no">108</span><span id="line-108"> /**</span>
<span class="source-line-no">109</span><span id="line-109"> * Create and setup a {@link WALCellCodec} from the CompressionContext. Cell Codec classname is</span>
<span class="source-line-no">110</span><span id="line-110"> * read from {@link Configuration}. Fully prepares the codec for use.</span>
<span class="source-line-no">111</span><span id="line-111"> * @param conf {@link Configuration} to read for the user-specified codec. If none is</span>
<span class="source-line-no">112</span><span id="line-112"> * specified, uses a {@link WALCellCodec}.</span>
<span class="source-line-no">113</span><span id="line-113"> * @param compression compression the codec should use</span>
<span class="source-line-no">114</span><span id="line-114"> * @return a {@link WALCellCodec} ready for use.</span>
<span class="source-line-no">115</span><span id="line-115"> * @throws UnsupportedOperationException if the codec cannot be instantiated</span>
<span class="source-line-no">116</span><span id="line-116"> */</span>
<span class="source-line-no">117</span><span id="line-117"> public static WALCellCodec create(Configuration conf, CompressionContext compression)</span>
<span class="source-line-no">118</span><span id="line-118"> throws UnsupportedOperationException {</span>
<span class="source-line-no">119</span><span id="line-119"> String cellCodecClsName = getWALCellCodecClass(conf).getName();</span>
<span class="source-line-no">120</span><span id="line-120"> return ReflectionUtils.instantiateWithCustomCtor(cellCodecClsName,</span>
<span class="source-line-no">121</span><span id="line-121"> new Class[] { Configuration.class, CompressionContext.class },</span>
<span class="source-line-no">122</span><span id="line-122"> new Object[] { conf, compression });</span>
<span class="source-line-no">123</span><span id="line-123"> }</span>
<span class="source-line-no">124</span><span id="line-124"></span>
<span class="source-line-no">125</span><span id="line-125"> public interface ByteStringCompressor {</span>
<span class="source-line-no">126</span><span id="line-126"> ByteString compress(byte[] data, Enum dictIndex) throws IOException;</span>
<span class="source-line-no">127</span><span id="line-127"> }</span>
<span class="source-line-no">128</span><span id="line-128"></span>
<span class="source-line-no">129</span><span id="line-129"> public interface ByteStringUncompressor {</span>
<span class="source-line-no">130</span><span id="line-130"> byte[] uncompress(ByteString data, Enum dictIndex) throws IOException;</span>
<span class="source-line-no">131</span><span id="line-131"> }</span>
<span class="source-line-no">132</span><span id="line-132"></span>
<span class="source-line-no">133</span><span id="line-133"> static class StatelessUncompressor implements ByteStringUncompressor {</span>
<span class="source-line-no">134</span><span id="line-134"> CompressionContext compressionContext;</span>
<span class="source-line-no">135</span><span id="line-135"></span>
<span class="source-line-no">136</span><span id="line-136"> public StatelessUncompressor(CompressionContext compressionContext) {</span>
<span class="source-line-no">137</span><span id="line-137"> this.compressionContext = compressionContext;</span>
<span class="source-line-no">138</span><span id="line-138"> }</span>
<span class="source-line-no">139</span><span id="line-139"></span>
<span class="source-line-no">140</span><span id="line-140"> @Override</span>
<span class="source-line-no">141</span><span id="line-141"> public byte[] uncompress(ByteString data, Enum dictIndex) throws IOException {</span>
<span class="source-line-no">142</span><span id="line-142"> return WALCellCodec.uncompressByteString(data, compressionContext.getDictionary(dictIndex));</span>
<span class="source-line-no">143</span><span id="line-143"> }</span>
<span class="source-line-no">144</span><span id="line-144"> }</span>
<span class="source-line-no">145</span><span id="line-145"></span>
<span class="source-line-no">146</span><span id="line-146"> static class BaosAndCompressor extends ByteArrayOutputStream implements ByteStringCompressor {</span>
<span class="source-line-no">147</span><span id="line-147"> private CompressionContext compressionContext;</span>
<span class="source-line-no">148</span><span id="line-148"></span>
<span class="source-line-no">149</span><span id="line-149"> public BaosAndCompressor(CompressionContext compressionContext) {</span>
<span class="source-line-no">150</span><span id="line-150"> this.compressionContext = compressionContext;</span>
<span class="source-line-no">151</span><span id="line-151"> }</span>
<span class="source-line-no">152</span><span id="line-152"></span>
<span class="source-line-no">153</span><span id="line-153"> public ByteString toByteString() {</span>
<span class="source-line-no">154</span><span id="line-154"> // We need this copy to create the ByteString as the byte[] 'buf' is not immutable. We reuse</span>
<span class="source-line-no">155</span><span id="line-155"> // them.</span>
<span class="source-line-no">156</span><span id="line-156"> return ByteString.copyFrom(this.buf, 0, this.count);</span>
<span class="source-line-no">157</span><span id="line-157"> }</span>
<span class="source-line-no">158</span><span id="line-158"></span>
<span class="source-line-no">159</span><span id="line-159"> @Override</span>
<span class="source-line-no">160</span><span id="line-160"> public ByteString compress(byte[] data, Enum dictIndex) throws IOException {</span>
<span class="source-line-no">161</span><span id="line-161"> writeCompressed(data, dictIndex);</span>
<span class="source-line-no">162</span><span id="line-162"> // We need this copy to create the ByteString as the byte[] 'buf' is not immutable. We reuse</span>
<span class="source-line-no">163</span><span id="line-163"> // them.</span>
<span class="source-line-no">164</span><span id="line-164"> ByteString result = ByteString.copyFrom(this.buf, 0, this.count);</span>
<span class="source-line-no">165</span><span id="line-165"> reset(); // Only resets the count - we reuse the byte array.</span>
<span class="source-line-no">166</span><span id="line-166"> return result;</span>
<span class="source-line-no">167</span><span id="line-167"> }</span>
<span class="source-line-no">168</span><span id="line-168"></span>
<span class="source-line-no">169</span><span id="line-169"> private void writeCompressed(byte[] data, Enum dictIndex) throws IOException {</span>
<span class="source-line-no">170</span><span id="line-170"> Dictionary dict = compressionContext.getDictionary(dictIndex);</span>
<span class="source-line-no">171</span><span id="line-171"> assert dict != null;</span>
<span class="source-line-no">172</span><span id="line-172"> short dictIdx = dict.findEntry(data, 0, data.length);</span>
<span class="source-line-no">173</span><span id="line-173"> if (dictIdx == Dictionary.NOT_IN_DICTIONARY) {</span>
<span class="source-line-no">174</span><span id="line-174"> write(Dictionary.NOT_IN_DICTIONARY);</span>
<span class="source-line-no">175</span><span id="line-175"> StreamUtils.writeRawVInt32(this, data.length);</span>
<span class="source-line-no">176</span><span id="line-176"> write(data, 0, data.length);</span>
<span class="source-line-no">177</span><span id="line-177"> } else {</span>
<span class="source-line-no">178</span><span id="line-178"> StreamUtils.writeShort(this, dictIdx);</span>
<span class="source-line-no">179</span><span id="line-179"> }</span>
<span class="source-line-no">180</span><span id="line-180"> }</span>
<span class="source-line-no">181</span><span id="line-181"> }</span>
<span class="source-line-no">182</span><span id="line-182"></span>
<span class="source-line-no">183</span><span id="line-183"> static class NoneCompressor implements ByteStringCompressor {</span>
<span class="source-line-no">184</span><span id="line-184"></span>
<span class="source-line-no">185</span><span id="line-185"> @Override</span>
<span class="source-line-no">186</span><span id="line-186"> public ByteString compress(byte[] data, Enum dictIndex) {</span>
<span class="source-line-no">187</span><span id="line-187"> return UnsafeByteOperations.unsafeWrap(data);</span>
<span class="source-line-no">188</span><span id="line-188"> }</span>
<span class="source-line-no">189</span><span id="line-189"> }</span>
<span class="source-line-no">190</span><span id="line-190"></span>
<span class="source-line-no">191</span><span id="line-191"> static class NoneUncompressor implements ByteStringUncompressor {</span>
<span class="source-line-no">192</span><span id="line-192"></span>
<span class="source-line-no">193</span><span id="line-193"> @Override</span>
<span class="source-line-no">194</span><span id="line-194"> public byte[] uncompress(ByteString data, Enum dictIndex) {</span>
<span class="source-line-no">195</span><span id="line-195"> return data.toByteArray();</span>
<span class="source-line-no">196</span><span id="line-196"> }</span>
<span class="source-line-no">197</span><span id="line-197"> }</span>
<span class="source-line-no">198</span><span id="line-198"></span>
<span class="source-line-no">199</span><span id="line-199"> private static byte[] uncompressByteString(ByteString bs, Dictionary dict) throws IOException {</span>
<span class="source-line-no">200</span><span id="line-200"> InputStream in = bs.newInput();</span>
<span class="source-line-no">201</span><span id="line-201"> byte status = StreamUtils.readByte(in);</span>
<span class="source-line-no">202</span><span id="line-202"> if (status == Dictionary.NOT_IN_DICTIONARY) {</span>
<span class="source-line-no">203</span><span id="line-203"> byte[] arr = new byte[StreamUtils.readRawVarint32(in)];</span>
<span class="source-line-no">204</span><span id="line-204"> int bytesRead = in.read(arr);</span>
<span class="source-line-no">205</span><span id="line-205"> if (bytesRead != arr.length) {</span>
<span class="source-line-no">206</span><span id="line-206"> throw new IOException("Cannot read; wanted " + arr.length + ", but got " + bytesRead);</span>
<span class="source-line-no">207</span><span id="line-207"> }</span>
<span class="source-line-no">208</span><span id="line-208"> if (dict != null) {</span>
<span class="source-line-no">209</span><span id="line-209"> dict.addEntry(arr, 0, arr.length);</span>
<span class="source-line-no">210</span><span id="line-210"> }</span>
<span class="source-line-no">211</span><span id="line-211"> return arr;</span>
<span class="source-line-no">212</span><span id="line-212"> } else {</span>
<span class="source-line-no">213</span><span id="line-213"> // Status here is the higher-order byte of index of the dictionary entry.</span>
<span class="source-line-no">214</span><span id="line-214"> short dictIdx = StreamUtils.toShort(status, StreamUtils.readByte(in));</span>
<span class="source-line-no">215</span><span id="line-215"> byte[] entry = dict.getEntry(dictIdx);</span>
<span class="source-line-no">216</span><span id="line-216"> if (entry == null) {</span>
<span class="source-line-no">217</span><span id="line-217"> throw new IOException("Missing dictionary entry for index " + dictIdx);</span>
<span class="source-line-no">218</span><span id="line-218"> }</span>
<span class="source-line-no">219</span><span id="line-219"> return entry;</span>
<span class="source-line-no">220</span><span id="line-220"> }</span>
<span class="source-line-no">221</span><span id="line-221"> }</span>
<span class="source-line-no">222</span><span id="line-222"></span>
<span class="source-line-no">223</span><span id="line-223"> static class CompressedKvEncoder extends BaseEncoder {</span>
<span class="source-line-no">224</span><span id="line-224"> private final CompressionContext compression;</span>
<span class="source-line-no">225</span><span id="line-225"> private final boolean hasValueCompression;</span>
<span class="source-line-no">226</span><span id="line-226"> private final boolean hasTagCompression;</span>
<span class="source-line-no">227</span><span id="line-227"></span>
<span class="source-line-no">228</span><span id="line-228"> public CompressedKvEncoder(OutputStream out, CompressionContext compression) {</span>
<span class="source-line-no">229</span><span id="line-229"> super(out);</span>
<span class="source-line-no">230</span><span id="line-230"> this.compression = compression;</span>
<span class="source-line-no">231</span><span id="line-231"> this.hasValueCompression = compression.hasValueCompression();</span>
<span class="source-line-no">232</span><span id="line-232"> this.hasTagCompression = compression.hasTagCompression();</span>
<span class="source-line-no">233</span><span id="line-233"> }</span>
<span class="source-line-no">234</span><span id="line-234"></span>
<span class="source-line-no">235</span><span id="line-235"> @Override</span>
<span class="source-line-no">236</span><span id="line-236"> public void write(ExtendedCell cell) throws IOException {</span>
<span class="source-line-no">237</span><span id="line-237"> // We first write the KeyValue infrastructure as VInts.</span>
<span class="source-line-no">238</span><span id="line-238"> StreamUtils.writeRawVInt32(out, KeyValueUtil.keyLength(cell));</span>
<span class="source-line-no">239</span><span id="line-239"> StreamUtils.writeRawVInt32(out, cell.getValueLength());</span>
<span class="source-line-no">240</span><span id="line-240"> // To support tags</span>
<span class="source-line-no">241</span><span id="line-241"> int tagsLength = cell.getTagsLength();</span>
<span class="source-line-no">242</span><span id="line-242"> StreamUtils.writeRawVInt32(out, tagsLength);</span>
<span class="source-line-no">243</span><span id="line-243"> PrivateCellUtil.compressRow(out, cell,</span>
<span class="source-line-no">244</span><span id="line-244"> compression.getDictionary(CompressionContext.DictionaryIndex.ROW));</span>
<span class="source-line-no">245</span><span id="line-245"> PrivateCellUtil.compressFamily(out, cell,</span>
<span class="source-line-no">246</span><span id="line-246"> compression.getDictionary(CompressionContext.DictionaryIndex.FAMILY));</span>
<span class="source-line-no">247</span><span id="line-247"> PrivateCellUtil.compressQualifier(out, cell,</span>
<span class="source-line-no">248</span><span id="line-248"> compression.getDictionary(CompressionContext.DictionaryIndex.QUALIFIER));</span>
<span class="source-line-no">249</span><span id="line-249"> // Write timestamp, type and value.</span>
<span class="source-line-no">250</span><span id="line-250"> StreamUtils.writeLong(out, cell.getTimestamp());</span>
<span class="source-line-no">251</span><span id="line-251"> out.write(cell.getTypeByte());</span>
<span class="source-line-no">252</span><span id="line-252"> if (hasValueCompression) {</span>
<span class="source-line-no">253</span><span id="line-253"> writeCompressedValue(out, cell);</span>
<span class="source-line-no">254</span><span id="line-254"> } else {</span>
<span class="source-line-no">255</span><span id="line-255"> PrivateCellUtil.writeValue(out, cell, cell.getValueLength());</span>
<span class="source-line-no">256</span><span id="line-256"> }</span>
<span class="source-line-no">257</span><span id="line-257"> if (tagsLength &gt; 0) {</span>
<span class="source-line-no">258</span><span id="line-258"> if (hasTagCompression) {</span>
<span class="source-line-no">259</span><span id="line-259"> // Write tags using Dictionary compression</span>
<span class="source-line-no">260</span><span id="line-260"> PrivateCellUtil.compressTags(out, cell, compression.tagCompressionContext);</span>
<span class="source-line-no">261</span><span id="line-261"> } else {</span>
<span class="source-line-no">262</span><span id="line-262"> // Tag compression is disabled within the WAL compression. Just write the tags bytes as</span>
<span class="source-line-no">263</span><span id="line-263"> // it is.</span>
<span class="source-line-no">264</span><span id="line-264"> PrivateCellUtil.writeTags(out, cell, tagsLength);</span>
<span class="source-line-no">265</span><span id="line-265"> }</span>
<span class="source-line-no">266</span><span id="line-266"> }</span>
<span class="source-line-no">267</span><span id="line-267"> }</span>
<span class="source-line-no">268</span><span id="line-268"></span>
<span class="source-line-no">269</span><span id="line-269"> private void writeCompressedValue(OutputStream out, Cell cell) throws IOException {</span>
<span class="source-line-no">270</span><span id="line-270"> byte[] compressed = compression.getValueCompressor().compress(cell.getValueArray(),</span>
<span class="source-line-no">271</span><span id="line-271"> cell.getValueOffset(), cell.getValueLength());</span>
<span class="source-line-no">272</span><span id="line-272"> StreamUtils.writeRawVInt32(out, compressed.length);</span>
<span class="source-line-no">273</span><span id="line-273"> out.write(compressed);</span>
<span class="source-line-no">274</span><span id="line-274"> }</span>
<span class="source-line-no">275</span><span id="line-275"></span>
<span class="source-line-no">276</span><span id="line-276"> }</span>
<span class="source-line-no">277</span><span id="line-277"></span>
<span class="source-line-no">278</span><span id="line-278"> static class CompressedKvDecoder extends BaseDecoder {</span>
<span class="source-line-no">279</span><span id="line-279"> private final CompressionContext compression;</span>
<span class="source-line-no">280</span><span id="line-280"> private final boolean hasValueCompression;</span>
<span class="source-line-no">281</span><span id="line-281"> private final boolean hasTagCompression;</span>
<span class="source-line-no">282</span><span id="line-282"></span>
<span class="source-line-no">283</span><span id="line-283"> public CompressedKvDecoder(InputStream in, CompressionContext compression) {</span>
<span class="source-line-no">284</span><span id="line-284"> super(in);</span>
<span class="source-line-no">285</span><span id="line-285"> this.compression = compression;</span>
<span class="source-line-no">286</span><span id="line-286"> this.hasValueCompression = compression.hasValueCompression();</span>
<span class="source-line-no">287</span><span id="line-287"> this.hasTagCompression = compression.hasTagCompression();</span>
<span class="source-line-no">288</span><span id="line-288"> }</span>
<span class="source-line-no">289</span><span id="line-289"></span>
<span class="source-line-no">290</span><span id="line-290"> @Override</span>
<span class="source-line-no">291</span><span id="line-291"> protected ExtendedCell parseCell() throws IOException {</span>
<span class="source-line-no">292</span><span id="line-292"> int keylength = StreamUtils.readRawVarint32(in);</span>
<span class="source-line-no">293</span><span id="line-293"> int vlength = StreamUtils.readRawVarint32(in);</span>
<span class="source-line-no">294</span><span id="line-294"> int tagsLength = StreamUtils.readRawVarint32(in);</span>
<span class="source-line-no">295</span><span id="line-295"> int length = 0;</span>
<span class="source-line-no">296</span><span id="line-296"> if (tagsLength == 0) {</span>
<span class="source-line-no">297</span><span id="line-297"> length = KeyValue.KEYVALUE_INFRASTRUCTURE_SIZE + keylength + vlength;</span>
<span class="source-line-no">298</span><span id="line-298"> } else {</span>
<span class="source-line-no">299</span><span id="line-299"> length = KeyValue.KEYVALUE_WITH_TAGS_INFRASTRUCTURE_SIZE + keylength + vlength + tagsLength;</span>
<span class="source-line-no">300</span><span id="line-300"> }</span>
<span class="source-line-no">301</span><span id="line-301"></span>
<span class="source-line-no">302</span><span id="line-302"> byte[] backingArray = new byte[length];</span>
<span class="source-line-no">303</span><span id="line-303"> int pos = 0;</span>
<span class="source-line-no">304</span><span id="line-304"> pos = Bytes.putInt(backingArray, pos, keylength);</span>
<span class="source-line-no">305</span><span id="line-305"> pos = Bytes.putInt(backingArray, pos, vlength);</span>
<span class="source-line-no">306</span><span id="line-306"></span>
<span class="source-line-no">307</span><span id="line-307"> // the row</span>
<span class="source-line-no">308</span><span id="line-308"> int elemLen = readIntoArray(backingArray, pos + Bytes.SIZEOF_SHORT,</span>
<span class="source-line-no">309</span><span id="line-309"> compression.getDictionary(CompressionContext.DictionaryIndex.ROW));</span>
<span class="source-line-no">310</span><span id="line-310"> checkLength(elemLen, Short.MAX_VALUE);</span>
<span class="source-line-no">311</span><span id="line-311"> pos = Bytes.putShort(backingArray, pos, (short) elemLen);</span>
<span class="source-line-no">312</span><span id="line-312"> pos += elemLen;</span>
<span class="source-line-no">313</span><span id="line-313"></span>
<span class="source-line-no">314</span><span id="line-314"> // family</span>
<span class="source-line-no">315</span><span id="line-315"> elemLen = readIntoArray(backingArray, pos + Bytes.SIZEOF_BYTE,</span>
<span class="source-line-no">316</span><span id="line-316"> compression.getDictionary(CompressionContext.DictionaryIndex.FAMILY));</span>
<span class="source-line-no">317</span><span id="line-317"> checkLength(elemLen, Byte.MAX_VALUE);</span>
<span class="source-line-no">318</span><span id="line-318"> pos = Bytes.putByte(backingArray, pos, (byte) elemLen);</span>
<span class="source-line-no">319</span><span id="line-319"> pos += elemLen;</span>
<span class="source-line-no">320</span><span id="line-320"></span>
<span class="source-line-no">321</span><span id="line-321"> // qualifier</span>
<span class="source-line-no">322</span><span id="line-322"> elemLen = readIntoArray(backingArray, pos,</span>
<span class="source-line-no">323</span><span id="line-323"> compression.getDictionary(CompressionContext.DictionaryIndex.QUALIFIER));</span>
<span class="source-line-no">324</span><span id="line-324"> pos += elemLen;</span>
<span class="source-line-no">325</span><span id="line-325"></span>
<span class="source-line-no">326</span><span id="line-326"> // timestamp</span>
<span class="source-line-no">327</span><span id="line-327"> long ts = StreamUtils.readLong(in);</span>
<span class="source-line-no">328</span><span id="line-328"> pos = Bytes.putLong(backingArray, pos, ts);</span>
<span class="source-line-no">329</span><span id="line-329"> // type and value</span>
<span class="source-line-no">330</span><span id="line-330"> int typeValLen = length - pos;</span>
<span class="source-line-no">331</span><span id="line-331"> if (tagsLength &gt; 0) {</span>
<span class="source-line-no">332</span><span id="line-332"> typeValLen = typeValLen - tagsLength - KeyValue.TAGS_LENGTH_SIZE;</span>
<span class="source-line-no">333</span><span id="line-333"> }</span>
<span class="source-line-no">334</span><span id="line-334"> pos = Bytes.putByte(backingArray, pos, (byte) in.read());</span>
<span class="source-line-no">335</span><span id="line-335"> int valLen = typeValLen - 1;</span>
<span class="source-line-no">336</span><span id="line-336"> if (hasValueCompression) {</span>
<span class="source-line-no">337</span><span id="line-337"> readCompressedValue(in, backingArray, pos, valLen);</span>
<span class="source-line-no">338</span><span id="line-338"> pos += valLen;</span>
<span class="source-line-no">339</span><span id="line-339"> } else {</span>
<span class="source-line-no">340</span><span id="line-340"> IOUtils.readFully(in, backingArray, pos, valLen);</span>
<span class="source-line-no">341</span><span id="line-341"> pos += valLen;</span>
<span class="source-line-no">342</span><span id="line-342"> }</span>
<span class="source-line-no">343</span><span id="line-343"> // tags</span>
<span class="source-line-no">344</span><span id="line-344"> if (tagsLength &gt; 0) {</span>
<span class="source-line-no">345</span><span id="line-345"> pos = Bytes.putAsShort(backingArray, pos, tagsLength);</span>
<span class="source-line-no">346</span><span id="line-346"> if (hasTagCompression) {</span>
<span class="source-line-no">347</span><span id="line-347"> compression.tagCompressionContext.uncompressTags(in, backingArray, pos, tagsLength);</span>
<span class="source-line-no">348</span><span id="line-348"> } else {</span>
<span class="source-line-no">349</span><span id="line-349"> IOUtils.readFully(in, backingArray, pos, tagsLength);</span>
<span class="source-line-no">350</span><span id="line-350"> }</span>
<span class="source-line-no">351</span><span id="line-351"> }</span>
<span class="source-line-no">352</span><span id="line-352"> return new KeyValue(backingArray, 0, length);</span>
<span class="source-line-no">353</span><span id="line-353"> }</span>
<span class="source-line-no">354</span><span id="line-354"></span>
<span class="source-line-no">355</span><span id="line-355"> private int readIntoArray(byte[] to, int offset, Dictionary dict) throws IOException {</span>
<span class="source-line-no">356</span><span id="line-356"> byte status = StreamUtils.readByte(in);</span>
<span class="source-line-no">357</span><span id="line-357"> if (status == Dictionary.NOT_IN_DICTIONARY) {</span>
<span class="source-line-no">358</span><span id="line-358"> // status byte indicating that data to be read is not in dictionary.</span>
<span class="source-line-no">359</span><span id="line-359"> // if this isn't in the dictionary, we need to add to the dictionary.</span>
<span class="source-line-no">360</span><span id="line-360"> int length = StreamUtils.readRawVarint32(in);</span>
<span class="source-line-no">361</span><span id="line-361"> IOUtils.readFully(in, to, offset, length);</span>
<span class="source-line-no">362</span><span id="line-362"> dict.addEntry(to, offset, length);</span>
<span class="source-line-no">363</span><span id="line-363"> return length;</span>
<span class="source-line-no">364</span><span id="line-364"> } else {</span>
<span class="source-line-no">365</span><span id="line-365"> // the status byte also acts as the higher order byte of the dictionary entry.</span>
<span class="source-line-no">366</span><span id="line-366"> short dictIdx = StreamUtils.toShort(status, StreamUtils.readByte(in));</span>
<span class="source-line-no">367</span><span id="line-367"> byte[] entry = dict.getEntry(dictIdx);</span>
<span class="source-line-no">368</span><span id="line-368"> if (entry == null) {</span>
<span class="source-line-no">369</span><span id="line-369"> throw new IOException("Missing dictionary entry for index " + dictIdx);</span>
<span class="source-line-no">370</span><span id="line-370"> }</span>
<span class="source-line-no">371</span><span id="line-371"> // now we write the uncompressed value.</span>
<span class="source-line-no">372</span><span id="line-372"> Bytes.putBytes(to, offset, entry, 0, entry.length);</span>
<span class="source-line-no">373</span><span id="line-373"> return entry.length;</span>
<span class="source-line-no">374</span><span id="line-374"> }</span>
<span class="source-line-no">375</span><span id="line-375"> }</span>
<span class="source-line-no">376</span><span id="line-376"></span>
<span class="source-line-no">377</span><span id="line-377"> private static void checkLength(int len, int max) throws IOException {</span>
<span class="source-line-no">378</span><span id="line-378"> if (len &lt; 0 || len &gt; max) {</span>
<span class="source-line-no">379</span><span id="line-379"> throw new IOException("Invalid length for compresesed portion of keyvalue: " + len);</span>
<span class="source-line-no">380</span><span id="line-380"> }</span>
<span class="source-line-no">381</span><span id="line-381"> }</span>
<span class="source-line-no">382</span><span id="line-382"></span>
<span class="source-line-no">383</span><span id="line-383"> private void readCompressedValue(InputStream in, byte[] outArray, int outOffset,</span>
<span class="source-line-no">384</span><span id="line-384"> int expectedLength) throws IOException {</span>
<span class="source-line-no">385</span><span id="line-385"> int compressedLen = StreamUtils.readRawVarint32(in);</span>
<span class="source-line-no">386</span><span id="line-386"> compression.getValueCompressor().decompress(in, compressedLen, outArray, outOffset,</span>
<span class="source-line-no">387</span><span id="line-387"> expectedLength);</span>
<span class="source-line-no">388</span><span id="line-388"> }</span>
<span class="source-line-no">389</span><span id="line-389"> }</span>
<span class="source-line-no">390</span><span id="line-390"></span>
<span class="source-line-no">391</span><span id="line-391"> public static class EnsureKvEncoder extends BaseEncoder {</span>
<span class="source-line-no">392</span><span id="line-392"> public EnsureKvEncoder(OutputStream out) {</span>
<span class="source-line-no">393</span><span id="line-393"> super(out);</span>
<span class="source-line-no">394</span><span id="line-394"> }</span>
<span class="source-line-no">395</span><span id="line-395"></span>
<span class="source-line-no">396</span><span id="line-396"> @Override</span>
<span class="source-line-no">397</span><span id="line-397"> public void write(ExtendedCell cell) throws IOException {</span>
<span class="source-line-no">398</span><span id="line-398"> checkFlushed();</span>
<span class="source-line-no">399</span><span id="line-399"> // Make sure to write tags into WAL</span>
<span class="source-line-no">400</span><span id="line-400"> ByteBufferUtils.putInt(this.out, KeyValueUtil.getSerializedSize(cell, true));</span>
<span class="source-line-no">401</span><span id="line-401"> KeyValueUtil.oswrite(cell, this.out, true);</span>
<span class="source-line-no">402</span><span id="line-402"> }</span>
<span class="source-line-no">403</span><span id="line-403"> }</span>
<span class="source-line-no">404</span><span id="line-404"></span>
<span class="source-line-no">405</span><span id="line-405"> @Override</span>
<span class="source-line-no">406</span><span id="line-406"> public Decoder getDecoder(InputStream is) {</span>
<span class="source-line-no">407</span><span id="line-407"> return (compression == null)</span>
<span class="source-line-no">408</span><span id="line-408"> ? new KeyValueCodecWithTags.KeyValueDecoder(is)</span>
<span class="source-line-no">409</span><span id="line-409"> : new CompressedKvDecoder(is, compression);</span>
<span class="source-line-no">410</span><span id="line-410"> }</span>
<span class="source-line-no">411</span><span id="line-411"></span>
<span class="source-line-no">412</span><span id="line-412"> @Override</span>
<span class="source-line-no">413</span><span id="line-413"> public Decoder getDecoder(ByteBuff buf) {</span>
<span class="source-line-no">414</span><span id="line-414"> return getDecoder(new ByteBuffInputStream(buf));</span>
<span class="source-line-no">415</span><span id="line-415"> }</span>
<span class="source-line-no">416</span><span id="line-416"></span>
<span class="source-line-no">417</span><span id="line-417"> @Override</span>
<span class="source-line-no">418</span><span id="line-418"> public Encoder getEncoder(OutputStream os) {</span>
<span class="source-line-no">419</span><span id="line-419"> os = (os instanceof ByteBufferWriter) ? os : new ByteBufferWriterOutputStream(os);</span>
<span class="source-line-no">420</span><span id="line-420"> if (compression == null) {</span>
<span class="source-line-no">421</span><span id="line-421"> return new EnsureKvEncoder(os);</span>
<span class="source-line-no">422</span><span id="line-422"> }</span>
<span class="source-line-no">423</span><span id="line-423"> return new CompressedKvEncoder(os, compression);</span>
<span class="source-line-no">424</span><span id="line-424"> }</span>
<span class="source-line-no">425</span><span id="line-425"></span>
<span class="source-line-no">426</span><span id="line-426"> public ByteStringCompressor getByteStringCompressor() {</span>
<span class="source-line-no">427</span><span id="line-427"> return new BaosAndCompressor(compression);</span>
<span class="source-line-no">428</span><span id="line-428"> }</span>
<span class="source-line-no">429</span><span id="line-429"></span>
<span class="source-line-no">430</span><span id="line-430"> public ByteStringUncompressor getByteStringUncompressor() {</span>
<span class="source-line-no">431</span><span id="line-431"> return new StatelessUncompressor(compression);</span>
<span class="source-line-no">432</span><span id="line-432"> }</span>
<span class="source-line-no">433</span><span id="line-433"></span>
<span class="source-line-no">434</span><span id="line-434"> public static ByteStringCompressor getNoneCompressor() {</span>
<span class="source-line-no">435</span><span id="line-435"> return new NoneCompressor();</span>
<span class="source-line-no">436</span><span id="line-436"> }</span>
<span class="source-line-no">437</span><span id="line-437"></span>
<span class="source-line-no">438</span><span id="line-438"> public static ByteStringUncompressor getNoneUncompressor() {</span>
<span class="source-line-no">439</span><span id="line-439"> return new NoneUncompressor();</span>
<span class="source-line-no">440</span><span id="line-440"> }</span>
<span class="source-line-no">441</span><span id="line-441">}</span>
</pre>
</div>
</main>
</body>
</html>