| <!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, class: FSDataInputStreamWrapper, class: ReadStatistics"> |
| <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;</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.Closeable;</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.util.concurrent.atomic.AtomicInteger;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.fs.FSDataInputStream;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.fs.FileSystem;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.fs.Path;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.fs.HFileSystem;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hdfs.client.HdfsDataInputStream;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">029</span><span id="line-29"></span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hbase.thirdparty.com.google.common.io.Closeables;</span> |
| <span class="source-line-no">031</span><span id="line-31"></span> |
| <span class="source-line-no">032</span><span id="line-32">/**</span> |
| <span class="source-line-no">033</span><span id="line-33"> * Wrapper for input stream(s) that takes care of the interaction of FS and HBase checksums, as well</span> |
| <span class="source-line-no">034</span><span id="line-34"> * as closing streams. Initialization is not thread-safe, but normal operation is; see method</span> |
| <span class="source-line-no">035</span><span id="line-35"> * comments.</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 FSDataInputStreamWrapper implements Closeable {</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 final HFileSystem hfs;</span> |
| <span class="source-line-no">041</span><span id="line-41"> private final Path path;</span> |
| <span class="source-line-no">042</span><span id="line-42"> private final FileLink link;</span> |
| <span class="source-line-no">043</span><span id="line-43"> private final boolean doCloseStreams;</span> |
| <span class="source-line-no">044</span><span id="line-44"> private final boolean dropBehind;</span> |
| <span class="source-line-no">045</span><span id="line-45"> private final long readahead;</span> |
| <span class="source-line-no">046</span><span id="line-46"></span> |
| <span class="source-line-no">047</span><span id="line-47"> /**</span> |
| <span class="source-line-no">048</span><span id="line-48"> * Two stream handles, one with and one without FS-level checksum. HDFS checksum setting is on FS</span> |
| <span class="source-line-no">049</span><span id="line-49"> * level, not single read level, so you have to keep two FS objects and two handles open to</span> |
| <span class="source-line-no">050</span><span id="line-50"> * interleave different reads freely, which is very sad. This is what we do: 1) First, we need to</span> |
| <span class="source-line-no">051</span><span id="line-51"> * read the trailer of HFile to determine checksum parameters. We always use FS checksum to do</span> |
| <span class="source-line-no">052</span><span id="line-52"> * that, so ctor opens {@link #stream}. 2.1) After that, if HBase checksum is not used, we'd just</span> |
| <span class="source-line-no">053</span><span id="line-53"> * always use {@link #stream}; 2.2) If HBase checksum can be used, we'll open</span> |
| <span class="source-line-no">054</span><span id="line-54"> * {@link #streamNoFsChecksum}, and close {@link #stream}. User MUST call prepareForBlockReader</span> |
| <span class="source-line-no">055</span><span id="line-55"> * for that to happen; if they don't, (2.1) will be the default. 3) The users can call</span> |
| <span class="source-line-no">056</span><span id="line-56"> * {@link #shouldUseHBaseChecksum()}, and pass its result to {@link #getStream(boolean)} to get</span> |
| <span class="source-line-no">057</span><span id="line-57"> * stream (if Java had out/pointer params we could return both in one call). This stream is</span> |
| <span class="source-line-no">058</span><span id="line-58"> * guaranteed to be set. 4) The first time HBase checksum fails, one would call</span> |
| <span class="source-line-no">059</span><span id="line-59"> * {@link #fallbackToFsChecksum(int)}. That will take lock, and open {@link #stream}. While this</span> |
| <span class="source-line-no">060</span><span id="line-60"> * is going on, others will continue to use the old stream; if they also want to fall back,</span> |
| <span class="source-line-no">061</span><span id="line-61"> * they'll also call {@link #fallbackToFsChecksum(int)}, and block until {@link #stream} is set.</span> |
| <span class="source-line-no">062</span><span id="line-62"> * 5) After some number of checksumOk() calls, we will go back to using HBase checksum. We will</span> |
| <span class="source-line-no">063</span><span id="line-63"> * have 2 handles; however we presume checksums fail so rarely that we don't care.</span> |
| <span class="source-line-no">064</span><span id="line-64"> */</span> |
| <span class="source-line-no">065</span><span id="line-65"> private volatile FSDataInputStream stream = null;</span> |
| <span class="source-line-no">066</span><span id="line-66"> private volatile FSDataInputStream streamNoFsChecksum = null;</span> |
| <span class="source-line-no">067</span><span id="line-67"> private final Object streamNoFsChecksumFirstCreateLock = new Object();</span> |
| <span class="source-line-no">068</span><span id="line-68"></span> |
| <span class="source-line-no">069</span><span id="line-69"> // The configuration states that we should validate hbase checksums</span> |
| <span class="source-line-no">070</span><span id="line-70"> private boolean useHBaseChecksumConfigured;</span> |
| <span class="source-line-no">071</span><span id="line-71"></span> |
| <span class="source-line-no">072</span><span id="line-72"> // Record the current state of this reader with respect to</span> |
| <span class="source-line-no">073</span><span id="line-73"> // validating checkums in HBase. This is originally set the same</span> |
| <span class="source-line-no">074</span><span id="line-74"> // value as useHBaseChecksumConfigured, but can change state as and when</span> |
| <span class="source-line-no">075</span><span id="line-75"> // we encounter checksum verification failures.</span> |
| <span class="source-line-no">076</span><span id="line-76"> private volatile boolean useHBaseChecksum;</span> |
| <span class="source-line-no">077</span><span id="line-77"></span> |
| <span class="source-line-no">078</span><span id="line-78"> // In the case of a checksum failure, do these many succeeding</span> |
| <span class="source-line-no">079</span><span id="line-79"> // reads without hbase checksum verification.</span> |
| <span class="source-line-no">080</span><span id="line-80"> private AtomicInteger hbaseChecksumOffCount = new AtomicInteger(-1);</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 final static ReadStatistics readStatistics = new ReadStatistics();</span> |
| <span class="source-line-no">083</span><span id="line-83"></span> |
| <span class="source-line-no">084</span><span id="line-84"> private static class ReadStatistics {</span> |
| <span class="source-line-no">085</span><span id="line-85"> long totalBytesRead;</span> |
| <span class="source-line-no">086</span><span id="line-86"> long totalLocalBytesRead;</span> |
| <span class="source-line-no">087</span><span id="line-87"> long totalShortCircuitBytesRead;</span> |
| <span class="source-line-no">088</span><span id="line-88"> long totalZeroCopyBytesRead;</span> |
| <span class="source-line-no">089</span><span id="line-89"> }</span> |
| <span class="source-line-no">090</span><span id="line-90"></span> |
| <span class="source-line-no">091</span><span id="line-91"> protected Path readerPath;</span> |
| <span class="source-line-no">092</span><span id="line-92"></span> |
| <span class="source-line-no">093</span><span id="line-93"> public FSDataInputStreamWrapper(FileSystem fs, Path path) throws IOException {</span> |
| <span class="source-line-no">094</span><span id="line-94"> this(fs, path, false, -1L);</span> |
| <span class="source-line-no">095</span><span id="line-95"> }</span> |
| <span class="source-line-no">096</span><span id="line-96"></span> |
| <span class="source-line-no">097</span><span id="line-97"> public FSDataInputStreamWrapper(FileSystem fs, Path path, boolean dropBehind, long readahead)</span> |
| <span class="source-line-no">098</span><span id="line-98"> throws IOException {</span> |
| <span class="source-line-no">099</span><span id="line-99"> this(fs, null, path, dropBehind, readahead);</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"> public FSDataInputStreamWrapper(FileSystem fs, FileLink link, boolean dropBehind, long readahead)</span> |
| <span class="source-line-no">103</span><span id="line-103"> throws IOException {</span> |
| <span class="source-line-no">104</span><span id="line-104"> this(fs, link, null, dropBehind, readahead);</span> |
| <span class="source-line-no">105</span><span id="line-105"> }</span> |
| <span class="source-line-no">106</span><span id="line-106"></span> |
| <span class="source-line-no">107</span><span id="line-107"> private FSDataInputStreamWrapper(FileSystem fs, FileLink link, Path path, boolean dropBehind,</span> |
| <span class="source-line-no">108</span><span id="line-108"> long readahead) throws IOException {</span> |
| <span class="source-line-no">109</span><span id="line-109"> assert (path == null) != (link == null);</span> |
| <span class="source-line-no">110</span><span id="line-110"> this.path = path;</span> |
| <span class="source-line-no">111</span><span id="line-111"> this.link = link;</span> |
| <span class="source-line-no">112</span><span id="line-112"> this.doCloseStreams = true;</span> |
| <span class="source-line-no">113</span><span id="line-113"> this.dropBehind = dropBehind;</span> |
| <span class="source-line-no">114</span><span id="line-114"> this.readahead = readahead;</span> |
| <span class="source-line-no">115</span><span id="line-115"> // If the fs is not an instance of HFileSystem, then create an instance of HFileSystem</span> |
| <span class="source-line-no">116</span><span id="line-116"> // that wraps over the specified fs. In this case, we will not be able to avoid</span> |
| <span class="source-line-no">117</span><span id="line-117"> // checksumming inside the filesystem.</span> |
| <span class="source-line-no">118</span><span id="line-118"> this.hfs = (fs instanceof HFileSystem) ? (HFileSystem) fs : new HFileSystem(fs);</span> |
| <span class="source-line-no">119</span><span id="line-119"></span> |
| <span class="source-line-no">120</span><span id="line-120"> // Initially we are going to read the tail block. Open the reader w/FS checksum.</span> |
| <span class="source-line-no">121</span><span id="line-121"> this.useHBaseChecksumConfigured = this.useHBaseChecksum = false;</span> |
| <span class="source-line-no">122</span><span id="line-122"> this.stream = (link != null) ? link.open(hfs) : hfs.open(path);</span> |
| <span class="source-line-no">123</span><span id="line-123"> this.readerPath = this.stream.getWrappedStream() instanceof FileLink.FileLinkInputStream</span> |
| <span class="source-line-no">124</span><span id="line-124"> ? ((FileLink.FileLinkInputStream) this.stream.getWrappedStream()).getCurrentPath()</span> |
| <span class="source-line-no">125</span><span id="line-125"> : path;</span> |
| <span class="source-line-no">126</span><span id="line-126"> setStreamOptions(stream);</span> |
| <span class="source-line-no">127</span><span id="line-127"> }</span> |
| <span class="source-line-no">128</span><span id="line-128"></span> |
| <span class="source-line-no">129</span><span id="line-129"> private void setStreamOptions(FSDataInputStream in) {</span> |
| <span class="source-line-no">130</span><span id="line-130"> try {</span> |
| <span class="source-line-no">131</span><span id="line-131"> in.setDropBehind(dropBehind);</span> |
| <span class="source-line-no">132</span><span id="line-132"> } catch (Exception e) {</span> |
| <span class="source-line-no">133</span><span id="line-133"> // Skipped.</span> |
| <span class="source-line-no">134</span><span id="line-134"> }</span> |
| <span class="source-line-no">135</span><span id="line-135"> if (readahead >= 0) {</span> |
| <span class="source-line-no">136</span><span id="line-136"> try {</span> |
| <span class="source-line-no">137</span><span id="line-137"> in.setReadahead(readahead);</span> |
| <span class="source-line-no">138</span><span id="line-138"> } catch (Exception e) {</span> |
| <span class="source-line-no">139</span><span id="line-139"> // Skipped.</span> |
| <span class="source-line-no">140</span><span id="line-140"> }</span> |
| <span class="source-line-no">141</span><span id="line-141"> }</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"> * Prepares the streams for block reader. NOT THREAD SAFE. Must be called once, after any reads</span> |
| <span class="source-line-no">146</span><span id="line-146"> * finish and before any other reads start (what happens in reality is we read the tail, then call</span> |
| <span class="source-line-no">147</span><span id="line-147"> * this based on what's in the tail, then read blocks).</span> |
| <span class="source-line-no">148</span><span id="line-148"> * @param forceNoHBaseChecksum Force not using HBase checksum.</span> |
| <span class="source-line-no">149</span><span id="line-149"> */</span> |
| <span class="source-line-no">150</span><span id="line-150"> public void prepareForBlockReader(boolean forceNoHBaseChecksum) throws IOException {</span> |
| <span class="source-line-no">151</span><span id="line-151"> if (hfs == null) return;</span> |
| <span class="source-line-no">152</span><span id="line-152"> assert this.stream != null && !this.useHBaseChecksumConfigured;</span> |
| <span class="source-line-no">153</span><span id="line-153"> boolean useHBaseChecksum =</span> |
| <span class="source-line-no">154</span><span id="line-154"> !forceNoHBaseChecksum && hfs.useHBaseChecksum() && (hfs.getNoChecksumFs() != hfs);</span> |
| <span class="source-line-no">155</span><span id="line-155"></span> |
| <span class="source-line-no">156</span><span id="line-156"> if (useHBaseChecksum) {</span> |
| <span class="source-line-no">157</span><span id="line-157"> FileSystem fsNc = hfs.getNoChecksumFs();</span> |
| <span class="source-line-no">158</span><span id="line-158"> this.streamNoFsChecksum = (link != null) ? link.open(fsNc) : fsNc.open(path);</span> |
| <span class="source-line-no">159</span><span id="line-159"> setStreamOptions(streamNoFsChecksum);</span> |
| <span class="source-line-no">160</span><span id="line-160"> this.useHBaseChecksumConfigured = this.useHBaseChecksum = useHBaseChecksum;</span> |
| <span class="source-line-no">161</span><span id="line-161"> // Close the checksum stream; we will reopen it if we get an HBase checksum failure.</span> |
| <span class="source-line-no">162</span><span id="line-162"> this.stream.close();</span> |
| <span class="source-line-no">163</span><span id="line-163"> this.stream = null;</span> |
| <span class="source-line-no">164</span><span id="line-164"> }</span> |
| <span class="source-line-no">165</span><span id="line-165"> }</span> |
| <span class="source-line-no">166</span><span id="line-166"></span> |
| <span class="source-line-no">167</span><span id="line-167"> /** For use in tests. */</span> |
| <span class="source-line-no">168</span><span id="line-168"> public FSDataInputStreamWrapper(FSDataInputStream fsdis) {</span> |
| <span class="source-line-no">169</span><span id="line-169"> this(fsdis, fsdis);</span> |
| <span class="source-line-no">170</span><span id="line-170"> }</span> |
| <span class="source-line-no">171</span><span id="line-171"></span> |
| <span class="source-line-no">172</span><span id="line-172"> /** For use in tests. */</span> |
| <span class="source-line-no">173</span><span id="line-173"> public FSDataInputStreamWrapper(FSDataInputStream fsdis, FSDataInputStream noChecksum) {</span> |
| <span class="source-line-no">174</span><span id="line-174"> doCloseStreams = false;</span> |
| <span class="source-line-no">175</span><span id="line-175"> stream = fsdis;</span> |
| <span class="source-line-no">176</span><span id="line-176"> streamNoFsChecksum = noChecksum;</span> |
| <span class="source-line-no">177</span><span id="line-177"> path = null;</span> |
| <span class="source-line-no">178</span><span id="line-178"> link = null;</span> |
| <span class="source-line-no">179</span><span id="line-179"> hfs = null;</span> |
| <span class="source-line-no">180</span><span id="line-180"> useHBaseChecksumConfigured = useHBaseChecksum = false;</span> |
| <span class="source-line-no">181</span><span id="line-181"> dropBehind = false;</span> |
| <span class="source-line-no">182</span><span id="line-182"> readahead = 0;</span> |
| <span class="source-line-no">183</span><span id="line-183"> }</span> |
| <span class="source-line-no">184</span><span id="line-184"></span> |
| <span class="source-line-no">185</span><span id="line-185"> /** Returns Whether we are presently using HBase checksum. */</span> |
| <span class="source-line-no">186</span><span id="line-186"> public boolean shouldUseHBaseChecksum() {</span> |
| <span class="source-line-no">187</span><span id="line-187"> return this.useHBaseChecksum;</span> |
| <span class="source-line-no">188</span><span id="line-188"> }</span> |
| <span class="source-line-no">189</span><span id="line-189"></span> |
| <span class="source-line-no">190</span><span id="line-190"> /**</span> |
| <span class="source-line-no">191</span><span id="line-191"> * Get the stream to use. Thread-safe.</span> |
| <span class="source-line-no">192</span><span id="line-192"> * @param useHBaseChecksum must be the value that shouldUseHBaseChecksum has returned at some</span> |
| <span class="source-line-no">193</span><span id="line-193"> * point in the past, otherwise the result is undefined.</span> |
| <span class="source-line-no">194</span><span id="line-194"> */</span> |
| <span class="source-line-no">195</span><span id="line-195"> public FSDataInputStream getStream(boolean useHBaseChecksum) {</span> |
| <span class="source-line-no">196</span><span id="line-196"> return useHBaseChecksum ? this.streamNoFsChecksum : this.stream;</span> |
| <span class="source-line-no">197</span><span id="line-197"> }</span> |
| <span class="source-line-no">198</span><span id="line-198"></span> |
| <span class="source-line-no">199</span><span id="line-199"> /**</span> |
| <span class="source-line-no">200</span><span id="line-200"> * Read from non-checksum stream failed, fall back to FS checksum. Thread-safe.</span> |
| <span class="source-line-no">201</span><span id="line-201"> * @param offCount For how many checksumOk calls to turn off the HBase checksum.</span> |
| <span class="source-line-no">202</span><span id="line-202"> */</span> |
| <span class="source-line-no">203</span><span id="line-203"> public FSDataInputStream fallbackToFsChecksum(int offCount) throws IOException {</span> |
| <span class="source-line-no">204</span><span id="line-204"> // checksumOffCount is speculative, but let's try to reset it less.</span> |
| <span class="source-line-no">205</span><span id="line-205"> boolean partOfConvoy = false;</span> |
| <span class="source-line-no">206</span><span id="line-206"> if (this.stream == null) {</span> |
| <span class="source-line-no">207</span><span id="line-207"> synchronized (streamNoFsChecksumFirstCreateLock) {</span> |
| <span class="source-line-no">208</span><span id="line-208"> partOfConvoy = (this.stream != null);</span> |
| <span class="source-line-no">209</span><span id="line-209"> if (!partOfConvoy) {</span> |
| <span class="source-line-no">210</span><span id="line-210"> this.stream = (link != null) ? link.open(hfs) : hfs.open(path);</span> |
| <span class="source-line-no">211</span><span id="line-211"> }</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"> if (!partOfConvoy) {</span> |
| <span class="source-line-no">215</span><span id="line-215"> this.useHBaseChecksum = false;</span> |
| <span class="source-line-no">216</span><span id="line-216"> this.hbaseChecksumOffCount.set(offCount);</span> |
| <span class="source-line-no">217</span><span id="line-217"> }</span> |
| <span class="source-line-no">218</span><span id="line-218"> return this.stream;</span> |
| <span class="source-line-no">219</span><span id="line-219"> }</span> |
| <span class="source-line-no">220</span><span id="line-220"></span> |
| <span class="source-line-no">221</span><span id="line-221"> /** Report that checksum was ok, so we may ponder going back to HBase checksum. */</span> |
| <span class="source-line-no">222</span><span id="line-222"> public void checksumOk() {</span> |
| <span class="source-line-no">223</span><span id="line-223"> if (</span> |
| <span class="source-line-no">224</span><span id="line-224"> this.useHBaseChecksumConfigured && !this.useHBaseChecksum</span> |
| <span class="source-line-no">225</span><span id="line-225"> && (this.hbaseChecksumOffCount.getAndDecrement() < 0)</span> |
| <span class="source-line-no">226</span><span id="line-226"> ) {</span> |
| <span class="source-line-no">227</span><span id="line-227"> // The stream we need is already open (because we were using HBase checksum in the past).</span> |
| <span class="source-line-no">228</span><span id="line-228"> assert this.streamNoFsChecksum != null;</span> |
| <span class="source-line-no">229</span><span id="line-229"> this.useHBaseChecksum = true;</span> |
| <span class="source-line-no">230</span><span id="line-230"> }</span> |
| <span class="source-line-no">231</span><span id="line-231"> }</span> |
| <span class="source-line-no">232</span><span id="line-232"></span> |
| <span class="source-line-no">233</span><span id="line-233"> private void updateInputStreamStatistics(FSDataInputStream stream) {</span> |
| <span class="source-line-no">234</span><span id="line-234"> // If the underlying file system is HDFS, update read statistics upon close.</span> |
| <span class="source-line-no">235</span><span id="line-235"> if (stream instanceof HdfsDataInputStream) {</span> |
| <span class="source-line-no">236</span><span id="line-236"> /**</span> |
| <span class="source-line-no">237</span><span id="line-237"> * Because HDFS ReadStatistics is calculated per input stream, it is not feasible to update</span> |
| <span class="source-line-no">238</span><span id="line-238"> * the aggregated number in real time. Instead, the metrics are updated when an input stream</span> |
| <span class="source-line-no">239</span><span id="line-239"> * is closed.</span> |
| <span class="source-line-no">240</span><span id="line-240"> */</span> |
| <span class="source-line-no">241</span><span id="line-241"> HdfsDataInputStream hdfsDataInputStream = (HdfsDataInputStream) stream;</span> |
| <span class="source-line-no">242</span><span id="line-242"> synchronized (readStatistics) {</span> |
| <span class="source-line-no">243</span><span id="line-243"> readStatistics.totalBytesRead +=</span> |
| <span class="source-line-no">244</span><span id="line-244"> hdfsDataInputStream.getReadStatistics().getTotalBytesRead();</span> |
| <span class="source-line-no">245</span><span id="line-245"> readStatistics.totalLocalBytesRead +=</span> |
| <span class="source-line-no">246</span><span id="line-246"> hdfsDataInputStream.getReadStatistics().getTotalLocalBytesRead();</span> |
| <span class="source-line-no">247</span><span id="line-247"> readStatistics.totalShortCircuitBytesRead +=</span> |
| <span class="source-line-no">248</span><span id="line-248"> hdfsDataInputStream.getReadStatistics().getTotalShortCircuitBytesRead();</span> |
| <span class="source-line-no">249</span><span id="line-249"> readStatistics.totalZeroCopyBytesRead +=</span> |
| <span class="source-line-no">250</span><span id="line-250"> hdfsDataInputStream.getReadStatistics().getTotalZeroCopyBytesRead();</span> |
| <span class="source-line-no">251</span><span id="line-251"> }</span> |
| <span class="source-line-no">252</span><span id="line-252"> }</span> |
| <span class="source-line-no">253</span><span id="line-253"> }</span> |
| <span class="source-line-no">254</span><span id="line-254"></span> |
| <span class="source-line-no">255</span><span id="line-255"> public static long getTotalBytesRead() {</span> |
| <span class="source-line-no">256</span><span id="line-256"> synchronized (readStatistics) {</span> |
| <span class="source-line-no">257</span><span id="line-257"> return readStatistics.totalBytesRead;</span> |
| <span class="source-line-no">258</span><span id="line-258"> }</span> |
| <span class="source-line-no">259</span><span id="line-259"> }</span> |
| <span class="source-line-no">260</span><span id="line-260"></span> |
| <span class="source-line-no">261</span><span id="line-261"> public static long getLocalBytesRead() {</span> |
| <span class="source-line-no">262</span><span id="line-262"> synchronized (readStatistics) {</span> |
| <span class="source-line-no">263</span><span id="line-263"> return readStatistics.totalLocalBytesRead;</span> |
| <span class="source-line-no">264</span><span id="line-264"> }</span> |
| <span class="source-line-no">265</span><span id="line-265"> }</span> |
| <span class="source-line-no">266</span><span id="line-266"></span> |
| <span class="source-line-no">267</span><span id="line-267"> public static long getShortCircuitBytesRead() {</span> |
| <span class="source-line-no">268</span><span id="line-268"> synchronized (readStatistics) {</span> |
| <span class="source-line-no">269</span><span id="line-269"> return readStatistics.totalShortCircuitBytesRead;</span> |
| <span class="source-line-no">270</span><span id="line-270"> }</span> |
| <span class="source-line-no">271</span><span id="line-271"> }</span> |
| <span class="source-line-no">272</span><span id="line-272"></span> |
| <span class="source-line-no">273</span><span id="line-273"> public static long getZeroCopyBytesRead() {</span> |
| <span class="source-line-no">274</span><span id="line-274"> synchronized (readStatistics) {</span> |
| <span class="source-line-no">275</span><span id="line-275"> return readStatistics.totalZeroCopyBytesRead;</span> |
| <span class="source-line-no">276</span><span id="line-276"> }</span> |
| <span class="source-line-no">277</span><span id="line-277"> }</span> |
| <span class="source-line-no">278</span><span id="line-278"></span> |
| <span class="source-line-no">279</span><span id="line-279"> /** CloseClose stream(s) if necessary. */</span> |
| <span class="source-line-no">280</span><span id="line-280"> @Override</span> |
| <span class="source-line-no">281</span><span id="line-281"> public void close() {</span> |
| <span class="source-line-no">282</span><span id="line-282"> if (!doCloseStreams) {</span> |
| <span class="source-line-no">283</span><span id="line-283"> return;</span> |
| <span class="source-line-no">284</span><span id="line-284"> }</span> |
| <span class="source-line-no">285</span><span id="line-285"> updateInputStreamStatistics(this.streamNoFsChecksum);</span> |
| <span class="source-line-no">286</span><span id="line-286"> // we do not care about the close exception as it is for reading, no data loss issue.</span> |
| <span class="source-line-no">287</span><span id="line-287"> Closeables.closeQuietly(streamNoFsChecksum);</span> |
| <span class="source-line-no">288</span><span id="line-288"></span> |
| <span class="source-line-no">289</span><span id="line-289"> updateInputStreamStatistics(stream);</span> |
| <span class="source-line-no">290</span><span id="line-290"> Closeables.closeQuietly(stream);</span> |
| <span class="source-line-no">291</span><span id="line-291"> }</span> |
| <span class="source-line-no">292</span><span id="line-292"></span> |
| <span class="source-line-no">293</span><span id="line-293"> public HFileSystem getHfs() {</span> |
| <span class="source-line-no">294</span><span id="line-294"> return this.hfs;</span> |
| <span class="source-line-no">295</span><span id="line-295"> }</span> |
| <span class="source-line-no">296</span><span id="line-296"></span> |
| <span class="source-line-no">297</span><span id="line-297"> /**</span> |
| <span class="source-line-no">298</span><span id="line-298"> * This will free sockets and file descriptors held by the stream only when the stream implements</span> |
| <span class="source-line-no">299</span><span id="line-299"> * org.apache.hadoop.fs.CanUnbuffer. NOT THREAD SAFE. Must be called only when all the clients</span> |
| <span class="source-line-no">300</span><span id="line-300"> * using this stream to read the blocks have finished reading. If by chance the stream is</span> |
| <span class="source-line-no">301</span><span id="line-301"> * unbuffered and there are clients still holding this stream for read then on next client read</span> |
| <span class="source-line-no">302</span><span id="line-302"> * request a new socket will be opened by Datanode without client knowing about it and will serve</span> |
| <span class="source-line-no">303</span><span id="line-303"> * its read request. Note: If this socket is idle for some time then the DataNode will close the</span> |
| <span class="source-line-no">304</span><span id="line-304"> * socket and the socket will move into CLOSE_WAIT state and on the next client request on this</span> |
| <span class="source-line-no">305</span><span id="line-305"> * stream, the current socket will be closed and a new socket will be opened to serve the</span> |
| <span class="source-line-no">306</span><span id="line-306"> * requests.</span> |
| <span class="source-line-no">307</span><span id="line-307"> */</span> |
| <span class="source-line-no">308</span><span id="line-308"> public void unbuffer() {</span> |
| <span class="source-line-no">309</span><span id="line-309"> // todo: it may make sense to always unbuffer both streams. we'd need to carefully</span> |
| <span class="source-line-no">310</span><span id="line-310"> // research the usages to know if that is safe. for now just do the current.</span> |
| <span class="source-line-no">311</span><span id="line-311"> FSDataInputStream stream = this.getStream(this.shouldUseHBaseChecksum());</span> |
| <span class="source-line-no">312</span><span id="line-312"> if (stream != null) {</span> |
| <span class="source-line-no">313</span><span id="line-313"> stream.unbuffer();</span> |
| <span class="source-line-no">314</span><span id="line-314"> }</span> |
| <span class="source-line-no">315</span><span id="line-315"> }</span> |
| <span class="source-line-no">316</span><span id="line-316"></span> |
| <span class="source-line-no">317</span><span id="line-317"> public Path getReaderPath() {</span> |
| <span class="source-line-no">318</span><span id="line-318"> return readerPath;</span> |
| <span class="source-line-no">319</span><span id="line-319"> }</span> |
| <span class="source-line-no">320</span><span id="line-320"></span> |
| <span class="source-line-no">321</span><span id="line-321"> // For tests</span> |
| <span class="source-line-no">322</span><span id="line-322"> void setShouldUseHBaseChecksum() {</span> |
| <span class="source-line-no">323</span><span id="line-323"> useHBaseChecksumConfigured = true;</span> |
| <span class="source-line-no">324</span><span id="line-324"> useHBaseChecksum = true;</span> |
| <span class="source-line-no">325</span><span id="line-325"> }</span> |
| <span class="source-line-no">326</span><span id="line-326">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
