| <!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.encoding, class: HFileBlockDefaultDecodingContext"> |
| <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.encoding;</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.DataInputStream;</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 org.apache.commons.io.IOUtils;</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.io.ByteBuffInputStream;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.io.TagCompressionContext;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.io.compress.CanReinit;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.io.compress.Compression;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.io.crypto.Cipher;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.io.crypto.Decryptor;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.io.crypto.Encryption;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.io.hfile.HFileContext;</span> |
| <span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.io.util.BlockIOUtils;</span> |
| <span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.nio.ByteBuff;</span> |
| <span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.util.Bytes;</span> |
| <span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.io.compress.Decompressor;</span> |
| <span class="source-line-no">037</span><span id="line-37">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">038</span><span id="line-38"></span> |
| <span class="source-line-no">039</span><span id="line-39">/**</span> |
| <span class="source-line-no">040</span><span id="line-40"> * A default implementation of {@link HFileBlockDecodingContext}. It assumes the block data section</span> |
| <span class="source-line-no">041</span><span id="line-41"> * is compressed as a whole.</span> |
| <span class="source-line-no">042</span><span id="line-42"> * @see HFileBlockDefaultEncodingContext for the default compression context</span> |
| <span class="source-line-no">043</span><span id="line-43"> */</span> |
| <span class="source-line-no">044</span><span id="line-44">@InterfaceAudience.Private</span> |
| <span class="source-line-no">045</span><span id="line-45">public class HFileBlockDefaultDecodingContext implements HFileBlockDecodingContext {</span> |
| <span class="source-line-no">046</span><span id="line-46"> private final Configuration conf;</span> |
| <span class="source-line-no">047</span><span id="line-47"> private final HFileContext fileContext;</span> |
| <span class="source-line-no">048</span><span id="line-48"> private TagCompressionContext tagCompressionContext;</span> |
| <span class="source-line-no">049</span><span id="line-49"></span> |
| <span class="source-line-no">050</span><span id="line-50"> public HFileBlockDefaultDecodingContext(Configuration conf, HFileContext fileContext) {</span> |
| <span class="source-line-no">051</span><span id="line-51"> this.conf = conf;</span> |
| <span class="source-line-no">052</span><span id="line-52"> this.fileContext = fileContext;</span> |
| <span class="source-line-no">053</span><span id="line-53"> }</span> |
| <span class="source-line-no">054</span><span id="line-54"></span> |
| <span class="source-line-no">055</span><span id="line-55"> @Override</span> |
| <span class="source-line-no">056</span><span id="line-56"> public void prepareDecoding(int onDiskSizeWithoutHeader, int uncompressedSizeWithoutHeader,</span> |
| <span class="source-line-no">057</span><span id="line-57"> ByteBuff blockBufferWithoutHeader, ByteBuff onDiskBlock) throws IOException {</span> |
| <span class="source-line-no">058</span><span id="line-58"> final ByteBuffInputStream byteBuffInputStream = new ByteBuffInputStream(onDiskBlock);</span> |
| <span class="source-line-no">059</span><span id="line-59"> InputStream dataInputStream = new DataInputStream(byteBuffInputStream);</span> |
| <span class="source-line-no">060</span><span id="line-60"></span> |
| <span class="source-line-no">061</span><span id="line-61"> try {</span> |
| <span class="source-line-no">062</span><span id="line-62"> Encryption.Context cryptoContext = fileContext.getEncryptionContext();</span> |
| <span class="source-line-no">063</span><span id="line-63"> if (cryptoContext != Encryption.Context.NONE) {</span> |
| <span class="source-line-no">064</span><span id="line-64"></span> |
| <span class="source-line-no">065</span><span id="line-65"> Cipher cipher = cryptoContext.getCipher();</span> |
| <span class="source-line-no">066</span><span id="line-66"> Decryptor decryptor = cipher.getDecryptor();</span> |
| <span class="source-line-no">067</span><span id="line-67"> decryptor.setKey(cryptoContext.getKey());</span> |
| <span class="source-line-no">068</span><span id="line-68"></span> |
| <span class="source-line-no">069</span><span id="line-69"> // Encrypted block format:</span> |
| <span class="source-line-no">070</span><span id="line-70"> // +--------------------------+</span> |
| <span class="source-line-no">071</span><span id="line-71"> // | byte iv length |</span> |
| <span class="source-line-no">072</span><span id="line-72"> // +--------------------------+</span> |
| <span class="source-line-no">073</span><span id="line-73"> // | iv data ... |</span> |
| <span class="source-line-no">074</span><span id="line-74"> // +--------------------------+</span> |
| <span class="source-line-no">075</span><span id="line-75"> // | encrypted block data ... |</span> |
| <span class="source-line-no">076</span><span id="line-76"> // +--------------------------+</span> |
| <span class="source-line-no">077</span><span id="line-77"></span> |
| <span class="source-line-no">078</span><span id="line-78"> int ivLength = dataInputStream.read();</span> |
| <span class="source-line-no">079</span><span id="line-79"> if (ivLength > 0) {</span> |
| <span class="source-line-no">080</span><span id="line-80"> byte[] iv = new byte[ivLength];</span> |
| <span class="source-line-no">081</span><span id="line-81"> IOUtils.readFully(dataInputStream, iv);</span> |
| <span class="source-line-no">082</span><span id="line-82"> decryptor.setIv(iv);</span> |
| <span class="source-line-no">083</span><span id="line-83"> // All encrypted blocks will have a nonzero IV length. If we see an IV</span> |
| <span class="source-line-no">084</span><span id="line-84"> // length of zero, this means the encoding context had 0 bytes of</span> |
| <span class="source-line-no">085</span><span id="line-85"> // plaintext to encode.</span> |
| <span class="source-line-no">086</span><span id="line-86"> decryptor.reset();</span> |
| <span class="source-line-no">087</span><span id="line-87"> dataInputStream = decryptor.createDecryptionStream(dataInputStream);</span> |
| <span class="source-line-no">088</span><span id="line-88"> }</span> |
| <span class="source-line-no">089</span><span id="line-89"> onDiskSizeWithoutHeader -= Bytes.SIZEOF_BYTE + ivLength;</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"> Compression.Algorithm compression = fileContext.getCompression();</span> |
| <span class="source-line-no">093</span><span id="line-93"> if (compression != Compression.Algorithm.NONE) {</span> |
| <span class="source-line-no">094</span><span id="line-94"> Decompressor decompressor = null;</span> |
| <span class="source-line-no">095</span><span id="line-95"> try {</span> |
| <span class="source-line-no">096</span><span id="line-96"> decompressor = compression.getDecompressor();</span> |
| <span class="source-line-no">097</span><span id="line-97"> // Some algorithms don't return decompressors and accept null as a valid parameter for</span> |
| <span class="source-line-no">098</span><span id="line-98"> // same when creating decompression streams. We can ignore these cases wrt reinit.</span> |
| <span class="source-line-no">099</span><span id="line-99"> if (decompressor instanceof CanReinit) {</span> |
| <span class="source-line-no">100</span><span id="line-100"> ((CanReinit) decompressor).reinit(conf);</span> |
| <span class="source-line-no">101</span><span id="line-101"> }</span> |
| <span class="source-line-no">102</span><span id="line-102"> try (InputStream is =</span> |
| <span class="source-line-no">103</span><span id="line-103"> compression.createDecompressionStream(dataInputStream, decompressor, 0)) {</span> |
| <span class="source-line-no">104</span><span id="line-104"> BlockIOUtils.readFullyWithHeapBuffer(is, blockBufferWithoutHeader,</span> |
| <span class="source-line-no">105</span><span id="line-105"> uncompressedSizeWithoutHeader);</span> |
| <span class="source-line-no">106</span><span id="line-106"> }</span> |
| <span class="source-line-no">107</span><span id="line-107"> } finally {</span> |
| <span class="source-line-no">108</span><span id="line-108"> if (decompressor != null) {</span> |
| <span class="source-line-no">109</span><span id="line-109"> compression.returnDecompressor(decompressor);</span> |
| <span class="source-line-no">110</span><span id="line-110"> }</span> |
| <span class="source-line-no">111</span><span id="line-111"> }</span> |
| <span class="source-line-no">112</span><span id="line-112"> } else {</span> |
| <span class="source-line-no">113</span><span id="line-113"> BlockIOUtils.readFullyWithHeapBuffer(dataInputStream, blockBufferWithoutHeader,</span> |
| <span class="source-line-no">114</span><span id="line-114"> onDiskSizeWithoutHeader);</span> |
| <span class="source-line-no">115</span><span id="line-115"> }</span> |
| <span class="source-line-no">116</span><span id="line-116"> } finally {</span> |
| <span class="source-line-no">117</span><span id="line-117"> byteBuffInputStream.close();</span> |
| <span class="source-line-no">118</span><span id="line-118"> dataInputStream.close();</span> |
| <span class="source-line-no">119</span><span id="line-119"> }</span> |
| <span class="source-line-no">120</span><span id="line-120"> }</span> |
| <span class="source-line-no">121</span><span id="line-121"></span> |
| <span class="source-line-no">122</span><span id="line-122"> @Override</span> |
| <span class="source-line-no">123</span><span id="line-123"> public HFileContext getHFileContext() {</span> |
| <span class="source-line-no">124</span><span id="line-124"> return this.fileContext;</span> |
| <span class="source-line-no">125</span><span id="line-125"> }</span> |
| <span class="source-line-no">126</span><span id="line-126"></span> |
| <span class="source-line-no">127</span><span id="line-127"> public TagCompressionContext getTagCompressionContext() {</span> |
| <span class="source-line-no">128</span><span id="line-128"> return tagCompressionContext;</span> |
| <span class="source-line-no">129</span><span id="line-129"> }</span> |
| <span class="source-line-no">130</span><span id="line-130"></span> |
| <span class="source-line-no">131</span><span id="line-131"> public void setTagCompressionContext(TagCompressionContext tagCompressionContext) {</span> |
| <span class="source-line-no">132</span><span id="line-132"> this.tagCompressionContext = tagCompressionContext;</span> |
| <span class="source-line-no">133</span><span id="line-133"> }</span> |
| <span class="source-line-no">134</span><span id="line-134">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
