Google Git
Sign in
apache / hbase-site / 0082cda45f48d1755543336c908ec6d80d4ec0a9 / . / devapidocs / src-html / org / apache / hadoop / hbase / regionserver / wal / AbstractProtobufLogWriter.html
blob: c536cd2be66982691824c69253c5044386de9537 [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: AbstractProtobufLogWriter">
<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 static org.apache.hadoop.hbase.regionserver.wal.AbstractFSWAL.WAL_AVOID_LOCAL_WRITES_DEFAULT;</span>
<span class="source-line-no">021</span><span id="line-21">import static org.apache.hadoop.hbase.regionserver.wal.AbstractFSWAL.WAL_AVOID_LOCAL_WRITES_KEY;</span>
<span class="source-line-no">022</span><span id="line-22">import static org.apache.hadoop.hbase.regionserver.wal.AbstractProtobufWALReader.DEFAULT_WAL_TRAILER_WARN_SIZE;</span>
<span class="source-line-no">023</span><span id="line-23">import static org.apache.hadoop.hbase.regionserver.wal.AbstractProtobufWALReader.PB_WAL_COMPLETE_MAGIC;</span>
<span class="source-line-no">024</span><span id="line-24">import static org.apache.hadoop.hbase.regionserver.wal.AbstractProtobufWALReader.PB_WAL_MAGIC;</span>
<span class="source-line-no">025</span><span id="line-25">import static org.apache.hadoop.hbase.regionserver.wal.AbstractProtobufWALReader.WAL_TRAILER_WARN_SIZE;</span>
<span class="source-line-no">026</span><span id="line-26"></span>
<span class="source-line-no">027</span><span id="line-27">import java.io.IOException;</span>
<span class="source-line-no">028</span><span id="line-28">import java.io.OutputStream;</span>
<span class="source-line-no">029</span><span id="line-29">import java.security.Key;</span>
<span class="source-line-no">030</span><span id="line-30">import java.util.concurrent.atomic.AtomicLong;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.fs.FileSystem;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.fs.Path;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.HConstants;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.codec.Codec;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.io.asyncfs.monitor.StreamSlowMonitor;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.io.compress.Compression;</span>
<span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.io.crypto.Cipher;</span>
<span class="source-line-no">039</span><span id="line-39">import org.apache.hadoop.hbase.io.crypto.Encryption;</span>
<span class="source-line-no">040</span><span id="line-40">import org.apache.hadoop.hbase.io.crypto.Encryptor;</span>
<span class="source-line-no">041</span><span id="line-41">import org.apache.hadoop.hbase.io.util.LRUDictionary;</span>
<span class="source-line-no">042</span><span id="line-42">import org.apache.hadoop.hbase.security.EncryptionUtil;</span>
<span class="source-line-no">043</span><span id="line-43">import org.apache.hadoop.hbase.security.User;</span>
<span class="source-line-no">044</span><span id="line-44">import org.apache.hadoop.hbase.util.CommonFSUtils;</span>
<span class="source-line-no">045</span><span id="line-45">import org.apache.hadoop.hbase.util.CommonFSUtils.StreamLacksCapabilityException;</span>
<span class="source-line-no">046</span><span id="line-46">import org.apache.hadoop.hbase.util.EncryptionTest;</span>
<span class="source-line-no">047</span><span id="line-47">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">048</span><span id="line-48">import org.slf4j.Logger;</span>
<span class="source-line-no">049</span><span id="line-49">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">050</span><span id="line-50"></span>
<span class="source-line-no">051</span><span id="line-51">import org.apache.hbase.thirdparty.com.google.protobuf.UnsafeByteOperations;</span>
<span class="source-line-no">052</span><span id="line-52"></span>
<span class="source-line-no">053</span><span id="line-53">import org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALHeader;</span>
<span class="source-line-no">054</span><span id="line-54">import org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALTrailer;</span>
<span class="source-line-no">055</span><span id="line-55"></span>
<span class="source-line-no">056</span><span id="line-56">/**</span>
<span class="source-line-no">057</span><span id="line-57"> * Base class for Protobuf log writer.</span>
<span class="source-line-no">058</span><span id="line-58"> */</span>
<span class="source-line-no">059</span><span id="line-59">@InterfaceAudience.Private</span>
<span class="source-line-no">060</span><span id="line-60">public abstract class AbstractProtobufLogWriter {</span>
<span class="source-line-no">061</span><span id="line-61"></span>
<span class="source-line-no">062</span><span id="line-62"> private static final Logger LOG = LoggerFactory.getLogger(AbstractProtobufLogWriter.class);</span>
<span class="source-line-no">063</span><span id="line-63"></span>
<span class="source-line-no">064</span><span id="line-64"> protected CompressionContext compressionContext;</span>
<span class="source-line-no">065</span><span id="line-65"> protected Configuration conf;</span>
<span class="source-line-no">066</span><span id="line-66"> protected Encryptor encryptor;</span>
<span class="source-line-no">067</span><span id="line-67"> protected Codec.Encoder cellEncoder;</span>
<span class="source-line-no">068</span><span id="line-68"> protected WALCellCodec.ByteStringCompressor compressor;</span>
<span class="source-line-no">069</span><span id="line-69"> protected boolean trailerWritten;</span>
<span class="source-line-no">070</span><span id="line-70"> protected WALTrailer trailer;</span>
<span class="source-line-no">071</span><span id="line-71"> // maximum size of the wal Trailer in bytes. If a user writes/reads a trailer with size larger</span>
<span class="source-line-no">072</span><span id="line-72"> // than this size, it is written/read respectively, with a WARN message in the log.</span>
<span class="source-line-no">073</span><span id="line-73"> protected int trailerWarnSize;</span>
<span class="source-line-no">074</span><span id="line-74"></span>
<span class="source-line-no">075</span><span id="line-75"> protected AtomicLong length = new AtomicLong();</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 WALCellCodec getCodec(Configuration conf, CompressionContext compressionContext)</span>
<span class="source-line-no">078</span><span id="line-78"> throws IOException {</span>
<span class="source-line-no">079</span><span id="line-79"> return WALCellCodec.create(conf, null, compressionContext);</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"> private WALHeader buildWALHeader(Configuration conf, WALHeader.Builder builder)</span>
<span class="source-line-no">083</span><span id="line-83"> throws IOException {</span>
<span class="source-line-no">084</span><span id="line-84"> builder.setWriterClsName(getWriterClassName());</span>
<span class="source-line-no">085</span><span id="line-85"> builder.setCellCodecClsName(WALCellCodec.getWALCellCodecClass(conf).getName());</span>
<span class="source-line-no">086</span><span id="line-86"> return builder.build();</span>
<span class="source-line-no">087</span><span id="line-87"> }</span>
<span class="source-line-no">088</span><span id="line-88"></span>
<span class="source-line-no">089</span><span id="line-89"> private WALHeader buildSecureWALHeader(Configuration conf, WALHeader.Builder builder)</span>
<span class="source-line-no">090</span><span id="line-90"> throws IOException {</span>
<span class="source-line-no">091</span><span id="line-91"> EncryptionTest.testKeyProvider(conf);</span>
<span class="source-line-no">092</span><span id="line-92"> EncryptionTest.testCipherProvider(conf);</span>
<span class="source-line-no">093</span><span id="line-93"></span>
<span class="source-line-no">094</span><span id="line-94"> // Get an instance of our cipher</span>
<span class="source-line-no">095</span><span id="line-95"> final String cipherName =</span>
<span class="source-line-no">096</span><span id="line-96"> conf.get(HConstants.CRYPTO_WAL_ALGORITHM_CONF_KEY, HConstants.CIPHER_AES);</span>
<span class="source-line-no">097</span><span id="line-97"> Cipher cipher = Encryption.getCipher(conf, cipherName);</span>
<span class="source-line-no">098</span><span id="line-98"> if (cipher == null) {</span>
<span class="source-line-no">099</span><span id="line-99"> throw new RuntimeException("Cipher '" + cipherName + "' is not available");</span>
<span class="source-line-no">100</span><span id="line-100"> }</span>
<span class="source-line-no">101</span><span id="line-101"></span>
<span class="source-line-no">102</span><span id="line-102"> // Generate a random encryption key for this WAL</span>
<span class="source-line-no">103</span><span id="line-103"> Key key = cipher.getRandomKey();</span>
<span class="source-line-no">104</span><span id="line-104"> builder.setEncryptionKey(UnsafeByteOperations.unsafeWrap(EncryptionUtil.wrapKey(conf,</span>
<span class="source-line-no">105</span><span id="line-105"> conf.get(HConstants.CRYPTO_WAL_KEY_NAME_CONF_KEY,</span>
<span class="source-line-no">106</span><span id="line-106"> conf.get(HConstants.CRYPTO_MASTERKEY_NAME_CONF_KEY, User.getCurrent().getShortName())),</span>
<span class="source-line-no">107</span><span id="line-107"> key)));</span>
<span class="source-line-no">108</span><span id="line-108"></span>
<span class="source-line-no">109</span><span id="line-109"> // Set up the encryptor</span>
<span class="source-line-no">110</span><span id="line-110"> Encryptor encryptor = cipher.getEncryptor();</span>
<span class="source-line-no">111</span><span id="line-111"> encryptor.setKey(key);</span>
<span class="source-line-no">112</span><span id="line-112"> this.encryptor = encryptor;</span>
<span class="source-line-no">113</span><span id="line-113"> if (LOG.isTraceEnabled()) {</span>
<span class="source-line-no">114</span><span id="line-114"> LOG.trace("Initialized secure protobuf WAL: cipher={}", cipher.getName());</span>
<span class="source-line-no">115</span><span id="line-115"> }</span>
<span class="source-line-no">116</span><span id="line-116"> builder.setWriterClsName(getWriterClassName());</span>
<span class="source-line-no">117</span><span id="line-117"> builder.setCellCodecClsName(SecureWALCellCodec.class.getName());</span>
<span class="source-line-no">118</span><span id="line-118"> return builder.build();</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"> private String getWriterClassName() {</span>
<span class="source-line-no">122</span><span id="line-122"> // class name which is recognized by hbase-1.x to avoid ProtobufLogReader throwing error:</span>
<span class="source-line-no">123</span><span id="line-123"> // IOException: Got unknown writer class: AsyncProtobufLogWriter</span>
<span class="source-line-no">124</span><span id="line-124"> if (encryptor == null) {</span>
<span class="source-line-no">125</span><span id="line-125"> return "ProtobufLogWriter";</span>
<span class="source-line-no">126</span><span id="line-126"> } else {</span>
<span class="source-line-no">127</span><span id="line-127"> return "SecureProtobufLogWriter";</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"></span>
<span class="source-line-no">131</span><span id="line-131"> private boolean initializeCompressionContext(Configuration conf, Path path) throws IOException {</span>
<span class="source-line-no">132</span><span id="line-132"> boolean doCompress = conf.getBoolean(HConstants.ENABLE_WAL_COMPRESSION, false);</span>
<span class="source-line-no">133</span><span id="line-133"> if (doCompress) {</span>
<span class="source-line-no">134</span><span id="line-134"> try {</span>
<span class="source-line-no">135</span><span id="line-135"> final boolean useTagCompression =</span>
<span class="source-line-no">136</span><span id="line-136"> conf.getBoolean(CompressionContext.ENABLE_WAL_TAGS_COMPRESSION, true);</span>
<span class="source-line-no">137</span><span id="line-137"> final boolean useValueCompression =</span>
<span class="source-line-no">138</span><span id="line-138"> conf.getBoolean(CompressionContext.ENABLE_WAL_VALUE_COMPRESSION, false);</span>
<span class="source-line-no">139</span><span id="line-139"> final Compression.Algorithm valueCompressionType = useValueCompression</span>
<span class="source-line-no">140</span><span id="line-140"> ? CompressionContext.getValueCompressionAlgorithm(conf)</span>
<span class="source-line-no">141</span><span id="line-141"> : Compression.Algorithm.NONE;</span>
<span class="source-line-no">142</span><span id="line-142"> if (LOG.isTraceEnabled()) {</span>
<span class="source-line-no">143</span><span id="line-143"> LOG.trace(</span>
<span class="source-line-no">144</span><span id="line-144"> "Initializing compression context for {}: isRecoveredEdits={}"</span>
<span class="source-line-no">145</span><span id="line-145"> + ", hasTagCompression={}, hasValueCompression={}, valueCompressionType={}",</span>
<span class="source-line-no">146</span><span id="line-146"> path, CommonFSUtils.isRecoveredEdits(path), useTagCompression, useValueCompression,</span>
<span class="source-line-no">147</span><span id="line-147"> valueCompressionType);</span>
<span class="source-line-no">148</span><span id="line-148"> }</span>
<span class="source-line-no">149</span><span id="line-149"> this.compressionContext =</span>
<span class="source-line-no">150</span><span id="line-150"> new CompressionContext(LRUDictionary.class, CommonFSUtils.isRecoveredEdits(path),</span>
<span class="source-line-no">151</span><span id="line-151"> useTagCompression, useValueCompression, valueCompressionType);</span>
<span class="source-line-no">152</span><span id="line-152"> } catch (Exception e) {</span>
<span class="source-line-no">153</span><span id="line-153"> throw new IOException("Failed to initiate CompressionContext", e);</span>
<span class="source-line-no">154</span><span id="line-154"> }</span>
<span class="source-line-no">155</span><span id="line-155"> }</span>
<span class="source-line-no">156</span><span id="line-156"> return doCompress;</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"> public void init(FileSystem fs, Path path, Configuration conf, boolean overwritable,</span>
<span class="source-line-no">160</span><span id="line-160"> long blocksize, StreamSlowMonitor monitor) throws IOException, StreamLacksCapabilityException {</span>
<span class="source-line-no">161</span><span id="line-161"> try {</span>
<span class="source-line-no">162</span><span id="line-162"> this.conf = conf;</span>
<span class="source-line-no">163</span><span id="line-163"> boolean doCompress = initializeCompressionContext(conf, path);</span>
<span class="source-line-no">164</span><span id="line-164"> this.trailerWarnSize = conf.getInt(WAL_TRAILER_WARN_SIZE, DEFAULT_WAL_TRAILER_WARN_SIZE);</span>
<span class="source-line-no">165</span><span id="line-165"> int bufferSize = CommonFSUtils.getDefaultBufferSize(fs);</span>
<span class="source-line-no">166</span><span id="line-166"> short replication = (short) conf.getInt("hbase.regionserver.hlog.replication",</span>
<span class="source-line-no">167</span><span id="line-167"> CommonFSUtils.getDefaultReplication(fs, path));</span>
<span class="source-line-no">168</span><span id="line-168"> boolean noLocalWrite =</span>
<span class="source-line-no">169</span><span id="line-169"> conf.getBoolean(WAL_AVOID_LOCAL_WRITES_KEY, WAL_AVOID_LOCAL_WRITES_DEFAULT);</span>
<span class="source-line-no">170</span><span id="line-170"></span>
<span class="source-line-no">171</span><span id="line-171"> initOutput(fs, path, overwritable, bufferSize, replication, blocksize, monitor, noLocalWrite);</span>
<span class="source-line-no">172</span><span id="line-172"></span>
<span class="source-line-no">173</span><span id="line-173"> boolean doTagCompress =</span>
<span class="source-line-no">174</span><span id="line-174"> doCompress &amp;&amp; conf.getBoolean(CompressionContext.ENABLE_WAL_TAGS_COMPRESSION, true);</span>
<span class="source-line-no">175</span><span id="line-175"> boolean doValueCompress =</span>
<span class="source-line-no">176</span><span id="line-176"> doCompress &amp;&amp; conf.getBoolean(CompressionContext.ENABLE_WAL_VALUE_COMPRESSION, false);</span>
<span class="source-line-no">177</span><span id="line-177"> WALHeader.Builder headerBuilder = WALHeader.newBuilder().setHasCompression(doCompress)</span>
<span class="source-line-no">178</span><span id="line-178"> .setHasTagCompression(doTagCompress).setHasValueCompression(doValueCompress);</span>
<span class="source-line-no">179</span><span id="line-179"> if (doValueCompress) {</span>
<span class="source-line-no">180</span><span id="line-180"> headerBuilder.setValueCompressionAlgorithm(</span>
<span class="source-line-no">181</span><span id="line-181"> CompressionContext.getValueCompressionAlgorithm(conf).ordinal());</span>
<span class="source-line-no">182</span><span id="line-182"> }</span>
<span class="source-line-no">183</span><span id="line-183"> if (conf.getBoolean(HConstants.ENABLE_WAL_ENCRYPTION, false)) {</span>
<span class="source-line-no">184</span><span id="line-184"> length.set(writeMagicAndWALHeader(PB_WAL_MAGIC, buildSecureWALHeader(conf, headerBuilder)));</span>
<span class="source-line-no">185</span><span id="line-185"> secureInitAfterHeader(doCompress, encryptor);</span>
<span class="source-line-no">186</span><span id="line-186"> } else {</span>
<span class="source-line-no">187</span><span id="line-187"> length.set(writeMagicAndWALHeader(PB_WAL_MAGIC, buildWALHeader(conf, headerBuilder)));</span>
<span class="source-line-no">188</span><span id="line-188"> initAfterHeader(doCompress);</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"> // instantiate trailer to default value.</span>
<span class="source-line-no">192</span><span id="line-192"> trailer = WALTrailer.newBuilder().build();</span>
<span class="source-line-no">193</span><span id="line-193"></span>
<span class="source-line-no">194</span><span id="line-194"> if (LOG.isTraceEnabled()) {</span>
<span class="source-line-no">195</span><span id="line-195"> LOG.trace("Initialized protobuf WAL={}, compression={}, tagCompression={}"</span>
<span class="source-line-no">196</span><span id="line-196"> + ", valueCompression={}", path, doCompress, doTagCompress, doValueCompress);</span>
<span class="source-line-no">197</span><span id="line-197"> }</span>
<span class="source-line-no">198</span><span id="line-198"> } catch (Exception e) {</span>
<span class="source-line-no">199</span><span id="line-199"> LOG.warn("Init output failed, path={}", path, e);</span>
<span class="source-line-no">200</span><span id="line-200"> closeOutputIfNecessary();</span>
<span class="source-line-no">201</span><span id="line-201"> throw e;</span>
<span class="source-line-no">202</span><span id="line-202"> }</span>
<span class="source-line-no">203</span><span id="line-203"> }</span>
<span class="source-line-no">204</span><span id="line-204"></span>
<span class="source-line-no">205</span><span id="line-205"> private void initAfterHeader(boolean doCompress) throws IOException {</span>
<span class="source-line-no">206</span><span id="line-206"> WALCellCodec codec = getCodec(conf, this.compressionContext);</span>
<span class="source-line-no">207</span><span id="line-207"> this.cellEncoder = codec.getEncoder(getOutputStreamForCellEncoder());</span>
<span class="source-line-no">208</span><span id="line-208"> if (doCompress) {</span>
<span class="source-line-no">209</span><span id="line-209"> this.compressor = codec.getByteStringCompressor();</span>
<span class="source-line-no">210</span><span id="line-210"> } else {</span>
<span class="source-line-no">211</span><span id="line-211"> this.compressor = WALCellCodec.getNoneCompressor();</span>
<span class="source-line-no">212</span><span id="line-212"> }</span>
<span class="source-line-no">213</span><span id="line-213"> }</span>
<span class="source-line-no">214</span><span id="line-214"></span>
<span class="source-line-no">215</span><span id="line-215"> private void secureInitAfterHeader(boolean doCompress, Encryptor encryptor) throws IOException {</span>
<span class="source-line-no">216</span><span id="line-216"> if (encryptor != null) {</span>
<span class="source-line-no">217</span><span id="line-217"> WALCellCodec codec = SecureWALCellCodec.getCodec(this.conf, encryptor);</span>
<span class="source-line-no">218</span><span id="line-218"> this.cellEncoder = codec.getEncoder(getOutputStreamForCellEncoder());</span>
<span class="source-line-no">219</span><span id="line-219"> // We do not support compression</span>
<span class="source-line-no">220</span><span id="line-220"> this.compressionContext = null;</span>
<span class="source-line-no">221</span><span id="line-221"> this.compressor = WALCellCodec.getNoneCompressor();</span>
<span class="source-line-no">222</span><span id="line-222"> } else {</span>
<span class="source-line-no">223</span><span id="line-223"> initAfterHeader(doCompress);</span>
<span class="source-line-no">224</span><span id="line-224"> }</span>
<span class="source-line-no">225</span><span id="line-225"> }</span>
<span class="source-line-no">226</span><span id="line-226"></span>
<span class="source-line-no">227</span><span id="line-227"> void setWALTrailer(WALTrailer walTrailer) {</span>
<span class="source-line-no">228</span><span id="line-228"> this.trailer = walTrailer;</span>
<span class="source-line-no">229</span><span id="line-229"> }</span>
<span class="source-line-no">230</span><span id="line-230"></span>
<span class="source-line-no">231</span><span id="line-231"> public long getLength() {</span>
<span class="source-line-no">232</span><span id="line-232"> return length.get();</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"> private WALTrailer buildWALTrailer(WALTrailer.Builder builder) {</span>
<span class="source-line-no">236</span><span id="line-236"> return builder.build();</span>
<span class="source-line-no">237</span><span id="line-237"> }</span>
<span class="source-line-no">238</span><span id="line-238"></span>
<span class="source-line-no">239</span><span id="line-239"> protected final void writeWALTrailer() {</span>
<span class="source-line-no">240</span><span id="line-240"> try {</span>
<span class="source-line-no">241</span><span id="line-241"> int trailerSize = 0;</span>
<span class="source-line-no">242</span><span id="line-242"> if (this.trailer == null) {</span>
<span class="source-line-no">243</span><span id="line-243"> // use default trailer.</span>
<span class="source-line-no">244</span><span id="line-244"> LOG.warn("WALTrailer is null. Continuing with default.");</span>
<span class="source-line-no">245</span><span id="line-245"> this.trailer = buildWALTrailer(WALTrailer.newBuilder());</span>
<span class="source-line-no">246</span><span id="line-246"> trailerSize = this.trailer.getSerializedSize();</span>
<span class="source-line-no">247</span><span id="line-247"> } else if ((trailerSize = this.trailer.getSerializedSize()) &gt; this.trailerWarnSize) {</span>
<span class="source-line-no">248</span><span id="line-248"> // continue writing after warning the user.</span>
<span class="source-line-no">249</span><span id="line-249"> LOG.warn("Please investigate WALTrailer usage. Trailer size &gt; maximum size : " + trailerSize</span>
<span class="source-line-no">250</span><span id="line-250"> + " &gt; " + this.trailerWarnSize);</span>
<span class="source-line-no">251</span><span id="line-251"> }</span>
<span class="source-line-no">252</span><span id="line-252"> length.set(writeWALTrailerAndMagic(trailer, PB_WAL_COMPLETE_MAGIC));</span>
<span class="source-line-no">253</span><span id="line-253"> this.trailerWritten = true;</span>
<span class="source-line-no">254</span><span id="line-254"> } catch (IOException ioe) {</span>
<span class="source-line-no">255</span><span id="line-255"> LOG.warn("Failed to write trailer, non-fatal, continuing...", ioe);</span>
<span class="source-line-no">256</span><span id="line-256"> }</span>
<span class="source-line-no">257</span><span id="line-257"> }</span>
<span class="source-line-no">258</span><span id="line-258"></span>
<span class="source-line-no">259</span><span id="line-259"> protected abstract void initOutput(FileSystem fs, Path path, boolean overwritable, int bufferSize,</span>
<span class="source-line-no">260</span><span id="line-260"> short replication, long blockSize, StreamSlowMonitor monitor, boolean noLocalWrite)</span>
<span class="source-line-no">261</span><span id="line-261"> throws IOException, StreamLacksCapabilityException;</span>
<span class="source-line-no">262</span><span id="line-262"></span>
<span class="source-line-no">263</span><span id="line-263"> /**</span>
<span class="source-line-no">264</span><span id="line-264"> * It is straight forward to close the output, do not need to write trailer like the Writer.close</span>
<span class="source-line-no">265</span><span id="line-265"> */</span>
<span class="source-line-no">266</span><span id="line-266"> protected void closeOutputIfNecessary() {</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"> /**</span>
<span class="source-line-no">270</span><span id="line-270"> * return the file length after written.</span>
<span class="source-line-no">271</span><span id="line-271"> */</span>
<span class="source-line-no">272</span><span id="line-272"> protected abstract long writeMagicAndWALHeader(byte[] magic, WALHeader header) throws IOException;</span>
<span class="source-line-no">273</span><span id="line-273"></span>
<span class="source-line-no">274</span><span id="line-274"> protected abstract long writeWALTrailerAndMagic(WALTrailer trailer, byte[] magic)</span>
<span class="source-line-no">275</span><span id="line-275"> throws IOException;</span>
<span class="source-line-no">276</span><span id="line-276"></span>
<span class="source-line-no">277</span><span id="line-277"> protected abstract OutputStream getOutputStreamForCellEncoder();</span>
<span class="source-line-no">278</span><span id="line-278">}</span>
</pre>
</div>
</main>
</body>
</html>