| <!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: FileLink, class: FileLinkInputStream"> |
| <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.FileNotFoundException;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.io.IOException;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.io.InputStream;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.util.ArrayList;</span> |
| <span class="source-line-no">024</span><span id="line-24">import java.util.Arrays;</span> |
| <span class="source-line-no">025</span><span id="line-25">import java.util.Collection;</span> |
| <span class="source-line-no">026</span><span id="line-26">import java.util.List;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.fs.CanSetDropBehind;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.fs.CanSetReadahead;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.fs.CanUnbuffer;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.fs.FSDataInputStream;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.fs.FileStatus;</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.fs.PositionedReadable;</span> |
| <span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.fs.Seekable;</span> |
| <span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.util.CommonFSUtils;</span> |
| <span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.ipc.RemoteException;</span> |
| <span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.security.AccessControlException;</span> |
| <span class="source-line-no">039</span><span id="line-39">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">040</span><span id="line-40">import org.slf4j.Logger;</span> |
| <span class="source-line-no">041</span><span id="line-41">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">042</span><span id="line-42"></span> |
| <span class="source-line-no">043</span><span id="line-43">/**</span> |
| <span class="source-line-no">044</span><span id="line-44"> * The FileLink is a sort of hardlink, that allows access to a file given a set of locations.</span> |
| <span class="source-line-no">045</span><span id="line-45"> * <p></span> |
| <span class="source-line-no">046</span><span id="line-46"> * <b>The Problem:</b></span> |
| <span class="source-line-no">047</span><span id="line-47"> * <ul></span> |
| <span class="source-line-no">048</span><span id="line-48"> * <li>HDFS doesn't have support for hardlinks, and this make impossible to referencing the same</span> |
| <span class="source-line-no">049</span><span id="line-49"> * data blocks using different names.</li></span> |
| <span class="source-line-no">050</span><span id="line-50"> * <li>HBase store files in one location (e.g. table/region/family/) and when the file is not needed</span> |
| <span class="source-line-no">051</span><span id="line-51"> * anymore (e.g. compaction, region deletion, ...) moves it to an archive directory.</li></span> |
| <span class="source-line-no">052</span><span id="line-52"> * </ul></span> |
| <span class="source-line-no">053</span><span id="line-53"> * If we want to create a reference to a file, we need to remember that it can be in its original</span> |
| <span class="source-line-no">054</span><span id="line-54"> * location or in the archive folder. The FileLink class tries to abstract this concept and given a</span> |
| <span class="source-line-no">055</span><span id="line-55"> * set of locations it is able to switch between them making this operation transparent for the</span> |
| <span class="source-line-no">056</span><span id="line-56"> * user. {@link HFileLink} is a more concrete implementation of the {@code FileLink}.</span> |
| <span class="source-line-no">057</span><span id="line-57"> * <p></span> |
| <span class="source-line-no">058</span><span id="line-58"> * <b>Back-references:</b> To help the {@link org.apache.hadoop.hbase.master.cleaner.CleanerChore}</span> |
| <span class="source-line-no">059</span><span id="line-59"> * to keep track of the links to a particular file, during the {@code FileLink} creation, a new file</span> |
| <span class="source-line-no">060</span><span id="line-60"> * is placed inside a back-reference directory. There's one back-reference directory for each file</span> |
| <span class="source-line-no">061</span><span id="line-61"> * that has links, and in the directory there's one file per link.</span> |
| <span class="source-line-no">062</span><span id="line-62"> * <p></span> |
| <span class="source-line-no">063</span><span id="line-63"> * HFileLink Example</span> |
| <span class="source-line-no">064</span><span id="line-64"> * <ul></span> |
| <span class="source-line-no">065</span><span id="line-65"> * <li>/hbase/table/region-x/cf/file-k (Original File)</li></span> |
| <span class="source-line-no">066</span><span id="line-66"> * <li>/hbase/table-cloned/region-y/cf/file-k.region-x.table (HFileLink to the original file)</li></span> |
| <span class="source-line-no">067</span><span id="line-67"> * <li>/hbase/table-2nd-cloned/region-z/cf/file-k.region-x.table (HFileLink to the original file)</span> |
| <span class="source-line-no">068</span><span id="line-68"> * </li></span> |
| <span class="source-line-no">069</span><span id="line-69"> * <li>/hbase/.archive/table/region-x/.links-file-k/region-y.table-cloned (Back-reference to the</span> |
| <span class="source-line-no">070</span><span id="line-70"> * link in table-cloned)</li></span> |
| <span class="source-line-no">071</span><span id="line-71"> * <li>/hbase/.archive/table/region-x/.links-file-k/region-z.table-2nd-cloned (Back-reference to the</span> |
| <span class="source-line-no">072</span><span id="line-72"> * link in table-2nd-cloned)</li></span> |
| <span class="source-line-no">073</span><span id="line-73"> * </ul></span> |
| <span class="source-line-no">074</span><span id="line-74"> */</span> |
| <span class="source-line-no">075</span><span id="line-75">@InterfaceAudience.Private</span> |
| <span class="source-line-no">076</span><span id="line-76">public class FileLink {</span> |
| <span class="source-line-no">077</span><span id="line-77"> private static final Logger LOG = LoggerFactory.getLogger(FileLink.class);</span> |
| <span class="source-line-no">078</span><span id="line-78"></span> |
| <span class="source-line-no">079</span><span id="line-79"> /** Define the Back-reference directory name prefix: .links-&lt;hfile&gt;/ */</span> |
| <span class="source-line-no">080</span><span id="line-80"> public static final String BACK_REFERENCES_DIRECTORY_PREFIX = ".links-";</span> |
| <span class="source-line-no">081</span><span id="line-81"></span> |
| <span class="source-line-no">082</span><span id="line-82"> /**</span> |
| <span class="source-line-no">083</span><span id="line-83"> * FileLink InputStream that handles the switch between the original path and the alternative</span> |
| <span class="source-line-no">084</span><span id="line-84"> * locations, when the file is moved.</span> |
| <span class="source-line-no">085</span><span id="line-85"> */</span> |
| <span class="source-line-no">086</span><span id="line-86"> protected static class FileLinkInputStream extends InputStream</span> |
| <span class="source-line-no">087</span><span id="line-87"> implements Seekable, PositionedReadable, CanSetDropBehind, CanSetReadahead, CanUnbuffer {</span> |
| <span class="source-line-no">088</span><span id="line-88"> private FSDataInputStream in = null;</span> |
| <span class="source-line-no">089</span><span id="line-89"> private Path currentPath = null;</span> |
| <span class="source-line-no">090</span><span id="line-90"> private long pos = 0;</span> |
| <span class="source-line-no">091</span><span id="line-91"></span> |
| <span class="source-line-no">092</span><span id="line-92"> private final FileLink fileLink;</span> |
| <span class="source-line-no">093</span><span id="line-93"> private final int bufferSize;</span> |
| <span class="source-line-no">094</span><span id="line-94"> private final FileSystem fs;</span> |
| <span class="source-line-no">095</span><span id="line-95"></span> |
| <span class="source-line-no">096</span><span id="line-96"> public FileLinkInputStream(final FileSystem fs, final FileLink fileLink) throws IOException {</span> |
| <span class="source-line-no">097</span><span id="line-97"> this(fs, fileLink, CommonFSUtils.getDefaultBufferSize(fs));</span> |
| <span class="source-line-no">098</span><span id="line-98"> }</span> |
| <span class="source-line-no">099</span><span id="line-99"></span> |
| <span class="source-line-no">100</span><span id="line-100"> public FileLinkInputStream(final FileSystem fs, final FileLink fileLink, int bufferSize)</span> |
| <span class="source-line-no">101</span><span id="line-101"> throws IOException {</span> |
| <span class="source-line-no">102</span><span id="line-102"> this.bufferSize = bufferSize;</span> |
| <span class="source-line-no">103</span><span id="line-103"> this.fileLink = fileLink;</span> |
| <span class="source-line-no">104</span><span id="line-104"> this.fs = fs;</span> |
| <span class="source-line-no">105</span><span id="line-105"></span> |
| <span class="source-line-no">106</span><span id="line-106"> this.in = tryOpen();</span> |
| <span class="source-line-no">107</span><span id="line-107"> }</span> |
| <span class="source-line-no">108</span><span id="line-108"></span> |
| <span class="source-line-no">109</span><span id="line-109"> private FSDataInputStream getUnderlyingInputStream() {</span> |
| <span class="source-line-no">110</span><span id="line-110"> return in;</span> |
| <span class="source-line-no">111</span><span id="line-111"> }</span> |
| <span class="source-line-no">112</span><span id="line-112"></span> |
| <span class="source-line-no">113</span><span id="line-113"> @Override</span> |
| <span class="source-line-no">114</span><span id="line-114"> public int read() throws IOException {</span> |
| <span class="source-line-no">115</span><span id="line-115"> int res;</span> |
| <span class="source-line-no">116</span><span id="line-116"> try {</span> |
| <span class="source-line-no">117</span><span id="line-117"> res = in.read();</span> |
| <span class="source-line-no">118</span><span id="line-118"> } catch (FileNotFoundException e) {</span> |
| <span class="source-line-no">119</span><span id="line-119"> res = tryOpen().read();</span> |
| <span class="source-line-no">120</span><span id="line-120"> }</span> |
| <span class="source-line-no">121</span><span id="line-121"> if (res > 0) {</span> |
| <span class="source-line-no">122</span><span id="line-122"> pos += 1;</span> |
| <span class="source-line-no">123</span><span id="line-123"> }</span> |
| <span class="source-line-no">124</span><span id="line-124"> return res;</span> |
| <span class="source-line-no">125</span><span id="line-125"> }</span> |
| <span class="source-line-no">126</span><span id="line-126"></span> |
| <span class="source-line-no">127</span><span id="line-127"> @Override</span> |
| <span class="source-line-no">128</span><span id="line-128"> public int read(byte[] b) throws IOException {</span> |
| <span class="source-line-no">129</span><span id="line-129"> return read(b, 0, b.length);</span> |
| <span class="source-line-no">130</span><span id="line-130"> }</span> |
| <span class="source-line-no">131</span><span id="line-131"></span> |
| <span class="source-line-no">132</span><span id="line-132"> @Override</span> |
| <span class="source-line-no">133</span><span id="line-133"> public int read(byte[] b, int off, int len) throws IOException {</span> |
| <span class="source-line-no">134</span><span id="line-134"> int n;</span> |
| <span class="source-line-no">135</span><span id="line-135"> try {</span> |
| <span class="source-line-no">136</span><span id="line-136"> n = in.read(b, off, len);</span> |
| <span class="source-line-no">137</span><span id="line-137"> } catch (FileNotFoundException e) {</span> |
| <span class="source-line-no">138</span><span id="line-138"> n = tryOpen().read(b, off, len);</span> |
| <span class="source-line-no">139</span><span id="line-139"> }</span> |
| <span class="source-line-no">140</span><span id="line-140"> if (n > 0) {</span> |
| <span class="source-line-no">141</span><span id="line-141"> pos += n;</span> |
| <span class="source-line-no">142</span><span id="line-142"> }</span> |
| <span class="source-line-no">143</span><span id="line-143"> assert (in.getPos() == pos);</span> |
| <span class="source-line-no">144</span><span id="line-144"> return n;</span> |
| <span class="source-line-no">145</span><span id="line-145"> }</span> |
| <span class="source-line-no">146</span><span id="line-146"></span> |
| <span class="source-line-no">147</span><span id="line-147"> @Override</span> |
| <span class="source-line-no">148</span><span id="line-148"> public int read(long position, byte[] buffer, int offset, int length) throws IOException {</span> |
| <span class="source-line-no">149</span><span id="line-149"> int n;</span> |
| <span class="source-line-no">150</span><span id="line-150"> try {</span> |
| <span class="source-line-no">151</span><span id="line-151"> n = in.read(position, buffer, offset, length);</span> |
| <span class="source-line-no">152</span><span id="line-152"> } catch (FileNotFoundException e) {</span> |
| <span class="source-line-no">153</span><span id="line-153"> n = tryOpen().read(position, buffer, offset, length);</span> |
| <span class="source-line-no">154</span><span id="line-154"> }</span> |
| <span class="source-line-no">155</span><span id="line-155"> return n;</span> |
| <span class="source-line-no">156</span><span id="line-156"> }</span> |
| <span class="source-line-no">157</span><span id="line-157"></span> |
| <span class="source-line-no">158</span><span id="line-158"> @Override</span> |
| <span class="source-line-no">159</span><span id="line-159"> public void readFully(long position, byte[] buffer) throws IOException {</span> |
| <span class="source-line-no">160</span><span id="line-160"> readFully(position, buffer, 0, buffer.length);</span> |
| <span class="source-line-no">161</span><span id="line-161"> }</span> |
| <span class="source-line-no">162</span><span id="line-162"></span> |
| <span class="source-line-no">163</span><span id="line-163"> @Override</span> |
| <span class="source-line-no">164</span><span id="line-164"> public void readFully(long position, byte[] buffer, int offset, int length) throws IOException {</span> |
| <span class="source-line-no">165</span><span id="line-165"> try {</span> |
| <span class="source-line-no">166</span><span id="line-166"> in.readFully(position, buffer, offset, length);</span> |
| <span class="source-line-no">167</span><span id="line-167"> } catch (FileNotFoundException e) {</span> |
| <span class="source-line-no">168</span><span id="line-168"> tryOpen().readFully(position, buffer, offset, length);</span> |
| <span class="source-line-no">169</span><span id="line-169"> }</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"> @Override</span> |
| <span class="source-line-no">173</span><span id="line-173"> public long skip(long n) throws IOException {</span> |
| <span class="source-line-no">174</span><span id="line-174"> long skipped;</span> |
| <span class="source-line-no">175</span><span id="line-175"></span> |
| <span class="source-line-no">176</span><span id="line-176"> try {</span> |
| <span class="source-line-no">177</span><span id="line-177"> skipped = in.skip(n);</span> |
| <span class="source-line-no">178</span><span id="line-178"> } catch (FileNotFoundException e) {</span> |
| <span class="source-line-no">179</span><span id="line-179"> skipped = tryOpen().skip(n);</span> |
| <span class="source-line-no">180</span><span id="line-180"> }</span> |
| <span class="source-line-no">181</span><span id="line-181"></span> |
| <span class="source-line-no">182</span><span id="line-182"> if (skipped > 0) {</span> |
| <span class="source-line-no">183</span><span id="line-183"> pos += skipped;</span> |
| <span class="source-line-no">184</span><span id="line-184"> }</span> |
| <span class="source-line-no">185</span><span id="line-185"> return skipped;</span> |
| <span class="source-line-no">186</span><span id="line-186"> }</span> |
| <span class="source-line-no">187</span><span id="line-187"></span> |
| <span class="source-line-no">188</span><span id="line-188"> @Override</span> |
| <span class="source-line-no">189</span><span id="line-189"> public int available() throws IOException {</span> |
| <span class="source-line-no">190</span><span id="line-190"> try {</span> |
| <span class="source-line-no">191</span><span id="line-191"> return in.available();</span> |
| <span class="source-line-no">192</span><span id="line-192"> } catch (FileNotFoundException e) {</span> |
| <span class="source-line-no">193</span><span id="line-193"> return tryOpen().available();</span> |
| <span class="source-line-no">194</span><span id="line-194"> }</span> |
| <span class="source-line-no">195</span><span id="line-195"> }</span> |
| <span class="source-line-no">196</span><span id="line-196"></span> |
| <span class="source-line-no">197</span><span id="line-197"> @Override</span> |
| <span class="source-line-no">198</span><span id="line-198"> public void seek(long pos) throws IOException {</span> |
| <span class="source-line-no">199</span><span id="line-199"> try {</span> |
| <span class="source-line-no">200</span><span id="line-200"> in.seek(pos);</span> |
| <span class="source-line-no">201</span><span id="line-201"> } catch (FileNotFoundException e) {</span> |
| <span class="source-line-no">202</span><span id="line-202"> tryOpen().seek(pos);</span> |
| <span class="source-line-no">203</span><span id="line-203"> }</span> |
| <span class="source-line-no">204</span><span id="line-204"> this.pos = pos;</span> |
| <span class="source-line-no">205</span><span id="line-205"> }</span> |
| <span class="source-line-no">206</span><span id="line-206"></span> |
| <span class="source-line-no">207</span><span id="line-207"> @Override</span> |
| <span class="source-line-no">208</span><span id="line-208"> public long getPos() throws IOException {</span> |
| <span class="source-line-no">209</span><span id="line-209"> return pos;</span> |
| <span class="source-line-no">210</span><span id="line-210"> }</span> |
| <span class="source-line-no">211</span><span id="line-211"></span> |
| <span class="source-line-no">212</span><span id="line-212"> @Override</span> |
| <span class="source-line-no">213</span><span id="line-213"> public boolean seekToNewSource(long targetPos) throws IOException {</span> |
| <span class="source-line-no">214</span><span id="line-214"> boolean res;</span> |
| <span class="source-line-no">215</span><span id="line-215"> try {</span> |
| <span class="source-line-no">216</span><span id="line-216"> res = in.seekToNewSource(targetPos);</span> |
| <span class="source-line-no">217</span><span id="line-217"> } catch (FileNotFoundException e) {</span> |
| <span class="source-line-no">218</span><span id="line-218"> res = tryOpen().seekToNewSource(targetPos);</span> |
| <span class="source-line-no">219</span><span id="line-219"> }</span> |
| <span class="source-line-no">220</span><span id="line-220"> if (res) pos = targetPos;</span> |
| <span class="source-line-no">221</span><span id="line-221"> return res;</span> |
| <span class="source-line-no">222</span><span id="line-222"> }</span> |
| <span class="source-line-no">223</span><span id="line-223"></span> |
| <span class="source-line-no">224</span><span id="line-224"> @Override</span> |
| <span class="source-line-no">225</span><span id="line-225"> public void close() throws IOException {</span> |
| <span class="source-line-no">226</span><span id="line-226"> in.close();</span> |
| <span class="source-line-no">227</span><span id="line-227"> }</span> |
| <span class="source-line-no">228</span><span id="line-228"></span> |
| <span class="source-line-no">229</span><span id="line-229"> @Override</span> |
| <span class="source-line-no">230</span><span id="line-230"> public synchronized void mark(int readlimit) {</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"> @Override</span> |
| <span class="source-line-no">234</span><span id="line-234"> public synchronized void reset() throws IOException {</span> |
| <span class="source-line-no">235</span><span id="line-235"> throw new IOException("mark/reset not supported");</span> |
| <span class="source-line-no">236</span><span id="line-236"> }</span> |
| <span class="source-line-no">237</span><span id="line-237"></span> |
| <span class="source-line-no">238</span><span id="line-238"> @Override</span> |
| <span class="source-line-no">239</span><span id="line-239"> public boolean markSupported() {</span> |
| <span class="source-line-no">240</span><span id="line-240"> return false;</span> |
| <span class="source-line-no">241</span><span id="line-241"> }</span> |
| <span class="source-line-no">242</span><span id="line-242"></span> |
| <span class="source-line-no">243</span><span id="line-243"> @Override</span> |
| <span class="source-line-no">244</span><span id="line-244"> public void unbuffer() {</span> |
| <span class="source-line-no">245</span><span id="line-245"> if (in == null) {</span> |
| <span class="source-line-no">246</span><span id="line-246"> return;</span> |
| <span class="source-line-no">247</span><span id="line-247"> }</span> |
| <span class="source-line-no">248</span><span id="line-248"> in.unbuffer();</span> |
| <span class="source-line-no">249</span><span id="line-249"> }</span> |
| <span class="source-line-no">250</span><span id="line-250"></span> |
| <span class="source-line-no">251</span><span id="line-251"> /**</span> |
| <span class="source-line-no">252</span><span id="line-252"> * Try to open the file from one of the available locations.</span> |
| <span class="source-line-no">253</span><span id="line-253"> * @return FSDataInputStream stream of the opened file link</span> |
| <span class="source-line-no">254</span><span id="line-254"> * @throws IOException on unexpected error, or file not found.</span> |
| <span class="source-line-no">255</span><span id="line-255"> */</span> |
| <span class="source-line-no">256</span><span id="line-256"> private FSDataInputStream tryOpen() throws IOException {</span> |
| <span class="source-line-no">257</span><span id="line-257"> IOException exception = null;</span> |
| <span class="source-line-no">258</span><span id="line-258"> for (Path path : fileLink.getLocations()) {</span> |
| <span class="source-line-no">259</span><span id="line-259"> if (path.equals(currentPath)) continue;</span> |
| <span class="source-line-no">260</span><span id="line-260"> try {</span> |
| <span class="source-line-no">261</span><span id="line-261"> in = fs.open(path, bufferSize);</span> |
| <span class="source-line-no">262</span><span id="line-262"> if (pos != 0) in.seek(pos);</span> |
| <span class="source-line-no">263</span><span id="line-263"> assert (in.getPos() == pos) : "Link unable to seek to the right position=" + pos;</span> |
| <span class="source-line-no">264</span><span id="line-264"> if (LOG.isTraceEnabled()) {</span> |
| <span class="source-line-no">265</span><span id="line-265"> if (currentPath == null) {</span> |
| <span class="source-line-no">266</span><span id="line-266"> LOG.debug("link open path=" + path);</span> |
| <span class="source-line-no">267</span><span id="line-267"> } else {</span> |
| <span class="source-line-no">268</span><span id="line-268"> LOG.trace("link switch from path=" + currentPath + " to path=" + path);</span> |
| <span class="source-line-no">269</span><span id="line-269"> }</span> |
| <span class="source-line-no">270</span><span id="line-270"> }</span> |
| <span class="source-line-no">271</span><span id="line-271"> currentPath = path;</span> |
| <span class="source-line-no">272</span><span id="line-272"> return (in);</span> |
| <span class="source-line-no">273</span><span id="line-273"> } catch (FileNotFoundException | AccessControlException | RemoteException e) {</span> |
| <span class="source-line-no">274</span><span id="line-274"> exception = FileLink.handleAccessLocationException(fileLink, e, exception);</span> |
| <span class="source-line-no">275</span><span id="line-275"> }</span> |
| <span class="source-line-no">276</span><span id="line-276"> }</span> |
| <span class="source-line-no">277</span><span id="line-277"> throw exception;</span> |
| <span class="source-line-no">278</span><span id="line-278"> }</span> |
| <span class="source-line-no">279</span><span id="line-279"></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 setReadahead(Long readahead) throws IOException, UnsupportedOperationException {</span> |
| <span class="source-line-no">282</span><span id="line-282"> in.setReadahead(readahead);</span> |
| <span class="source-line-no">283</span><span id="line-283"> }</span> |
| <span class="source-line-no">284</span><span id="line-284"></span> |
| <span class="source-line-no">285</span><span id="line-285"> @Override</span> |
| <span class="source-line-no">286</span><span id="line-286"> public void setDropBehind(Boolean dropCache) throws IOException, UnsupportedOperationException {</span> |
| <span class="source-line-no">287</span><span id="line-287"> in.setDropBehind(dropCache);</span> |
| <span class="source-line-no">288</span><span id="line-288"> }</span> |
| <span class="source-line-no">289</span><span id="line-289"></span> |
| <span class="source-line-no">290</span><span id="line-290"> public Path getCurrentPath() {</span> |
| <span class="source-line-no">291</span><span id="line-291"> return currentPath;</span> |
| <span class="source-line-no">292</span><span id="line-292"> }</span> |
| <span class="source-line-no">293</span><span id="line-293"> }</span> |
| <span class="source-line-no">294</span><span id="line-294"></span> |
| <span class="source-line-no">295</span><span id="line-295"> private Path[] locations = null;</span> |
| <span class="source-line-no">296</span><span id="line-296"></span> |
| <span class="source-line-no">297</span><span id="line-297"> protected FileLink() {</span> |
| <span class="source-line-no">298</span><span id="line-298"> this.locations = null;</span> |
| <span class="source-line-no">299</span><span id="line-299"> }</span> |
| <span class="source-line-no">300</span><span id="line-300"></span> |
| <span class="source-line-no">301</span><span id="line-301"> /**</span> |
| <span class="source-line-no">302</span><span id="line-302"> * @param originPath Original location of the file to link</span> |
| <span class="source-line-no">303</span><span id="line-303"> * @param alternativePaths Alternative locations to look for the linked file</span> |
| <span class="source-line-no">304</span><span id="line-304"> */</span> |
| <span class="source-line-no">305</span><span id="line-305"> public FileLink(Path originPath, Path... alternativePaths) {</span> |
| <span class="source-line-no">306</span><span id="line-306"> setLocations(originPath, alternativePaths);</span> |
| <span class="source-line-no">307</span><span id="line-307"> }</span> |
| <span class="source-line-no">308</span><span id="line-308"></span> |
| <span class="source-line-no">309</span><span id="line-309"> /**</span> |
| <span class="source-line-no">310</span><span id="line-310"> * @param locations locations to look for the linked file</span> |
| <span class="source-line-no">311</span><span id="line-311"> */</span> |
| <span class="source-line-no">312</span><span id="line-312"> public FileLink(final Collection<Path> locations) {</span> |
| <span class="source-line-no">313</span><span id="line-313"> this.locations = locations.toArray(new Path[locations.size()]);</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"> /** Returns the locations to look for the linked file. */</span> |
| <span class="source-line-no">317</span><span id="line-317"> public Path[] getLocations() {</span> |
| <span class="source-line-no">318</span><span id="line-318"> return locations;</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"> @Override</span> |
| <span class="source-line-no">322</span><span id="line-322"> public String toString() {</span> |
| <span class="source-line-no">323</span><span id="line-323"> StringBuilder str = new StringBuilder(getClass().getSimpleName());</span> |
| <span class="source-line-no">324</span><span id="line-324"> str.append(" locations=[");</span> |
| <span class="source-line-no">325</span><span id="line-325"> for (int i = 0; i < locations.length; ++i) {</span> |
| <span class="source-line-no">326</span><span id="line-326"> if (i > 0) str.append(", ");</span> |
| <span class="source-line-no">327</span><span id="line-327"> str.append(locations[i].toString());</span> |
| <span class="source-line-no">328</span><span id="line-328"> }</span> |
| <span class="source-line-no">329</span><span id="line-329"> str.append("]");</span> |
| <span class="source-line-no">330</span><span id="line-330"> return str.toString();</span> |
| <span class="source-line-no">331</span><span id="line-331"> }</span> |
| <span class="source-line-no">332</span><span id="line-332"></span> |
| <span class="source-line-no">333</span><span id="line-333"> /** Returns true if the file pointed by the link exists */</span> |
| <span class="source-line-no">334</span><span id="line-334"> public boolean exists(final FileSystem fs) throws IOException {</span> |
| <span class="source-line-no">335</span><span id="line-335"> for (int i = 0; i < locations.length; ++i) {</span> |
| <span class="source-line-no">336</span><span id="line-336"> if (fs.exists(locations[i])) {</span> |
| <span class="source-line-no">337</span><span id="line-337"> return true;</span> |
| <span class="source-line-no">338</span><span id="line-338"> }</span> |
| <span class="source-line-no">339</span><span id="line-339"> }</span> |
| <span class="source-line-no">340</span><span id="line-340"> return false;</span> |
| <span class="source-line-no">341</span><span id="line-341"> }</span> |
| <span class="source-line-no">342</span><span id="line-342"></span> |
| <span class="source-line-no">343</span><span id="line-343"> /** Returns the path of the first available link. */</span> |
| <span class="source-line-no">344</span><span id="line-344"> public Path getAvailablePath(FileSystem fs) throws IOException {</span> |
| <span class="source-line-no">345</span><span id="line-345"> for (int i = 0; i < locations.length; ++i) {</span> |
| <span class="source-line-no">346</span><span id="line-346"> if (fs.exists(locations[i])) {</span> |
| <span class="source-line-no">347</span><span id="line-347"> return locations[i];</span> |
| <span class="source-line-no">348</span><span id="line-348"> }</span> |
| <span class="source-line-no">349</span><span id="line-349"> }</span> |
| <span class="source-line-no">350</span><span id="line-350"> throw new FileNotFoundException(toString());</span> |
| <span class="source-line-no">351</span><span id="line-351"> }</span> |
| <span class="source-line-no">352</span><span id="line-352"></span> |
| <span class="source-line-no">353</span><span id="line-353"> /**</span> |
| <span class="source-line-no">354</span><span id="line-354"> * Get the FileStatus of the referenced file.</span> |
| <span class="source-line-no">355</span><span id="line-355"> * @param fs {@link FileSystem} on which to get the file status</span> |
| <span class="source-line-no">356</span><span id="line-356"> * @return InputStream for the hfile link.</span> |
| <span class="source-line-no">357</span><span id="line-357"> * @throws IOException on unexpected error.</span> |
| <span class="source-line-no">358</span><span id="line-358"> */</span> |
| <span class="source-line-no">359</span><span id="line-359"> public FileStatus getFileStatus(FileSystem fs) throws IOException {</span> |
| <span class="source-line-no">360</span><span id="line-360"> IOException exception = null;</span> |
| <span class="source-line-no">361</span><span id="line-361"> for (int i = 0; i < locations.length; ++i) {</span> |
| <span class="source-line-no">362</span><span id="line-362"> try {</span> |
| <span class="source-line-no">363</span><span id="line-363"> return fs.getFileStatus(locations[i]);</span> |
| <span class="source-line-no">364</span><span id="line-364"> } catch (FileNotFoundException | AccessControlException e) {</span> |
| <span class="source-line-no">365</span><span id="line-365"> exception = handleAccessLocationException(this, e, exception);</span> |
| <span class="source-line-no">366</span><span id="line-366"> }</span> |
| <span class="source-line-no">367</span><span id="line-367"> }</span> |
| <span class="source-line-no">368</span><span id="line-368"> throw exception;</span> |
| <span class="source-line-no">369</span><span id="line-369"> }</span> |
| <span class="source-line-no">370</span><span id="line-370"></span> |
| <span class="source-line-no">371</span><span id="line-371"> /**</span> |
| <span class="source-line-no">372</span><span id="line-372"> * Handle exceptions which are thrown when access locations of file link</span> |
| <span class="source-line-no">373</span><span id="line-373"> * @param fileLink the file link</span> |
| <span class="source-line-no">374</span><span id="line-374"> * @param newException the exception caught by access the current location</span> |
| <span class="source-line-no">375</span><span id="line-375"> * @param previousException the previous exception caught by access the other locations</span> |
| <span class="source-line-no">376</span><span id="line-376"> * @return return AccessControlException if access one of the locations caught, otherwise return</span> |
| <span class="source-line-no">377</span><span id="line-377"> * FileNotFoundException. The AccessControlException is threw if user scan snapshot</span> |
| <span class="source-line-no">378</span><span id="line-378"> * feature is enabled, see</span> |
| <span class="source-line-no">379</span><span id="line-379"> * {@link org.apache.hadoop.hbase.security.access.SnapshotScannerHDFSAclController}.</span> |
| <span class="source-line-no">380</span><span id="line-380"> * @throws IOException if the exception is neither AccessControlException nor</span> |
| <span class="source-line-no">381</span><span id="line-381"> * FileNotFoundException</span> |
| <span class="source-line-no">382</span><span id="line-382"> */</span> |
| <span class="source-line-no">383</span><span id="line-383"> private static IOException handleAccessLocationException(FileLink fileLink,</span> |
| <span class="source-line-no">384</span><span id="line-384"> IOException newException, IOException previousException) throws IOException {</span> |
| <span class="source-line-no">385</span><span id="line-385"> if (newException instanceof RemoteException) {</span> |
| <span class="source-line-no">386</span><span id="line-386"> newException = ((RemoteException) newException)</span> |
| <span class="source-line-no">387</span><span id="line-387"> .unwrapRemoteException(FileNotFoundException.class, AccessControlException.class);</span> |
| <span class="source-line-no">388</span><span id="line-388"> }</span> |
| <span class="source-line-no">389</span><span id="line-389"> if (newException instanceof FileNotFoundException) {</span> |
| <span class="source-line-no">390</span><span id="line-390"> // Try another file location</span> |
| <span class="source-line-no">391</span><span id="line-391"> if (previousException == null) {</span> |
| <span class="source-line-no">392</span><span id="line-392"> previousException = new FileNotFoundException(fileLink.toString());</span> |
| <span class="source-line-no">393</span><span id="line-393"> }</span> |
| <span class="source-line-no">394</span><span id="line-394"> } else if (newException instanceof AccessControlException) {</span> |
| <span class="source-line-no">395</span><span id="line-395"> // Try another file location</span> |
| <span class="source-line-no">396</span><span id="line-396"> previousException = newException;</span> |
| <span class="source-line-no">397</span><span id="line-397"> } else {</span> |
| <span class="source-line-no">398</span><span id="line-398"> throw newException;</span> |
| <span class="source-line-no">399</span><span id="line-399"> }</span> |
| <span class="source-line-no">400</span><span id="line-400"> return previousException;</span> |
| <span class="source-line-no">401</span><span id="line-401"> }</span> |
| <span class="source-line-no">402</span><span id="line-402"></span> |
| <span class="source-line-no">403</span><span id="line-403"> /**</span> |
| <span class="source-line-no">404</span><span id="line-404"> * Open the FileLink for read.</span> |
| <span class="source-line-no">405</span><span id="line-405"> * <p></span> |
| <span class="source-line-no">406</span><span id="line-406"> * It uses a wrapper of FSDataInputStream that is agnostic to the location of the file, even if</span> |
| <span class="source-line-no">407</span><span id="line-407"> * the file switches between locations.</span> |
| <span class="source-line-no">408</span><span id="line-408"> * @param fs {@link FileSystem} on which to open the FileLink</span> |
| <span class="source-line-no">409</span><span id="line-409"> * @return InputStream for reading the file link.</span> |
| <span class="source-line-no">410</span><span id="line-410"> * @throws IOException on unexpected error.</span> |
| <span class="source-line-no">411</span><span id="line-411"> */</span> |
| <span class="source-line-no">412</span><span id="line-412"> public FSDataInputStream open(final FileSystem fs) throws IOException {</span> |
| <span class="source-line-no">413</span><span id="line-413"> return new FSDataInputStream(new FileLinkInputStream(fs, this));</span> |
| <span class="source-line-no">414</span><span id="line-414"> }</span> |
| <span class="source-line-no">415</span><span id="line-415"></span> |
| <span class="source-line-no">416</span><span id="line-416"> /**</span> |
| <span class="source-line-no">417</span><span id="line-417"> * Open the FileLink for read.</span> |
| <span class="source-line-no">418</span><span id="line-418"> * <p></span> |
| <span class="source-line-no">419</span><span id="line-419"> * It uses a wrapper of FSDataInputStream that is agnostic to the location of the file, even if</span> |
| <span class="source-line-no">420</span><span id="line-420"> * the file switches between locations.</span> |
| <span class="source-line-no">421</span><span id="line-421"> * @param fs {@link FileSystem} on which to open the FileLink</span> |
| <span class="source-line-no">422</span><span id="line-422"> * @param bufferSize the size of the buffer to be used.</span> |
| <span class="source-line-no">423</span><span id="line-423"> * @return InputStream for reading the file link.</span> |
| <span class="source-line-no">424</span><span id="line-424"> * @throws IOException on unexpected error.</span> |
| <span class="source-line-no">425</span><span id="line-425"> */</span> |
| <span class="source-line-no">426</span><span id="line-426"> public FSDataInputStream open(final FileSystem fs, int bufferSize) throws IOException {</span> |
| <span class="source-line-no">427</span><span id="line-427"> return new FSDataInputStream(new FileLinkInputStream(fs, this, bufferSize));</span> |
| <span class="source-line-no">428</span><span id="line-428"> }</span> |
| <span class="source-line-no">429</span><span id="line-429"></span> |
| <span class="source-line-no">430</span><span id="line-430"> /**</span> |
| <span class="source-line-no">431</span><span id="line-431"> * If the passed FSDataInputStream is backed by a FileLink, returns the underlying InputStream for</span> |
| <span class="source-line-no">432</span><span id="line-432"> * the resolved link target. Otherwise, returns null.</span> |
| <span class="source-line-no">433</span><span id="line-433"> */</span> |
| <span class="source-line-no">434</span><span id="line-434"> public static FSDataInputStream getUnderlyingFileLinkInputStream(FSDataInputStream stream) {</span> |
| <span class="source-line-no">435</span><span id="line-435"> if (stream.getWrappedStream() instanceof FileLinkInputStream) {</span> |
| <span class="source-line-no">436</span><span id="line-436"> return ((FileLinkInputStream) stream.getWrappedStream()).getUnderlyingInputStream();</span> |
| <span class="source-line-no">437</span><span id="line-437"> }</span> |
| <span class="source-line-no">438</span><span id="line-438"> return null;</span> |
| <span class="source-line-no">439</span><span id="line-439"> }</span> |
| <span class="source-line-no">440</span><span id="line-440"></span> |
| <span class="source-line-no">441</span><span id="line-441"> /**</span> |
| <span class="source-line-no">442</span><span id="line-442"> * NOTE: This method must be used only in the constructor! It creates a List with the specified</span> |
| <span class="source-line-no">443</span><span id="line-443"> * locations for the link.</span> |
| <span class="source-line-no">444</span><span id="line-444"> */</span> |
| <span class="source-line-no">445</span><span id="line-445"> protected void setLocations(Path originPath, Path... alternativePaths) {</span> |
| <span class="source-line-no">446</span><span id="line-446"> assert this.locations == null : "Link locations already set";</span> |
| <span class="source-line-no">447</span><span id="line-447"></span> |
| <span class="source-line-no">448</span><span id="line-448"> List<Path> paths = new ArrayList<>(alternativePaths.length + 1);</span> |
| <span class="source-line-no">449</span><span id="line-449"> if (originPath != null) {</span> |
| <span class="source-line-no">450</span><span id="line-450"> paths.add(originPath);</span> |
| <span class="source-line-no">451</span><span id="line-451"> }</span> |
| <span class="source-line-no">452</span><span id="line-452"></span> |
| <span class="source-line-no">453</span><span id="line-453"> for (int i = 0; i < alternativePaths.length; i++) {</span> |
| <span class="source-line-no">454</span><span id="line-454"> if (alternativePaths[i] != null) {</span> |
| <span class="source-line-no">455</span><span id="line-455"> paths.add(alternativePaths[i]);</span> |
| <span class="source-line-no">456</span><span id="line-456"> }</span> |
| <span class="source-line-no">457</span><span id="line-457"> }</span> |
| <span class="source-line-no">458</span><span id="line-458"> this.locations = paths.toArray(new Path[0]);</span> |
| <span class="source-line-no">459</span><span id="line-459"> }</span> |
| <span class="source-line-no">460</span><span id="line-460"></span> |
| <span class="source-line-no">461</span><span id="line-461"> /**</span> |
| <span class="source-line-no">462</span><span id="line-462"> * Get the directory to store the link back references</span> |
| <span class="source-line-no">463</span><span id="line-463"> * <p></span> |
| <span class="source-line-no">464</span><span id="line-464"> * To simplify the reference count process, during the FileLink creation a back-reference is added</span> |
| <span class="source-line-no">465</span><span id="line-465"> * to the back-reference directory of the specified file.</span> |
| <span class="source-line-no">466</span><span id="line-466"> * @param storeDir Root directory for the link reference folder</span> |
| <span class="source-line-no">467</span><span id="line-467"> * @param fileName File Name with links</span> |
| <span class="source-line-no">468</span><span id="line-468"> * @return Path for the link back references.</span> |
| <span class="source-line-no">469</span><span id="line-469"> */</span> |
| <span class="source-line-no">470</span><span id="line-470"> public static Path getBackReferencesDir(final Path storeDir, final String fileName) {</span> |
| <span class="source-line-no">471</span><span id="line-471"> return new Path(storeDir, BACK_REFERENCES_DIRECTORY_PREFIX + fileName);</span> |
| <span class="source-line-no">472</span><span id="line-472"> }</span> |
| <span class="source-line-no">473</span><span id="line-473"></span> |
| <span class="source-line-no">474</span><span id="line-474"> /**</span> |
| <span class="source-line-no">475</span><span id="line-475"> * Get the referenced file name from the reference link directory path.</span> |
| <span class="source-line-no">476</span><span id="line-476"> * @param dirPath Link references directory path</span> |
| <span class="source-line-no">477</span><span id="line-477"> * @return Name of the file referenced</span> |
| <span class="source-line-no">478</span><span id="line-478"> */</span> |
| <span class="source-line-no">479</span><span id="line-479"> public static String getBackReferenceFileName(final Path dirPath) {</span> |
| <span class="source-line-no">480</span><span id="line-480"> return dirPath.getName().substring(BACK_REFERENCES_DIRECTORY_PREFIX.length());</span> |
| <span class="source-line-no">481</span><span id="line-481"> }</span> |
| <span class="source-line-no">482</span><span id="line-482"></span> |
| <span class="source-line-no">483</span><span id="line-483"> /**</span> |
| <span class="source-line-no">484</span><span id="line-484"> * Checks if the specified directory path is a back reference links folder.</span> |
| <span class="source-line-no">485</span><span id="line-485"> * @param dirPath Directory path to verify</span> |
| <span class="source-line-no">486</span><span id="line-486"> * @return True if the specified directory is a link references folder</span> |
| <span class="source-line-no">487</span><span id="line-487"> */</span> |
| <span class="source-line-no">488</span><span id="line-488"> public static boolean isBackReferencesDir(final Path dirPath) {</span> |
| <span class="source-line-no">489</span><span id="line-489"> if (dirPath == null) {</span> |
| <span class="source-line-no">490</span><span id="line-490"> return false;</span> |
| <span class="source-line-no">491</span><span id="line-491"> }</span> |
| <span class="source-line-no">492</span><span id="line-492"> return dirPath.getName().startsWith(BACK_REFERENCES_DIRECTORY_PREFIX);</span> |
| <span class="source-line-no">493</span><span id="line-493"> }</span> |
| <span class="source-line-no">494</span><span id="line-494"></span> |
| <span class="source-line-no">495</span><span id="line-495"> @Override</span> |
| <span class="source-line-no">496</span><span id="line-496"> public boolean equals(Object obj) {</span> |
| <span class="source-line-no">497</span><span id="line-497"> if (obj == null) {</span> |
| <span class="source-line-no">498</span><span id="line-498"> return false;</span> |
| <span class="source-line-no">499</span><span id="line-499"> }</span> |
| <span class="source-line-no">500</span><span id="line-500"> // Assumes that the ordering of locations between objects are the same. This is true for the</span> |
| <span class="source-line-no">501</span><span id="line-501"> // current subclasses already (HFileLink, WALLink). Otherwise, we may have to sort the locations</span> |
| <span class="source-line-no">502</span><span id="line-502"> // or keep them presorted</span> |
| <span class="source-line-no">503</span><span id="line-503"> if (this.getClass().equals(obj.getClass())) {</span> |
| <span class="source-line-no">504</span><span id="line-504"> return Arrays.equals(this.locations, ((FileLink) obj).locations);</span> |
| <span class="source-line-no">505</span><span id="line-505"> }</span> |
| <span class="source-line-no">506</span><span id="line-506"></span> |
| <span class="source-line-no">507</span><span id="line-507"> return false;</span> |
| <span class="source-line-no">508</span><span id="line-508"> }</span> |
| <span class="source-line-no">509</span><span id="line-509"></span> |
| <span class="source-line-no">510</span><span id="line-510"> @Override</span> |
| <span class="source-line-no">511</span><span id="line-511"> public int hashCode() {</span> |
| <span class="source-line-no">512</span><span id="line-512"> return Arrays.hashCode(locations);</span> |
| <span class="source-line-no">513</span><span id="line-513"> }</span> |
| <span class="source-line-no">514</span><span id="line-514">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
