blob: 7245daafe93d74388d286158352fe9ddaebe0cf7 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a>
<span class="sourceLineNo">002</span> *<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.3"></a>
<span class="sourceLineNo">004</span> * or more contributor license agreements. See the NOTICE file<a name="line.4"></a>
<span class="sourceLineNo">005</span> * distributed with this work for additional information<a name="line.5"></a>
<span class="sourceLineNo">006</span> * regarding copyright ownership. The ASF licenses this file<a name="line.6"></a>
<span class="sourceLineNo">007</span> * to you under the Apache License, Version 2.0 (the<a name="line.7"></a>
<span class="sourceLineNo">008</span> * "License"); you may not use this file except in compliance<a name="line.8"></a>
<span class="sourceLineNo">009</span> * with the License. You may obtain a copy of the License at<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.11"></a>
<span class="sourceLineNo">012</span> *<a name="line.12"></a>
<span class="sourceLineNo">013</span> * Unless required by applicable law or agreed to in writing, software<a name="line.13"></a>
<span class="sourceLineNo">014</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.14"></a>
<span class="sourceLineNo">015</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.15"></a>
<span class="sourceLineNo">016</span> * See the License for the specific language governing permissions and<a name="line.16"></a>
<span class="sourceLineNo">017</span> * limitations under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> */<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>package org.apache.hadoop.hbase.regionserver.wal;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.io.EOFException;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.io.IOException;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.nio.ByteBuffer;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.ArrayList;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.Arrays;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.List;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hadoop.conf.Configuration;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.fs.Path;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.fs.FileSystem;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.fs.FSDataInputStream;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.codec.Codec;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.HBaseInterfaceAudience;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.shaded.protobuf.ProtobufUtil;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALHeader.Builder;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALKey;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALTrailer;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.wal.WAL.Entry;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span>import org.slf4j.Logger;<a name="line.44"></a>
<span class="sourceLineNo">045</span>import org.slf4j.LoggerFactory;<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span>import org.apache.hbase.thirdparty.com.google.common.io.ByteStreams;<a name="line.47"></a>
<span class="sourceLineNo">048</span>import org.apache.hbase.thirdparty.com.google.protobuf.CodedInputStream;<a name="line.48"></a>
<span class="sourceLineNo">049</span>import org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException;<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span>/**<a name="line.51"></a>
<span class="sourceLineNo">052</span> * A Protobuf based WAL has the following structure:<a name="line.52"></a>
<span class="sourceLineNo">053</span> * &lt;p&gt;<a name="line.53"></a>
<span class="sourceLineNo">054</span> * &amp;lt;PB_WAL_MAGIC&amp;gt;&amp;lt;WALHeader&amp;gt;&amp;lt;WALEdits&amp;gt;...&amp;lt;WALEdits&amp;gt;&amp;lt;Trailer&amp;gt;<a name="line.54"></a>
<span class="sourceLineNo">055</span> * &amp;lt;TrailerSize&amp;gt; &amp;lt;PB_WAL_COMPLETE_MAGIC&amp;gt;<a name="line.55"></a>
<span class="sourceLineNo">056</span> * &lt;/p&gt;<a name="line.56"></a>
<span class="sourceLineNo">057</span> * The Reader reads meta information (WAL Compression state, WALTrailer, etc) in<a name="line.57"></a>
<span class="sourceLineNo">058</span> * ProtobufLogReader#initReader(FSDataInputStream). A WALTrailer is an extensible structure<a name="line.58"></a>
<span class="sourceLineNo">059</span> * which is appended at the end of the WAL. This is empty for now; it can contain some meta<a name="line.59"></a>
<span class="sourceLineNo">060</span> * information such as Region level stats, etc in future.<a name="line.60"></a>
<span class="sourceLineNo">061</span> */<a name="line.61"></a>
<span class="sourceLineNo">062</span>@InterfaceAudience.LimitedPrivate({HBaseInterfaceAudience.COPROC, HBaseInterfaceAudience.PHOENIX,<a name="line.62"></a>
<span class="sourceLineNo">063</span> HBaseInterfaceAudience.CONFIG})<a name="line.63"></a>
<span class="sourceLineNo">064</span>public class ProtobufLogReader extends ReaderBase {<a name="line.64"></a>
<span class="sourceLineNo">065</span> private static final Logger LOG = LoggerFactory.getLogger(ProtobufLogReader.class);<a name="line.65"></a>
<span class="sourceLineNo">066</span> // public for WALFactory until we move everything to o.a.h.h.wal<a name="line.66"></a>
<span class="sourceLineNo">067</span> @InterfaceAudience.Private<a name="line.67"></a>
<span class="sourceLineNo">068</span> public static final byte[] PB_WAL_MAGIC = Bytes.toBytes("PWAL");<a name="line.68"></a>
<span class="sourceLineNo">069</span> // public for TestWALSplit<a name="line.69"></a>
<span class="sourceLineNo">070</span> @InterfaceAudience.Private<a name="line.70"></a>
<span class="sourceLineNo">071</span> public static final byte[] PB_WAL_COMPLETE_MAGIC = Bytes.toBytes("LAWP");<a name="line.71"></a>
<span class="sourceLineNo">072</span> /**<a name="line.72"></a>
<span class="sourceLineNo">073</span> * Configuration name of WAL Trailer's warning size. If a waltrailer's size is greater than the<a name="line.73"></a>
<span class="sourceLineNo">074</span> * configured size, providers should log a warning. e.g. this is used with Protobuf reader/writer.<a name="line.74"></a>
<span class="sourceLineNo">075</span> */<a name="line.75"></a>
<span class="sourceLineNo">076</span> static final String WAL_TRAILER_WARN_SIZE = "hbase.regionserver.waltrailer.warn.size";<a name="line.76"></a>
<span class="sourceLineNo">077</span> static final int DEFAULT_WAL_TRAILER_WARN_SIZE = 1024 * 1024; // 1MB<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span> protected FSDataInputStream inputStream;<a name="line.79"></a>
<span class="sourceLineNo">080</span> protected Codec.Decoder cellDecoder;<a name="line.80"></a>
<span class="sourceLineNo">081</span> protected WALCellCodec.ByteStringUncompressor byteStringUncompressor;<a name="line.81"></a>
<span class="sourceLineNo">082</span> protected boolean hasCompression = false;<a name="line.82"></a>
<span class="sourceLineNo">083</span> protected boolean hasTagCompression = false;<a name="line.83"></a>
<span class="sourceLineNo">084</span> // walEditsStopOffset is the position of the last byte to read. After reading the last WALEdit<a name="line.84"></a>
<span class="sourceLineNo">085</span> // entry in the wal, the inputstream's position is equal to walEditsStopOffset.<a name="line.85"></a>
<span class="sourceLineNo">086</span> private long walEditsStopOffset;<a name="line.86"></a>
<span class="sourceLineNo">087</span> private boolean trailerPresent;<a name="line.87"></a>
<span class="sourceLineNo">088</span> protected WALTrailer trailer;<a name="line.88"></a>
<span class="sourceLineNo">089</span> // maximum size of the wal Trailer in bytes. If a user writes/reads a trailer with size larger<a name="line.89"></a>
<span class="sourceLineNo">090</span> // than this size, it is written/read respectively, with a WARN message in the log.<a name="line.90"></a>
<span class="sourceLineNo">091</span> protected int trailerWarnSize;<a name="line.91"></a>
<span class="sourceLineNo">092</span> private static List&lt;String&gt; writerClsNames = new ArrayList&lt;&gt;();<a name="line.92"></a>
<span class="sourceLineNo">093</span> static {<a name="line.93"></a>
<span class="sourceLineNo">094</span> writerClsNames.add(ProtobufLogWriter.class.getSimpleName());<a name="line.94"></a>
<span class="sourceLineNo">095</span> writerClsNames.add(AsyncProtobufLogWriter.class.getSimpleName());<a name="line.95"></a>
<span class="sourceLineNo">096</span> }<a name="line.96"></a>
<span class="sourceLineNo">097</span> <a name="line.97"></a>
<span class="sourceLineNo">098</span> // cell codec classname<a name="line.98"></a>
<span class="sourceLineNo">099</span> private String codecClsName = null;<a name="line.99"></a>
<span class="sourceLineNo">100</span><a name="line.100"></a>
<span class="sourceLineNo">101</span> @InterfaceAudience.Private<a name="line.101"></a>
<span class="sourceLineNo">102</span> public long trailerSize() {<a name="line.102"></a>
<span class="sourceLineNo">103</span> if (trailerPresent) {<a name="line.103"></a>
<span class="sourceLineNo">104</span> // sizeof PB_WAL_COMPLETE_MAGIC + sizof trailerSize + trailer<a name="line.104"></a>
<span class="sourceLineNo">105</span> final long calculatedSize = (long) PB_WAL_COMPLETE_MAGIC.length + Bytes.SIZEOF_INT<a name="line.105"></a>
<span class="sourceLineNo">106</span> + trailer.getSerializedSize();<a name="line.106"></a>
<span class="sourceLineNo">107</span> final long expectedSize = fileLength - walEditsStopOffset;<a name="line.107"></a>
<span class="sourceLineNo">108</span> if (expectedSize != calculatedSize) {<a name="line.108"></a>
<span class="sourceLineNo">109</span> LOG.warn("After parsing the trailer, we expect the total footer to be {} bytes, but we "<a name="line.109"></a>
<span class="sourceLineNo">110</span> + "calculate it as being {}", expectedSize, calculatedSize);<a name="line.110"></a>
<span class="sourceLineNo">111</span> }<a name="line.111"></a>
<span class="sourceLineNo">112</span> return expectedSize;<a name="line.112"></a>
<span class="sourceLineNo">113</span> } else {<a name="line.113"></a>
<span class="sourceLineNo">114</span> return -1L;<a name="line.114"></a>
<span class="sourceLineNo">115</span> }<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span> enum WALHdrResult {<a name="line.118"></a>
<span class="sourceLineNo">119</span> EOF, // stream is at EOF when method starts<a name="line.119"></a>
<span class="sourceLineNo">120</span> SUCCESS,<a name="line.120"></a>
<span class="sourceLineNo">121</span> UNKNOWN_WRITER_CLS // name of writer class isn't recognized<a name="line.121"></a>
<span class="sourceLineNo">122</span> }<a name="line.122"></a>
<span class="sourceLineNo">123</span> <a name="line.123"></a>
<span class="sourceLineNo">124</span> // context for WALHdr carrying information such as Cell Codec classname<a name="line.124"></a>
<span class="sourceLineNo">125</span> static class WALHdrContext {<a name="line.125"></a>
<span class="sourceLineNo">126</span> WALHdrResult result;<a name="line.126"></a>
<span class="sourceLineNo">127</span> String cellCodecClsName;<a name="line.127"></a>
<span class="sourceLineNo">128</span> <a name="line.128"></a>
<span class="sourceLineNo">129</span> WALHdrContext(WALHdrResult result, String cellCodecClsName) {<a name="line.129"></a>
<span class="sourceLineNo">130</span> this.result = result;<a name="line.130"></a>
<span class="sourceLineNo">131</span> this.cellCodecClsName = cellCodecClsName;<a name="line.131"></a>
<span class="sourceLineNo">132</span> }<a name="line.132"></a>
<span class="sourceLineNo">133</span> WALHdrResult getResult() {<a name="line.133"></a>
<span class="sourceLineNo">134</span> return result;<a name="line.134"></a>
<span class="sourceLineNo">135</span> }<a name="line.135"></a>
<span class="sourceLineNo">136</span> String getCellCodecClsName() {<a name="line.136"></a>
<span class="sourceLineNo">137</span> return cellCodecClsName;<a name="line.137"></a>
<span class="sourceLineNo">138</span> }<a name="line.138"></a>
<span class="sourceLineNo">139</span> }<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span> public ProtobufLogReader() {<a name="line.141"></a>
<span class="sourceLineNo">142</span> super();<a name="line.142"></a>
<span class="sourceLineNo">143</span> }<a name="line.143"></a>
<span class="sourceLineNo">144</span><a name="line.144"></a>
<span class="sourceLineNo">145</span> @Override<a name="line.145"></a>
<span class="sourceLineNo">146</span> public void close() throws IOException {<a name="line.146"></a>
<span class="sourceLineNo">147</span> if (this.inputStream != null) {<a name="line.147"></a>
<span class="sourceLineNo">148</span> this.inputStream.close();<a name="line.148"></a>
<span class="sourceLineNo">149</span> this.inputStream = null;<a name="line.149"></a>
<span class="sourceLineNo">150</span> }<a name="line.150"></a>
<span class="sourceLineNo">151</span> }<a name="line.151"></a>
<span class="sourceLineNo">152</span><a name="line.152"></a>
<span class="sourceLineNo">153</span> @Override<a name="line.153"></a>
<span class="sourceLineNo">154</span> public long getPosition() throws IOException {<a name="line.154"></a>
<span class="sourceLineNo">155</span> return inputStream.getPos();<a name="line.155"></a>
<span class="sourceLineNo">156</span> }<a name="line.156"></a>
<span class="sourceLineNo">157</span><a name="line.157"></a>
<span class="sourceLineNo">158</span> @Override<a name="line.158"></a>
<span class="sourceLineNo">159</span> public void reset() throws IOException {<a name="line.159"></a>
<span class="sourceLineNo">160</span> String clsName = initInternal(null, false);<a name="line.160"></a>
<span class="sourceLineNo">161</span> initAfterCompression(clsName); // We need a new decoder (at least).<a name="line.161"></a>
<span class="sourceLineNo">162</span> }<a name="line.162"></a>
<span class="sourceLineNo">163</span><a name="line.163"></a>
<span class="sourceLineNo">164</span> @Override<a name="line.164"></a>
<span class="sourceLineNo">165</span> public void init(FileSystem fs, Path path, Configuration conf, FSDataInputStream stream)<a name="line.165"></a>
<span class="sourceLineNo">166</span> throws IOException {<a name="line.166"></a>
<span class="sourceLineNo">167</span> this.trailerWarnSize = conf.getInt(WAL_TRAILER_WARN_SIZE, DEFAULT_WAL_TRAILER_WARN_SIZE);<a name="line.167"></a>
<span class="sourceLineNo">168</span> super.init(fs, path, conf, stream);<a name="line.168"></a>
<span class="sourceLineNo">169</span> }<a name="line.169"></a>
<span class="sourceLineNo">170</span><a name="line.170"></a>
<span class="sourceLineNo">171</span> @Override<a name="line.171"></a>
<span class="sourceLineNo">172</span> protected String initReader(FSDataInputStream stream) throws IOException {<a name="line.172"></a>
<span class="sourceLineNo">173</span> return initInternal(stream, true);<a name="line.173"></a>
<span class="sourceLineNo">174</span> }<a name="line.174"></a>
<span class="sourceLineNo">175</span><a name="line.175"></a>
<span class="sourceLineNo">176</span> /*<a name="line.176"></a>
<span class="sourceLineNo">177</span> * Returns names of the accepted writer classes<a name="line.177"></a>
<span class="sourceLineNo">178</span> */<a name="line.178"></a>
<span class="sourceLineNo">179</span> public List&lt;String&gt; getWriterClsNames() {<a name="line.179"></a>
<span class="sourceLineNo">180</span> return writerClsNames;<a name="line.180"></a>
<span class="sourceLineNo">181</span> }<a name="line.181"></a>
<span class="sourceLineNo">182</span> <a name="line.182"></a>
<span class="sourceLineNo">183</span> /*<a name="line.183"></a>
<span class="sourceLineNo">184</span> * Returns the cell codec classname<a name="line.184"></a>
<span class="sourceLineNo">185</span> */<a name="line.185"></a>
<span class="sourceLineNo">186</span> public String getCodecClsName() {<a name="line.186"></a>
<span class="sourceLineNo">187</span> return codecClsName;<a name="line.187"></a>
<span class="sourceLineNo">188</span> }<a name="line.188"></a>
<span class="sourceLineNo">189</span><a name="line.189"></a>
<span class="sourceLineNo">190</span> protected WALHdrContext readHeader(Builder builder, FSDataInputStream stream)<a name="line.190"></a>
<span class="sourceLineNo">191</span> throws IOException {<a name="line.191"></a>
<span class="sourceLineNo">192</span> boolean res = builder.mergeDelimitedFrom(stream);<a name="line.192"></a>
<span class="sourceLineNo">193</span> if (!res) return new WALHdrContext(WALHdrResult.EOF, null);<a name="line.193"></a>
<span class="sourceLineNo">194</span> if (builder.hasWriterClsName() &amp;&amp;<a name="line.194"></a>
<span class="sourceLineNo">195</span> !getWriterClsNames().contains(builder.getWriterClsName())) {<a name="line.195"></a>
<span class="sourceLineNo">196</span> return new WALHdrContext(WALHdrResult.UNKNOWN_WRITER_CLS, null);<a name="line.196"></a>
<span class="sourceLineNo">197</span> }<a name="line.197"></a>
<span class="sourceLineNo">198</span> String clsName = null;<a name="line.198"></a>
<span class="sourceLineNo">199</span> if (builder.hasCellCodecClsName()) {<a name="line.199"></a>
<span class="sourceLineNo">200</span> clsName = builder.getCellCodecClsName();<a name="line.200"></a>
<span class="sourceLineNo">201</span> }<a name="line.201"></a>
<span class="sourceLineNo">202</span> return new WALHdrContext(WALHdrResult.SUCCESS, clsName);<a name="line.202"></a>
<span class="sourceLineNo">203</span> }<a name="line.203"></a>
<span class="sourceLineNo">204</span><a name="line.204"></a>
<span class="sourceLineNo">205</span> private String initInternal(FSDataInputStream stream, boolean isFirst)<a name="line.205"></a>
<span class="sourceLineNo">206</span> throws IOException {<a name="line.206"></a>
<span class="sourceLineNo">207</span> close();<a name="line.207"></a>
<span class="sourceLineNo">208</span> long expectedPos = PB_WAL_MAGIC.length;<a name="line.208"></a>
<span class="sourceLineNo">209</span> if (stream == null) {<a name="line.209"></a>
<span class="sourceLineNo">210</span> stream = fs.open(path);<a name="line.210"></a>
<span class="sourceLineNo">211</span> stream.seek(expectedPos);<a name="line.211"></a>
<span class="sourceLineNo">212</span> }<a name="line.212"></a>
<span class="sourceLineNo">213</span> if (stream.getPos() != expectedPos) {<a name="line.213"></a>
<span class="sourceLineNo">214</span> throw new IOException("The stream is at invalid position: " + stream.getPos());<a name="line.214"></a>
<span class="sourceLineNo">215</span> }<a name="line.215"></a>
<span class="sourceLineNo">216</span> // Initialize metadata or, when we reset, just skip the header.<a name="line.216"></a>
<span class="sourceLineNo">217</span> WALProtos.WALHeader.Builder builder = WALProtos.WALHeader.newBuilder();<a name="line.217"></a>
<span class="sourceLineNo">218</span> WALHdrContext hdrCtxt = readHeader(builder, stream);<a name="line.218"></a>
<span class="sourceLineNo">219</span> WALHdrResult walHdrRes = hdrCtxt.getResult();<a name="line.219"></a>
<span class="sourceLineNo">220</span> if (walHdrRes == WALHdrResult.EOF) {<a name="line.220"></a>
<span class="sourceLineNo">221</span> throw new EOFException("Couldn't read WAL PB header");<a name="line.221"></a>
<span class="sourceLineNo">222</span> }<a name="line.222"></a>
<span class="sourceLineNo">223</span> if (walHdrRes == WALHdrResult.UNKNOWN_WRITER_CLS) {<a name="line.223"></a>
<span class="sourceLineNo">224</span> throw new IOException("Got unknown writer class: " + builder.getWriterClsName());<a name="line.224"></a>
<span class="sourceLineNo">225</span> }<a name="line.225"></a>
<span class="sourceLineNo">226</span> if (isFirst) {<a name="line.226"></a>
<span class="sourceLineNo">227</span> WALProtos.WALHeader header = builder.build();<a name="line.227"></a>
<span class="sourceLineNo">228</span> this.hasCompression = header.hasHasCompression() &amp;&amp; header.getHasCompression();<a name="line.228"></a>
<span class="sourceLineNo">229</span> this.hasTagCompression = header.hasHasTagCompression() &amp;&amp; header.getHasTagCompression();<a name="line.229"></a>
<span class="sourceLineNo">230</span> }<a name="line.230"></a>
<span class="sourceLineNo">231</span> this.inputStream = stream;<a name="line.231"></a>
<span class="sourceLineNo">232</span> this.walEditsStopOffset = this.fileLength;<a name="line.232"></a>
<span class="sourceLineNo">233</span> long currentPosition = stream.getPos();<a name="line.233"></a>
<span class="sourceLineNo">234</span> trailerPresent = setTrailerIfPresent();<a name="line.234"></a>
<span class="sourceLineNo">235</span> this.seekOnFs(currentPosition);<a name="line.235"></a>
<span class="sourceLineNo">236</span> if (LOG.isTraceEnabled()) {<a name="line.236"></a>
<span class="sourceLineNo">237</span> LOG.trace("After reading the trailer: walEditsStopOffset: " + this.walEditsStopOffset<a name="line.237"></a>
<span class="sourceLineNo">238</span> + ", fileLength: " + this.fileLength + ", " + "trailerPresent: " + (trailerPresent ? "true, size: " + trailer.getSerializedSize() : "false") + ", currentPosition: " + currentPosition);<a name="line.238"></a>
<span class="sourceLineNo">239</span> }<a name="line.239"></a>
<span class="sourceLineNo">240</span> <a name="line.240"></a>
<span class="sourceLineNo">241</span> codecClsName = hdrCtxt.getCellCodecClsName();<a name="line.241"></a>
<span class="sourceLineNo">242</span> <a name="line.242"></a>
<span class="sourceLineNo">243</span> return hdrCtxt.getCellCodecClsName();<a name="line.243"></a>
<span class="sourceLineNo">244</span> }<a name="line.244"></a>
<span class="sourceLineNo">245</span><a name="line.245"></a>
<span class="sourceLineNo">246</span> /**<a name="line.246"></a>
<span class="sourceLineNo">247</span> * To check whether a trailer is present in a WAL, it seeks to position (fileLength -<a name="line.247"></a>
<span class="sourceLineNo">248</span> * PB_WAL_COMPLETE_MAGIC.size() - Bytes.SIZEOF_INT). It reads the int value to know the size of<a name="line.248"></a>
<span class="sourceLineNo">249</span> * the trailer, and checks whether the trailer is present at the end or not by comparing the last<a name="line.249"></a>
<span class="sourceLineNo">250</span> * PB_WAL_COMPLETE_MAGIC.size() bytes. In case trailer is not present, it returns false;<a name="line.250"></a>
<span class="sourceLineNo">251</span> * otherwise, sets the trailer and sets this.walEditsStopOffset variable up to the point just<a name="line.251"></a>
<span class="sourceLineNo">252</span> * before the trailer.<a name="line.252"></a>
<span class="sourceLineNo">253</span> * &lt;ul&gt;<a name="line.253"></a>
<span class="sourceLineNo">254</span> * The trailer is ignored in case:<a name="line.254"></a>
<span class="sourceLineNo">255</span> * &lt;li&gt;fileLength is 0 or not correct (when file is under recovery, etc).<a name="line.255"></a>
<span class="sourceLineNo">256</span> * &lt;li&gt;the trailer size is negative.<a name="line.256"></a>
<span class="sourceLineNo">257</span> * &lt;/ul&gt;<a name="line.257"></a>
<span class="sourceLineNo">258</span> * &lt;p&gt;<a name="line.258"></a>
<span class="sourceLineNo">259</span> * In case the trailer size &gt; this.trailerMaxSize, it is read after a WARN message.<a name="line.259"></a>
<span class="sourceLineNo">260</span> * @return true if a valid trailer is present<a name="line.260"></a>
<span class="sourceLineNo">261</span> * @throws IOException<a name="line.261"></a>
<span class="sourceLineNo">262</span> */<a name="line.262"></a>
<span class="sourceLineNo">263</span> private boolean setTrailerIfPresent() {<a name="line.263"></a>
<span class="sourceLineNo">264</span> try {<a name="line.264"></a>
<span class="sourceLineNo">265</span> long trailerSizeOffset = this.fileLength - (PB_WAL_COMPLETE_MAGIC.length + Bytes.SIZEOF_INT);<a name="line.265"></a>
<span class="sourceLineNo">266</span> if (trailerSizeOffset &lt;= 0) return false;// no trailer possible.<a name="line.266"></a>
<span class="sourceLineNo">267</span> this.seekOnFs(trailerSizeOffset);<a name="line.267"></a>
<span class="sourceLineNo">268</span> // read the int as trailer size.<a name="line.268"></a>
<span class="sourceLineNo">269</span> int trailerSize = this.inputStream.readInt();<a name="line.269"></a>
<span class="sourceLineNo">270</span> ByteBuffer buf = ByteBuffer.allocate(ProtobufLogReader.PB_WAL_COMPLETE_MAGIC.length);<a name="line.270"></a>
<span class="sourceLineNo">271</span> this.inputStream.readFully(buf.array(), buf.arrayOffset(), buf.capacity());<a name="line.271"></a>
<span class="sourceLineNo">272</span> if (!Arrays.equals(buf.array(), PB_WAL_COMPLETE_MAGIC)) {<a name="line.272"></a>
<span class="sourceLineNo">273</span> LOG.trace("No trailer found.");<a name="line.273"></a>
<span class="sourceLineNo">274</span> return false;<a name="line.274"></a>
<span class="sourceLineNo">275</span> }<a name="line.275"></a>
<span class="sourceLineNo">276</span> if (trailerSize &lt; 0) {<a name="line.276"></a>
<span class="sourceLineNo">277</span> LOG.warn("Invalid trailer Size " + trailerSize + ", ignoring the trailer");<a name="line.277"></a>
<span class="sourceLineNo">278</span> return false;<a name="line.278"></a>
<span class="sourceLineNo">279</span> } else if (trailerSize &gt; this.trailerWarnSize) {<a name="line.279"></a>
<span class="sourceLineNo">280</span> // continue reading after warning the user.<a name="line.280"></a>
<span class="sourceLineNo">281</span> LOG.warn("Please investigate WALTrailer usage. Trailer size &gt; maximum configured size : "<a name="line.281"></a>
<span class="sourceLineNo">282</span> + trailerSize + " &gt; " + this.trailerWarnSize);<a name="line.282"></a>
<span class="sourceLineNo">283</span> }<a name="line.283"></a>
<span class="sourceLineNo">284</span> // seek to the position where trailer starts.<a name="line.284"></a>
<span class="sourceLineNo">285</span> long positionOfTrailer = trailerSizeOffset - trailerSize;<a name="line.285"></a>
<span class="sourceLineNo">286</span> this.seekOnFs(positionOfTrailer);<a name="line.286"></a>
<span class="sourceLineNo">287</span> // read the trailer.<a name="line.287"></a>
<span class="sourceLineNo">288</span> buf = ByteBuffer.allocate(trailerSize);// for trailer.<a name="line.288"></a>
<span class="sourceLineNo">289</span> this.inputStream.readFully(buf.array(), buf.arrayOffset(), buf.capacity());<a name="line.289"></a>
<span class="sourceLineNo">290</span> trailer = WALTrailer.parseFrom(buf.array());<a name="line.290"></a>
<span class="sourceLineNo">291</span> this.walEditsStopOffset = positionOfTrailer;<a name="line.291"></a>
<span class="sourceLineNo">292</span> return true;<a name="line.292"></a>
<span class="sourceLineNo">293</span> } catch (IOException ioe) {<a name="line.293"></a>
<span class="sourceLineNo">294</span> LOG.warn("Got IOE while reading the trailer. Continuing as if no trailer is present.", ioe);<a name="line.294"></a>
<span class="sourceLineNo">295</span> }<a name="line.295"></a>
<span class="sourceLineNo">296</span> return false;<a name="line.296"></a>
<span class="sourceLineNo">297</span> }<a name="line.297"></a>
<span class="sourceLineNo">298</span><a name="line.298"></a>
<span class="sourceLineNo">299</span> protected WALCellCodec getCodec(Configuration conf, String cellCodecClsName,<a name="line.299"></a>
<span class="sourceLineNo">300</span> CompressionContext compressionContext) throws IOException {<a name="line.300"></a>
<span class="sourceLineNo">301</span> return WALCellCodec.create(conf, cellCodecClsName, compressionContext);<a name="line.301"></a>
<span class="sourceLineNo">302</span> }<a name="line.302"></a>
<span class="sourceLineNo">303</span><a name="line.303"></a>
<span class="sourceLineNo">304</span> @Override<a name="line.304"></a>
<span class="sourceLineNo">305</span> protected void initAfterCompression() throws IOException {<a name="line.305"></a>
<span class="sourceLineNo">306</span> initAfterCompression(null);<a name="line.306"></a>
<span class="sourceLineNo">307</span> }<a name="line.307"></a>
<span class="sourceLineNo">308</span> <a name="line.308"></a>
<span class="sourceLineNo">309</span> @Override<a name="line.309"></a>
<span class="sourceLineNo">310</span> protected void initAfterCompression(String cellCodecClsName) throws IOException {<a name="line.310"></a>
<span class="sourceLineNo">311</span> WALCellCodec codec = getCodec(this.conf, cellCodecClsName, this.compressionContext);<a name="line.311"></a>
<span class="sourceLineNo">312</span> this.cellDecoder = codec.getDecoder(this.inputStream);<a name="line.312"></a>
<span class="sourceLineNo">313</span> if (this.hasCompression) {<a name="line.313"></a>
<span class="sourceLineNo">314</span> this.byteStringUncompressor = codec.getByteStringUncompressor();<a name="line.314"></a>
<span class="sourceLineNo">315</span> } else {<a name="line.315"></a>
<span class="sourceLineNo">316</span> this.byteStringUncompressor = WALCellCodec.getNoneUncompressor();<a name="line.316"></a>
<span class="sourceLineNo">317</span> }<a name="line.317"></a>
<span class="sourceLineNo">318</span> }<a name="line.318"></a>
<span class="sourceLineNo">319</span><a name="line.319"></a>
<span class="sourceLineNo">320</span> @Override<a name="line.320"></a>
<span class="sourceLineNo">321</span> protected boolean hasCompression() {<a name="line.321"></a>
<span class="sourceLineNo">322</span> return this.hasCompression;<a name="line.322"></a>
<span class="sourceLineNo">323</span> }<a name="line.323"></a>
<span class="sourceLineNo">324</span><a name="line.324"></a>
<span class="sourceLineNo">325</span> @Override<a name="line.325"></a>
<span class="sourceLineNo">326</span> protected boolean hasTagCompression() {<a name="line.326"></a>
<span class="sourceLineNo">327</span> return this.hasTagCompression;<a name="line.327"></a>
<span class="sourceLineNo">328</span> }<a name="line.328"></a>
<span class="sourceLineNo">329</span><a name="line.329"></a>
<span class="sourceLineNo">330</span> @Override<a name="line.330"></a>
<span class="sourceLineNo">331</span> protected boolean readNext(Entry entry) throws IOException {<a name="line.331"></a>
<span class="sourceLineNo">332</span> // OriginalPosition might be &lt; 0 on local fs; if so, it is useless to us.<a name="line.332"></a>
<span class="sourceLineNo">333</span> long originalPosition = this.inputStream.getPos();<a name="line.333"></a>
<span class="sourceLineNo">334</span> if (trailerPresent &amp;&amp; originalPosition &gt; 0 &amp;&amp; originalPosition == this.walEditsStopOffset) {<a name="line.334"></a>
<span class="sourceLineNo">335</span> LOG.trace("Reached end of expected edits area at offset {}", originalPosition);<a name="line.335"></a>
<span class="sourceLineNo">336</span> return false;<a name="line.336"></a>
<span class="sourceLineNo">337</span> }<a name="line.337"></a>
<span class="sourceLineNo">338</span> WALKey.Builder builder = WALKey.newBuilder();<a name="line.338"></a>
<span class="sourceLineNo">339</span> long size = 0;<a name="line.339"></a>
<span class="sourceLineNo">340</span> boolean resetPosition = false;<a name="line.340"></a>
<span class="sourceLineNo">341</span> try {<a name="line.341"></a>
<span class="sourceLineNo">342</span> long available = -1;<a name="line.342"></a>
<span class="sourceLineNo">343</span> try {<a name="line.343"></a>
<span class="sourceLineNo">344</span> int firstByte = this.inputStream.read();<a name="line.344"></a>
<span class="sourceLineNo">345</span> if (firstByte == -1) {<a name="line.345"></a>
<span class="sourceLineNo">346</span> throw new EOFException();<a name="line.346"></a>
<span class="sourceLineNo">347</span> }<a name="line.347"></a>
<span class="sourceLineNo">348</span> size = CodedInputStream.readRawVarint32(firstByte, this.inputStream);<a name="line.348"></a>
<span class="sourceLineNo">349</span> // available may be &lt; 0 on local fs for instance. If so, can't depend on it.<a name="line.349"></a>
<span class="sourceLineNo">350</span> available = this.inputStream.available();<a name="line.350"></a>
<span class="sourceLineNo">351</span> if (available &gt; 0 &amp;&amp; available &lt; size) {<a name="line.351"></a>
<span class="sourceLineNo">352</span> throw new EOFException(<a name="line.352"></a>
<span class="sourceLineNo">353</span> "Available stream not enough for edit, " + "inputStream.available()= "<a name="line.353"></a>
<span class="sourceLineNo">354</span> + this.inputStream.available() + ", " + "entry size= " + size + " at offset = "<a name="line.354"></a>
<span class="sourceLineNo">355</span> + this.inputStream.getPos());<a name="line.355"></a>
<span class="sourceLineNo">356</span> }<a name="line.356"></a>
<span class="sourceLineNo">357</span> ProtobufUtil.mergeFrom(builder, ByteStreams.limit(this.inputStream, size), (int) size);<a name="line.357"></a>
<span class="sourceLineNo">358</span> } catch (InvalidProtocolBufferException ipbe) {<a name="line.358"></a>
<span class="sourceLineNo">359</span> resetPosition = true;<a name="line.359"></a>
<span class="sourceLineNo">360</span> throw (EOFException) new EOFException(<a name="line.360"></a>
<span class="sourceLineNo">361</span> "Invalid PB, EOF? Ignoring; originalPosition=" + originalPosition + ", currentPosition="<a name="line.361"></a>
<span class="sourceLineNo">362</span> + this.inputStream.getPos() + ", messageSize=" + size + ", currentAvailable="<a name="line.362"></a>
<span class="sourceLineNo">363</span> + available).initCause(ipbe);<a name="line.363"></a>
<span class="sourceLineNo">364</span> }<a name="line.364"></a>
<span class="sourceLineNo">365</span> if (!builder.isInitialized()) {<a name="line.365"></a>
<span class="sourceLineNo">366</span> // TODO: not clear if we should try to recover from corrupt PB that looks semi-legit.<a name="line.366"></a>
<span class="sourceLineNo">367</span> // If we can get the KV count, we could, theoretically, try to get next record.<a name="line.367"></a>
<span class="sourceLineNo">368</span> throw new EOFException(<a name="line.368"></a>
<span class="sourceLineNo">369</span> "Partial PB while reading WAL, " + "probably an unexpected EOF, ignoring. current offset="<a name="line.369"></a>
<span class="sourceLineNo">370</span> + this.inputStream.getPos());<a name="line.370"></a>
<span class="sourceLineNo">371</span> }<a name="line.371"></a>
<span class="sourceLineNo">372</span> WALKey walKey = builder.build();<a name="line.372"></a>
<span class="sourceLineNo">373</span> entry.getKey().readFieldsFromPb(walKey, this.byteStringUncompressor);<a name="line.373"></a>
<span class="sourceLineNo">374</span> if (!walKey.hasFollowingKvCount() || 0 == walKey.getFollowingKvCount()) {<a name="line.374"></a>
<span class="sourceLineNo">375</span> LOG.trace("WALKey has no KVs that follow it; trying the next one. current offset={}",<a name="line.375"></a>
<span class="sourceLineNo">376</span> this.inputStream.getPos());<a name="line.376"></a>
<span class="sourceLineNo">377</span> seekOnFs(originalPosition);<a name="line.377"></a>
<span class="sourceLineNo">378</span> return false;<a name="line.378"></a>
<span class="sourceLineNo">379</span> }<a name="line.379"></a>
<span class="sourceLineNo">380</span> int expectedCells = walKey.getFollowingKvCount();<a name="line.380"></a>
<span class="sourceLineNo">381</span> long posBefore = this.inputStream.getPos();<a name="line.381"></a>
<span class="sourceLineNo">382</span> try {<a name="line.382"></a>
<span class="sourceLineNo">383</span> int actualCells = entry.getEdit().readFromCells(cellDecoder, expectedCells);<a name="line.383"></a>
<span class="sourceLineNo">384</span> if (expectedCells != actualCells) {<a name="line.384"></a>
<span class="sourceLineNo">385</span> resetPosition = true;<a name="line.385"></a>
<span class="sourceLineNo">386</span> throw new EOFException("Only read " + actualCells); // other info added in catch<a name="line.386"></a>
<span class="sourceLineNo">387</span> }<a name="line.387"></a>
<span class="sourceLineNo">388</span> } catch (Exception ex) {<a name="line.388"></a>
<span class="sourceLineNo">389</span> String posAfterStr = "&lt;unknown&gt;";<a name="line.389"></a>
<span class="sourceLineNo">390</span> try {<a name="line.390"></a>
<span class="sourceLineNo">391</span> posAfterStr = this.inputStream.getPos() + "";<a name="line.391"></a>
<span class="sourceLineNo">392</span> } catch (Throwable t) {<a name="line.392"></a>
<span class="sourceLineNo">393</span> LOG.trace("Error getting pos for error message - ignoring", t);<a name="line.393"></a>
<span class="sourceLineNo">394</span> }<a name="line.394"></a>
<span class="sourceLineNo">395</span> String message =<a name="line.395"></a>
<span class="sourceLineNo">396</span> " while reading " + expectedCells + " WAL KVs; started reading at " + posBefore<a name="line.396"></a>
<span class="sourceLineNo">397</span> + " and read up to " + posAfterStr;<a name="line.397"></a>
<span class="sourceLineNo">398</span> IOException realEofEx = extractHiddenEof(ex);<a name="line.398"></a>
<span class="sourceLineNo">399</span> throw (EOFException) new EOFException("EOF " + message).<a name="line.399"></a>
<span class="sourceLineNo">400</span> initCause(realEofEx != null ? realEofEx : ex);<a name="line.400"></a>
<span class="sourceLineNo">401</span> }<a name="line.401"></a>
<span class="sourceLineNo">402</span> if (trailerPresent &amp;&amp; this.inputStream.getPos() &gt; this.walEditsStopOffset) {<a name="line.402"></a>
<span class="sourceLineNo">403</span> LOG.error(<a name="line.403"></a>
<span class="sourceLineNo">404</span> "Read WALTrailer while reading WALEdits. wal: " + this.path + ", inputStream.getPos(): "<a name="line.404"></a>
<span class="sourceLineNo">405</span> + this.inputStream.getPos() + ", walEditsStopOffset: " + this.walEditsStopOffset);<a name="line.405"></a>
<span class="sourceLineNo">406</span> throw new EOFException("Read WALTrailer while reading WALEdits");<a name="line.406"></a>
<span class="sourceLineNo">407</span> }<a name="line.407"></a>
<span class="sourceLineNo">408</span> } catch (EOFException eof) {<a name="line.408"></a>
<span class="sourceLineNo">409</span> // If originalPosition is &lt; 0, it is rubbish and we cannot use it (probably local fs)<a name="line.409"></a>
<span class="sourceLineNo">410</span> if (originalPosition &lt; 0) {<a name="line.410"></a>
<span class="sourceLineNo">411</span> LOG.warn("Encountered a malformed edit, but can't seek back to last good position "<a name="line.411"></a>
<span class="sourceLineNo">412</span> + "because originalPosition is negative. last offset={}", this.inputStream.getPos(), eof);<a name="line.412"></a>
<span class="sourceLineNo">413</span> throw eof;<a name="line.413"></a>
<span class="sourceLineNo">414</span> }<a name="line.414"></a>
<span class="sourceLineNo">415</span> // If stuck at the same place and we got an exception, lets go back at the beginning.<a name="line.415"></a>
<span class="sourceLineNo">416</span> if (inputStream.getPos() == originalPosition) {<a name="line.416"></a>
<span class="sourceLineNo">417</span> if (resetPosition) {<a name="line.417"></a>
<span class="sourceLineNo">418</span> LOG.warn("Encountered a malformed edit, seeking to the beginning of the WAL since "<a name="line.418"></a>
<span class="sourceLineNo">419</span> + "current position and original position match at {}", originalPosition);<a name="line.419"></a>
<span class="sourceLineNo">420</span> seekOnFs(0);<a name="line.420"></a>
<span class="sourceLineNo">421</span> } else {<a name="line.421"></a>
<span class="sourceLineNo">422</span> LOG.debug("EOF at position {}", originalPosition);<a name="line.422"></a>
<span class="sourceLineNo">423</span> }<a name="line.423"></a>
<span class="sourceLineNo">424</span> } else {<a name="line.424"></a>
<span class="sourceLineNo">425</span> // Else restore our position to original location in hope that next time through we will<a name="line.425"></a>
<span class="sourceLineNo">426</span> // read successfully.<a name="line.426"></a>
<span class="sourceLineNo">427</span> LOG.warn("Encountered a malformed edit, seeking back to last good position in file, "<a name="line.427"></a>
<span class="sourceLineNo">428</span> + "from {} to {}", inputStream.getPos(), originalPosition, eof);<a name="line.428"></a>
<span class="sourceLineNo">429</span> seekOnFs(originalPosition);<a name="line.429"></a>
<span class="sourceLineNo">430</span> }<a name="line.430"></a>
<span class="sourceLineNo">431</span> return false;<a name="line.431"></a>
<span class="sourceLineNo">432</span> }<a name="line.432"></a>
<span class="sourceLineNo">433</span> return true;<a name="line.433"></a>
<span class="sourceLineNo">434</span> }<a name="line.434"></a>
<span class="sourceLineNo">435</span><a name="line.435"></a>
<span class="sourceLineNo">436</span> private IOException extractHiddenEof(Exception ex) {<a name="line.436"></a>
<span class="sourceLineNo">437</span> // There are two problems we are dealing with here. Hadoop stream throws generic exception<a name="line.437"></a>
<span class="sourceLineNo">438</span> // for EOF, not EOFException; and scanner further hides it inside RuntimeException.<a name="line.438"></a>
<span class="sourceLineNo">439</span> IOException ioEx = null;<a name="line.439"></a>
<span class="sourceLineNo">440</span> if (ex instanceof EOFException) {<a name="line.440"></a>
<span class="sourceLineNo">441</span> return (EOFException)ex;<a name="line.441"></a>
<span class="sourceLineNo">442</span> } else if (ex instanceof IOException) {<a name="line.442"></a>
<span class="sourceLineNo">443</span> ioEx = (IOException)ex;<a name="line.443"></a>
<span class="sourceLineNo">444</span> } else if (ex instanceof RuntimeException<a name="line.444"></a>
<span class="sourceLineNo">445</span> &amp;&amp; ex.getCause() != null &amp;&amp; ex.getCause() instanceof IOException) {<a name="line.445"></a>
<span class="sourceLineNo">446</span> ioEx = (IOException)ex.getCause();<a name="line.446"></a>
<span class="sourceLineNo">447</span> }<a name="line.447"></a>
<span class="sourceLineNo">448</span> if ((ioEx != null) &amp;&amp; (ioEx.getMessage() != null)) {<a name="line.448"></a>
<span class="sourceLineNo">449</span> if (ioEx.getMessage().contains("EOF")) return ioEx;<a name="line.449"></a>
<span class="sourceLineNo">450</span> return null;<a name="line.450"></a>
<span class="sourceLineNo">451</span> }<a name="line.451"></a>
<span class="sourceLineNo">452</span> return null;<a name="line.452"></a>
<span class="sourceLineNo">453</span> }<a name="line.453"></a>
<span class="sourceLineNo">454</span><a name="line.454"></a>
<span class="sourceLineNo">455</span> @Override<a name="line.455"></a>
<span class="sourceLineNo">456</span> protected void seekOnFs(long pos) throws IOException {<a name="line.456"></a>
<span class="sourceLineNo">457</span> this.inputStream.seek(pos);<a name="line.457"></a>
<span class="sourceLineNo">458</span> }<a name="line.458"></a>
<span class="sourceLineNo">459</span>}<a name="line.459"></a>
</pre>
</div>
</body>
</html>