blob: 42dcc11c1ec636a3f66685c9d69628e85aeab21d [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.io.compress, class: ReusableStreamGzipCodec, class: ReusableGzipOutputStream, class: ResetableGZIPOutputStream">
<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.io.compress;</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.OutputStream;</span>
<span class="source-line-no">023</span><span id="line-23">import java.util.Arrays;</span>
<span class="source-line-no">024</span><span id="line-24">import java.util.zip.GZIPOutputStream;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.util.JVM;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.io.compress.CompressionOutputStream;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.io.compress.CompressorStream;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.io.compress.GzipCodec;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.io.compress.zlib.ZlibFactory;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">031</span><span id="line-31">import org.slf4j.Logger;</span>
<span class="source-line-no">032</span><span id="line-32">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">033</span><span id="line-33"></span>
<span class="source-line-no">034</span><span id="line-34">/**</span>
<span class="source-line-no">035</span><span id="line-35"> * Fixes an inefficiency in Hadoop's Gzip codec, allowing to reuse compression streams.</span>
<span class="source-line-no">036</span><span id="line-36"> */</span>
<span class="source-line-no">037</span><span id="line-37">@InterfaceAudience.Private</span>
<span class="source-line-no">038</span><span id="line-38">public class ReusableStreamGzipCodec extends GzipCodec {</span>
<span class="source-line-no">039</span><span id="line-39"></span>
<span class="source-line-no">040</span><span id="line-40"> private static final Logger LOG = LoggerFactory.getLogger(Compression.class);</span>
<span class="source-line-no">041</span><span id="line-41"></span>
<span class="source-line-no">042</span><span id="line-42"> /**</span>
<span class="source-line-no">043</span><span id="line-43"> * A bridge that wraps around a DeflaterOutputStream to make it a CompressionOutputStream.</span>
<span class="source-line-no">044</span><span id="line-44"> */</span>
<span class="source-line-no">045</span><span id="line-45"> protected static class ReusableGzipOutputStream extends CompressorStream {</span>
<span class="source-line-no">046</span><span id="line-46"></span>
<span class="source-line-no">047</span><span id="line-47"> private static final int GZIP_HEADER_LENGTH = 10;</span>
<span class="source-line-no">048</span><span id="line-48"></span>
<span class="source-line-no">049</span><span id="line-49"> /**</span>
<span class="source-line-no">050</span><span id="line-50"> * Fixed ten-byte gzip header. See {@link GZIPOutputStream}'s source for details.</span>
<span class="source-line-no">051</span><span id="line-51"> */</span>
<span class="source-line-no">052</span><span id="line-52"> private static final byte[] GZIP_HEADER;</span>
<span class="source-line-no">053</span><span id="line-53"></span>
<span class="source-line-no">054</span><span id="line-54"> static {</span>
<span class="source-line-no">055</span><span id="line-55"> // Capture the fixed ten-byte header hard-coded in GZIPOutputStream.</span>
<span class="source-line-no">056</span><span id="line-56"> ByteArrayOutputStream baos = new ByteArrayOutputStream();</span>
<span class="source-line-no">057</span><span id="line-57"> byte[] header = null;</span>
<span class="source-line-no">058</span><span id="line-58"> GZIPOutputStream gzipStream = null;</span>
<span class="source-line-no">059</span><span id="line-59"> try {</span>
<span class="source-line-no">060</span><span id="line-60"> gzipStream = new GZIPOutputStream(baos);</span>
<span class="source-line-no">061</span><span id="line-61"> gzipStream.finish();</span>
<span class="source-line-no">062</span><span id="line-62"> header = Arrays.copyOfRange(baos.toByteArray(), 0, GZIP_HEADER_LENGTH);</span>
<span class="source-line-no">063</span><span id="line-63"> } catch (IOException e) {</span>
<span class="source-line-no">064</span><span id="line-64"> throw new RuntimeException("Could not create gzip stream", e);</span>
<span class="source-line-no">065</span><span id="line-65"> } finally {</span>
<span class="source-line-no">066</span><span id="line-66"> if (gzipStream != null) {</span>
<span class="source-line-no">067</span><span id="line-67"> try {</span>
<span class="source-line-no">068</span><span id="line-68"> gzipStream.close();</span>
<span class="source-line-no">069</span><span id="line-69"> } catch (IOException e) {</span>
<span class="source-line-no">070</span><span id="line-70"> LOG.error(e.toString(), e);</span>
<span class="source-line-no">071</span><span id="line-71"> }</span>
<span class="source-line-no">072</span><span id="line-72"> }</span>
<span class="source-line-no">073</span><span id="line-73"> }</span>
<span class="source-line-no">074</span><span id="line-74"> GZIP_HEADER = header;</span>
<span class="source-line-no">075</span><span id="line-75"> }</span>
<span class="source-line-no">076</span><span id="line-76"></span>
<span class="source-line-no">077</span><span id="line-77"> private static class ResetableGZIPOutputStream extends GZIPOutputStream {</span>
<span class="source-line-no">078</span><span id="line-78"></span>
<span class="source-line-no">079</span><span id="line-79"> private static final int TRAILER_SIZE = 8;</span>
<span class="source-line-no">080</span><span id="line-80"> private static final boolean HAS_BROKEN_FINISH = JVM.isGZIPOutputStreamFinishBroken();</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 ResetableGZIPOutputStream(OutputStream out) throws IOException {</span>
<span class="source-line-no">083</span><span id="line-83"> super(out);</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"> public void resetState() throws IOException {</span>
<span class="source-line-no">087</span><span id="line-87"> def.reset();</span>
<span class="source-line-no">088</span><span id="line-88"> crc.reset();</span>
<span class="source-line-no">089</span><span id="line-89"> out.write(GZIP_HEADER);</span>
<span class="source-line-no">090</span><span id="line-90"> }</span>
<span class="source-line-no">091</span><span id="line-91"></span>
<span class="source-line-no">092</span><span id="line-92"> /**</span>
<span class="source-line-no">093</span><span id="line-93"> * Override because certain implementation calls def.end() which causes problem when resetting</span>
<span class="source-line-no">094</span><span id="line-94"> * the stream for reuse.</span>
<span class="source-line-no">095</span><span id="line-95"> */</span>
<span class="source-line-no">096</span><span id="line-96"> @Override</span>
<span class="source-line-no">097</span><span id="line-97"> public void finish() throws IOException {</span>
<span class="source-line-no">098</span><span id="line-98"> if (HAS_BROKEN_FINISH) {</span>
<span class="source-line-no">099</span><span id="line-99"> if (!def.finished()) {</span>
<span class="source-line-no">100</span><span id="line-100"> def.finish();</span>
<span class="source-line-no">101</span><span id="line-101"> while (!def.finished()) {</span>
<span class="source-line-no">102</span><span id="line-102"> int i = def.deflate(this.buf, 0, this.buf.length);</span>
<span class="source-line-no">103</span><span id="line-103"> if (def.finished() &amp;&amp; (i &lt;= this.buf.length - TRAILER_SIZE)) {</span>
<span class="source-line-no">104</span><span id="line-104"> writeTrailer(this.buf, i);</span>
<span class="source-line-no">105</span><span id="line-105"> i += TRAILER_SIZE;</span>
<span class="source-line-no">106</span><span id="line-106"> out.write(this.buf, 0, i);</span>
<span class="source-line-no">107</span><span id="line-107"></span>
<span class="source-line-no">108</span><span id="line-108"> return;</span>
<span class="source-line-no">109</span><span id="line-109"> }</span>
<span class="source-line-no">110</span><span id="line-110"> if (i &gt; 0) {</span>
<span class="source-line-no">111</span><span id="line-111"> out.write(this.buf, 0, i);</span>
<span class="source-line-no">112</span><span id="line-112"> }</span>
<span class="source-line-no">113</span><span id="line-113"> }</span>
<span class="source-line-no">114</span><span id="line-114"></span>
<span class="source-line-no">115</span><span id="line-115"> byte[] arrayOfByte = new byte[TRAILER_SIZE];</span>
<span class="source-line-no">116</span><span id="line-116"> writeTrailer(arrayOfByte, 0);</span>
<span class="source-line-no">117</span><span id="line-117"> out.write(arrayOfByte);</span>
<span class="source-line-no">118</span><span id="line-118"> }</span>
<span class="source-line-no">119</span><span id="line-119"> } else {</span>
<span class="source-line-no">120</span><span id="line-120"> super.finish();</span>
<span class="source-line-no">121</span><span id="line-121"> }</span>
<span class="source-line-no">122</span><span id="line-122"> }</span>
<span class="source-line-no">123</span><span id="line-123"></span>
<span class="source-line-no">124</span><span id="line-124"> /** re-implement because the relative method in jdk is invisible */</span>
<span class="source-line-no">125</span><span id="line-125"> private void writeTrailer(byte[] paramArrayOfByte, int paramInt) throws IOException {</span>
<span class="source-line-no">126</span><span id="line-126"> writeInt((int) this.crc.getValue(), paramArrayOfByte, paramInt);</span>
<span class="source-line-no">127</span><span id="line-127"> writeInt(this.def.getTotalIn(), paramArrayOfByte, paramInt + 4);</span>
<span class="source-line-no">128</span><span id="line-128"> }</span>
<span class="source-line-no">129</span><span id="line-129"></span>
<span class="source-line-no">130</span><span id="line-130"> /** re-implement because the relative method in jdk is invisible */</span>
<span class="source-line-no">131</span><span id="line-131"> private void writeInt(int paramInt1, byte[] paramArrayOfByte, int paramInt2)</span>
<span class="source-line-no">132</span><span id="line-132"> throws IOException {</span>
<span class="source-line-no">133</span><span id="line-133"> writeShort(paramInt1 &amp; 0xFFFF, paramArrayOfByte, paramInt2);</span>
<span class="source-line-no">134</span><span id="line-134"> writeShort(paramInt1 &gt;&gt; 16 &amp; 0xFFFF, paramArrayOfByte, paramInt2 + 2);</span>
<span class="source-line-no">135</span><span id="line-135"> }</span>
<span class="source-line-no">136</span><span id="line-136"></span>
<span class="source-line-no">137</span><span id="line-137"> /** re-implement because the relative method in jdk is invisible */</span>
<span class="source-line-no">138</span><span id="line-138"> private void writeShort(int paramInt1, byte[] paramArrayOfByte, int paramInt2)</span>
<span class="source-line-no">139</span><span id="line-139"> throws IOException {</span>
<span class="source-line-no">140</span><span id="line-140"> paramArrayOfByte[paramInt2] = (byte) (paramInt1 &amp; 0xFF);</span>
<span class="source-line-no">141</span><span id="line-141"> paramArrayOfByte[(paramInt2 + 1)] = (byte) (paramInt1 &gt;&gt; 8 &amp; 0xFF);</span>
<span class="source-line-no">142</span><span id="line-142"> }</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"> public ReusableGzipOutputStream(OutputStream out) throws IOException {</span>
<span class="source-line-no">146</span><span id="line-146"> super(new ResetableGZIPOutputStream(out));</span>
<span class="source-line-no">147</span><span id="line-147"> }</span>
<span class="source-line-no">148</span><span id="line-148"></span>
<span class="source-line-no">149</span><span id="line-149"> @Override</span>
<span class="source-line-no">150</span><span id="line-150"> public void close() throws IOException {</span>
<span class="source-line-no">151</span><span id="line-151"> out.close();</span>
<span class="source-line-no">152</span><span id="line-152"> }</span>
<span class="source-line-no">153</span><span id="line-153"></span>
<span class="source-line-no">154</span><span id="line-154"> @Override</span>
<span class="source-line-no">155</span><span id="line-155"> public void flush() throws IOException {</span>
<span class="source-line-no">156</span><span id="line-156"> out.flush();</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 void write(int b) throws IOException {</span>
<span class="source-line-no">161</span><span id="line-161"> out.write(b);</span>
<span class="source-line-no">162</span><span id="line-162"> }</span>
<span class="source-line-no">163</span><span id="line-163"></span>
<span class="source-line-no">164</span><span id="line-164"> @Override</span>
<span class="source-line-no">165</span><span id="line-165"> public void write(byte[] data, int offset, int length) throws IOException {</span>
<span class="source-line-no">166</span><span id="line-166"> out.write(data, offset, length);</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"> @Override</span>
<span class="source-line-no">170</span><span id="line-170"> public void finish() throws IOException {</span>
<span class="source-line-no">171</span><span id="line-171"> ((GZIPOutputStream) out).finish();</span>
<span class="source-line-no">172</span><span id="line-172"> }</span>
<span class="source-line-no">173</span><span id="line-173"></span>
<span class="source-line-no">174</span><span id="line-174"> @Override</span>
<span class="source-line-no">175</span><span id="line-175"> public void resetState() throws IOException {</span>
<span class="source-line-no">176</span><span id="line-176"> ((ResetableGZIPOutputStream) out).resetState();</span>
<span class="source-line-no">177</span><span id="line-177"> }</span>
<span class="source-line-no">178</span><span id="line-178"> }</span>
<span class="source-line-no">179</span><span id="line-179"></span>
<span class="source-line-no">180</span><span id="line-180"> @Override</span>
<span class="source-line-no">181</span><span id="line-181"> public CompressionOutputStream createOutputStream(OutputStream out) throws IOException {</span>
<span class="source-line-no">182</span><span id="line-182"> if (ZlibFactory.isNativeZlibLoaded(getConf())) {</span>
<span class="source-line-no">183</span><span id="line-183"> return super.createOutputStream(out);</span>
<span class="source-line-no">184</span><span id="line-184"> }</span>
<span class="source-line-no">185</span><span id="line-185"> return new ReusableGzipOutputStream(out);</span>
<span class="source-line-no">186</span><span id="line-186"> }</span>
<span class="source-line-no">187</span><span id="line-187"></span>
<span class="source-line-no">188</span><span id="line-188">}</span>
</pre>
</div>
</main>
</body>
</html>