| <!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>package org.apache.hadoop.hbase.util;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.io.FileNotFoundException;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.io.IOException;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.lang.reflect.InvocationTargetException;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.lang.reflect.Method;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.net.URI;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.net.URISyntaxException;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.util.List;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import java.util.Locale;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import java.util.Map;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import java.util.concurrent.ConcurrentHashMap;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.hadoop.HadoopIllegalArgumentException;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.hadoop.conf.Configuration;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.hadoop.fs.FSDataOutputStream;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.hadoop.fs.FileStatus;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.hadoop.fs.FileSystem;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.hadoop.fs.LocatedFileStatus;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.hadoop.fs.Path;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.hadoop.fs.PathFilter;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.apache.hadoop.fs.RemoteIterator;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.apache.hadoop.fs.permission.FsPermission;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.HConstants;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.TableName;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>import org.apache.hadoop.ipc.RemoteException;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>import org.slf4j.Logger;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span>import org.slf4j.LoggerFactory;<a name="line.46"></a> |
| <span class="sourceLineNo">047</span><a name="line.47"></a> |
| <span class="sourceLineNo">048</span>import org.apache.hbase.thirdparty.com.google.common.annotations.VisibleForTesting;<a name="line.48"></a> |
| <span class="sourceLineNo">049</span>import org.apache.hbase.thirdparty.com.google.common.collect.Lists;<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> * Utility methods for interacting with the underlying file system.<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * <p/><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * Note that {@link #setStoragePolicy(FileSystem, Path, String)} is tested in TestFSUtils and<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * pre-commit will run the hbase-server tests if there's code change in this class. See<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * <a href="https://issues.apache.org/jira/browse/HBASE-20838">HBASE-20838</a> for more details.<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> */<a name="line.57"></a> |
| <span class="sourceLineNo">058</span>@InterfaceAudience.Private<a name="line.58"></a> |
| <span class="sourceLineNo">059</span>public abstract class CommonFSUtils {<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> private static final Logger LOG = LoggerFactory.getLogger(CommonFSUtils.class);<a name="line.60"></a> |
| <span class="sourceLineNo">061</span><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> /** Parameter name for HBase WAL directory */<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> public static final String HBASE_WAL_DIR = "hbase.wal.dir";<a name="line.63"></a> |
| <span class="sourceLineNo">064</span><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> /** Parameter to disable stream capability enforcement checks */<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> public static final String UNSAFE_STREAM_CAPABILITY_ENFORCE = "hbase.unsafe.stream.capability.enforce";<a name="line.66"></a> |
| <span class="sourceLineNo">067</span><a name="line.67"></a> |
| <span class="sourceLineNo">068</span> /** Full access permissions (starting point for a umask) */<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> public static final String FULL_RWX_PERMISSIONS = "777";<a name="line.69"></a> |
| <span class="sourceLineNo">070</span><a name="line.70"></a> |
| <span class="sourceLineNo">071</span> protected CommonFSUtils() {<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> super();<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> }<a name="line.73"></a> |
| <span class="sourceLineNo">074</span><a name="line.74"></a> |
| <span class="sourceLineNo">075</span> /**<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * Compare of path component. Does not consider schema; i.e. if schemas<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * different but <code>path</code> starts with <code>rootPath</code>,<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * then the function returns true<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * @param rootPath value to check for<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * @param path subject to check<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * @return True if <code>path</code> starts with <code>rootPath</code><a name="line.81"></a> |
| <span class="sourceLineNo">082</span> */<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> public static boolean isStartingWithPath(final Path rootPath, final String path) {<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> String uriRootPath = rootPath.toUri().getPath();<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> String tailUriPath = (new Path(path)).toUri().getPath();<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> return tailUriPath.startsWith(uriRootPath);<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> }<a name="line.87"></a> |
| <span class="sourceLineNo">088</span><a name="line.88"></a> |
| <span class="sourceLineNo">089</span> /**<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * Compare path component of the Path URI; e.g. if hdfs://a/b/c and /a/b/c, it will compare the<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * '/a/b/c' part. Does not consider schema; i.e. if schemas different but path or subpath matches,<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * the two will equate.<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * @param pathToSearch Path we will be trying to match against.<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * @param pathTail what to match<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * @return True if <code>pathTail</code> is tail on the path of <code>pathToSearch</code><a name="line.95"></a> |
| <span class="sourceLineNo">096</span> */<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> public static boolean isMatchingTail(final Path pathToSearch, String pathTail) {<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> return isMatchingTail(pathToSearch, new Path(pathTail));<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> }<a name="line.99"></a> |
| <span class="sourceLineNo">100</span><a name="line.100"></a> |
| <span class="sourceLineNo">101</span> /**<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * Compare path component of the Path URI; e.g. if hdfs://a/b/c and /a/b/c, it will compare the<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * '/a/b/c' part. If you passed in 'hdfs://a/b/c and b/c, it would return true. Does not consider<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * schema; i.e. if schemas different but path or subpath matches, the two will equate.<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * @param pathToSearch Path we will be trying to match agains against<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * @param pathTail what to match<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * @return True if <code>pathTail</code> is tail on the path of <code>pathToSearch</code><a name="line.107"></a> |
| <span class="sourceLineNo">108</span> */<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> public static boolean isMatchingTail(final Path pathToSearch, final Path pathTail) {<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> if (pathToSearch.depth() != pathTail.depth()) {<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> return false;<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> }<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> Path tailPath = pathTail;<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> String tailName;<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> Path toSearch = pathToSearch;<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> String toSearchName;<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> boolean result = false;<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> do {<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> tailName = tailPath.getName();<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> if (tailName == null || tailName.length() <= 0) {<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> result = true;<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> break;<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> }<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> toSearchName = toSearch.getName();<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> if (toSearchName == null || toSearchName.length() <= 0) {<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> break;<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> }<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> // Move up a parent on each path for next go around. Path doesn't let us go off the end.<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> tailPath = tailPath.getParent();<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> toSearch = toSearch.getParent();<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> } while(tailName.equals(toSearchName));<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> return result;<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> }<a name="line.133"></a> |
| <span class="sourceLineNo">134</span><a name="line.134"></a> |
| <span class="sourceLineNo">135</span> /**<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * Delete if exists.<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * @param fs filesystem object<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * @param dir directory to delete<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * @return True if deleted <code>dir</code><a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * @throws IOException e<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> */<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> public static boolean deleteDirectory(final FileSystem fs, final Path dir)<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> throws IOException {<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> return fs.exists(dir) && fs.delete(dir, true);<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> }<a name="line.145"></a> |
| <span class="sourceLineNo">146</span><a name="line.146"></a> |
| <span class="sourceLineNo">147</span> /**<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> * Return the number of bytes that large input files should be optimally<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> * be split into to minimize i/o time.<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> *<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> * use reflection to search for getDefaultBlockSize(Path f)<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> * if the method doesn't exist, fall back to using getDefaultBlockSize()<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> *<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> * @param fs filesystem object<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * @return the default block size for the path's filesystem<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> * @throws IOException e<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> */<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> public static long getDefaultBlockSize(final FileSystem fs, final Path path) throws IOException {<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> Method m = null;<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> Class<? extends FileSystem> cls = fs.getClass();<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> try {<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> m = cls.getMethod("getDefaultBlockSize", new Class<?>[] { Path.class });<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> } catch (NoSuchMethodException e) {<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> LOG.info("FileSystem doesn't support getDefaultBlockSize");<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> } catch (SecurityException e) {<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> LOG.info("Doesn't have access to getDefaultBlockSize on FileSystems", e);<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> m = null; // could happen on setAccessible()<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> }<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> if (m == null) {<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> return fs.getDefaultBlockSize(path);<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> } else {<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> try {<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> Object ret = m.invoke(fs, path);<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> return ((Long)ret).longValue();<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> } catch (Exception e) {<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> throw new IOException(e);<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> }<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> }<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> }<a name="line.179"></a> |
| <span class="sourceLineNo">180</span><a name="line.180"></a> |
| <span class="sourceLineNo">181</span> /*<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> * Get the default replication.<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> *<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> * use reflection to search for getDefaultReplication(Path f)<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * if the method doesn't exist, fall back to using getDefaultReplication()<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> *<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> * @param fs filesystem object<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> * @param f path of file<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> * @return default replication for the path's filesystem<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> * @throws IOException e<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> */<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> public static short getDefaultReplication(final FileSystem fs, final Path path)<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> throws IOException {<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> Method m = null;<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> Class<? extends FileSystem> cls = fs.getClass();<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> try {<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> m = cls.getMethod("getDefaultReplication", new Class<?>[] { Path.class });<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> } catch (NoSuchMethodException e) {<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> LOG.info("FileSystem doesn't support getDefaultReplication");<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> } catch (SecurityException e) {<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> LOG.info("Doesn't have access to getDefaultReplication on FileSystems", e);<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> m = null; // could happen on setAccessible()<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> }<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> if (m == null) {<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> return fs.getDefaultReplication(path);<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> } else {<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> try {<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> Object ret = m.invoke(fs, path);<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> return ((Number)ret).shortValue();<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> } catch (Exception e) {<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> throw new IOException(e);<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> }<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> }<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> }<a name="line.214"></a> |
| <span class="sourceLineNo">215</span><a name="line.215"></a> |
| <span class="sourceLineNo">216</span> /**<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> * Returns the default buffer size to use during writes.<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> *<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> * The size of the buffer should probably be a multiple of hardware<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> * page size (4096 on Intel x86), and it determines how much data is<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> * buffered during read and write operations.<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> *<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> * @param fs filesystem object<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> * @return default buffer size to use during writes<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> */<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> public static int getDefaultBufferSize(final FileSystem fs) {<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> return fs.getConf().getInt("io.file.buffer.size", 4096);<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> }<a name="line.228"></a> |
| <span class="sourceLineNo">229</span><a name="line.229"></a> |
| <span class="sourceLineNo">230</span> /**<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> * Create the specified file on the filesystem. By default, this will:<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> * <ol><a name="line.232"></a> |
| <span class="sourceLineNo">233</span> * <li>apply the umask in the configuration (if it is enabled)</li><a name="line.233"></a> |
| <span class="sourceLineNo">234</span> * <li>use the fs configured buffer size (or 4096 if not set)</li><a name="line.234"></a> |
| <span class="sourceLineNo">235</span> * <li>use the default replication</li><a name="line.235"></a> |
| <span class="sourceLineNo">236</span> * <li>use the default block size</li><a name="line.236"></a> |
| <span class="sourceLineNo">237</span> * <li>not track progress</li><a name="line.237"></a> |
| <span class="sourceLineNo">238</span> * </ol><a name="line.238"></a> |
| <span class="sourceLineNo">239</span> *<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> * @param fs {@link FileSystem} on which to write the file<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> * @param path {@link Path} to the file to write<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> * @param perm intial permissions<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> * @param overwrite Whether or not the created file should be overwritten.<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> * @return output stream to the created file<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> * @throws IOException if the file cannot be created<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> */<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> public static FSDataOutputStream create(FileSystem fs, Path path,<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> FsPermission perm, boolean overwrite) throws IOException {<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> if (LOG.isTraceEnabled()) {<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> LOG.trace("Creating file=" + path + " with permission=" + perm + ", overwrite=" + overwrite);<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> }<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> return fs.create(path, perm, overwrite, getDefaultBufferSize(fs),<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> getDefaultReplication(fs, path), getDefaultBlockSize(fs, path), null);<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> }<a name="line.254"></a> |
| <span class="sourceLineNo">255</span><a name="line.255"></a> |
| <span class="sourceLineNo">256</span> /**<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> * Get the file permissions specified in the configuration, if they are<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> * enabled.<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> *<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> * @param fs filesystem that the file will be created on.<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> * @param conf configuration to read for determining if permissions are<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> * enabled and which to use<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> * @param permssionConfKey property key in the configuration to use when<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> * finding the permission<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> * @return the permission to use when creating a new file on the fs. If<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> * special permissions are not specified in the configuration, then<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> * the default permissions on the the fs will be returned.<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> */<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> public static FsPermission getFilePermissions(final FileSystem fs,<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> final Configuration conf, final String permssionConfKey) {<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> boolean enablePermissions = conf.getBoolean(<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> HConstants.ENABLE_DATA_FILE_UMASK, false);<a name="line.272"></a> |
| <span class="sourceLineNo">273</span><a name="line.273"></a> |
| <span class="sourceLineNo">274</span> if (enablePermissions) {<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> try {<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> FsPermission perm = new FsPermission(FULL_RWX_PERMISSIONS);<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> // make sure that we have a mask, if not, go default.<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> String mask = conf.get(permssionConfKey);<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> if (mask == null) {<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> return FsPermission.getFileDefault();<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> }<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> // appy the umask<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> FsPermission umask = new FsPermission(mask);<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> return perm.applyUMask(umask);<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> } catch (IllegalArgumentException e) {<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> LOG.warn(<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> "Incorrect umask attempted to be created: "<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> + conf.get(permssionConfKey)<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> + ", using default file permissions.", e);<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> return FsPermission.getFileDefault();<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> }<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> }<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> return FsPermission.getFileDefault();<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> }<a name="line.294"></a> |
| <span class="sourceLineNo">295</span><a name="line.295"></a> |
| <span class="sourceLineNo">296</span> /**<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> * Verifies root directory path is a valid URI with a scheme<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> *<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> * @param root root directory path<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> * @return Passed <code>root</code> argument.<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> * @throws IOException if not a valid URI with a scheme<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> */<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> public static Path validateRootPath(Path root) throws IOException {<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> try {<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> URI rootURI = new URI(root.toString());<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> String scheme = rootURI.getScheme();<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> if (scheme == null) {<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> throw new IOException("Root directory does not have a scheme");<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> }<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> return root;<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> } catch (URISyntaxException e) {<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> IOException io = new IOException("Root directory path is not a valid " +<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> "URI -- check your " + HConstants.HBASE_DIR + " configuration");<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> io.initCause(e);<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> throw io;<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> }<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> * Checks for the presence of the WAL log root path (using the provided conf object) in the given<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> * path. If it exists, this method removes it and returns the String representation of remaining<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> * relative path.<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> * @param path must not be null<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> * @param conf must not be null<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> * @return String representation of the remaining relative path<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> * @throws IOException from underlying filesystem<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> */<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> public static String removeWALRootPath(Path path, final Configuration conf) throws IOException {<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> Path root = getWALRootDir(conf);<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> String pathStr = path.toString();<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> // check that the path is absolute... it has the root path in it.<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> if (!pathStr.startsWith(root.toString())) {<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> return pathStr;<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> }<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> // if not, return as it is.<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> return pathStr.substring(root.toString().length() + 1);// remove the "/" too.<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> }<a name="line.337"></a> |
| <span class="sourceLineNo">338</span><a name="line.338"></a> |
| <span class="sourceLineNo">339</span> /**<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> * Return the 'path' component of a Path. In Hadoop, Path is an URI. This<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> * method returns the 'path' component of a Path's URI: e.g. If a Path is<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> * <code>hdfs://example.org:9000/hbase_trunk/TestTable/compaction.dir</code>,<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> * this method returns <code>/hbase_trunk/TestTable/compaction.dir</code>.<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> * This method is useful if you want to print out a Path without qualifying<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> * Filesystem instance.<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> * @param p Filesystem Path whose 'path' component we are to return.<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> * @return Path portion of the Filesystem<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> */<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> public static String getPath(Path p) {<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> return p.toUri().getPath();<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> }<a name="line.351"></a> |
| <span class="sourceLineNo">352</span><a name="line.352"></a> |
| <span class="sourceLineNo">353</span> /**<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> * @param c configuration<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> * @return {@link Path} to hbase root directory from<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> * configuration as a qualified Path.<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> * @throws IOException e<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> */<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> public static Path getRootDir(final Configuration c) throws IOException {<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> Path p = new Path(c.get(HConstants.HBASE_DIR));<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> FileSystem fs = p.getFileSystem(c);<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> return p.makeQualified(fs.getUri(), fs.getWorkingDirectory());<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> }<a name="line.363"></a> |
| <span class="sourceLineNo">364</span><a name="line.364"></a> |
| <span class="sourceLineNo">365</span> public static void setRootDir(final Configuration c, final Path root) throws IOException {<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> c.set(HConstants.HBASE_DIR, root.toString());<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> }<a name="line.367"></a> |
| <span class="sourceLineNo">368</span><a name="line.368"></a> |
| <span class="sourceLineNo">369</span> public static void setFsDefault(final Configuration c, final Path root) throws IOException {<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> c.set("fs.defaultFS", root.toString()); // for hadoop 0.21+<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> }<a name="line.371"></a> |
| <span class="sourceLineNo">372</span><a name="line.372"></a> |
| <span class="sourceLineNo">373</span> public static FileSystem getRootDirFileSystem(final Configuration c) throws IOException {<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> Path p = getRootDir(c);<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> return p.getFileSystem(c);<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> }<a name="line.376"></a> |
| <span class="sourceLineNo">377</span><a name="line.377"></a> |
| <span class="sourceLineNo">378</span> /**<a name="line.378"></a> |
| <span class="sourceLineNo">379</span> * @param c configuration<a name="line.379"></a> |
| <span class="sourceLineNo">380</span> * @return {@link Path} to hbase log root directory: e.g. {@value HBASE_WAL_DIR} from<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> * configuration as a qualified Path. Defaults to HBase root dir.<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> * @throws IOException e<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> */<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> public static Path getWALRootDir(final Configuration c) throws IOException {<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> Path p = new Path(c.get(HBASE_WAL_DIR, c.get(HConstants.HBASE_DIR)));<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> if (!isValidWALRootDir(p, c)) {<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> return getRootDir(c);<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> }<a name="line.388"></a> |
| <span class="sourceLineNo">389</span> FileSystem fs = p.getFileSystem(c);<a name="line.389"></a> |
| <span class="sourceLineNo">390</span> return p.makeQualified(fs.getUri(), fs.getWorkingDirectory());<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> }<a name="line.391"></a> |
| <span class="sourceLineNo">392</span><a name="line.392"></a> |
| <span class="sourceLineNo">393</span> @VisibleForTesting<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> public static void setWALRootDir(final Configuration c, final Path root) throws IOException {<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> c.set(HBASE_WAL_DIR, root.toString());<a name="line.395"></a> |
| <span class="sourceLineNo">396</span> }<a name="line.396"></a> |
| <span class="sourceLineNo">397</span><a name="line.397"></a> |
| <span class="sourceLineNo">398</span> public static FileSystem getWALFileSystem(final Configuration c) throws IOException {<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> Path p = getWALRootDir(c);<a name="line.399"></a> |
| <span class="sourceLineNo">400</span> FileSystem fs = p.getFileSystem(c);<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> // hadoop-core does fs caching, so need to propogate this if set<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> String enforceStreamCapability = c.get(UNSAFE_STREAM_CAPABILITY_ENFORCE);<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> if (enforceStreamCapability != null) {<a name="line.403"></a> |
| <span class="sourceLineNo">404</span> fs.getConf().set(UNSAFE_STREAM_CAPABILITY_ENFORCE, enforceStreamCapability);<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> }<a name="line.405"></a> |
| <span class="sourceLineNo">406</span> return fs;<a name="line.406"></a> |
| <span class="sourceLineNo">407</span> }<a name="line.407"></a> |
| <span class="sourceLineNo">408</span><a name="line.408"></a> |
| <span class="sourceLineNo">409</span> private static boolean isValidWALRootDir(Path walDir, final Configuration c) throws IOException {<a name="line.409"></a> |
| <span class="sourceLineNo">410</span> Path rootDir = getRootDir(c);<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> FileSystem fs = walDir.getFileSystem(c);<a name="line.411"></a> |
| <span class="sourceLineNo">412</span> Path qualifiedWalDir = walDir.makeQualified(fs.getUri(), fs.getWorkingDirectory());<a name="line.412"></a> |
| <span class="sourceLineNo">413</span> if (!qualifiedWalDir.equals(rootDir)) {<a name="line.413"></a> |
| <span class="sourceLineNo">414</span> if (qualifiedWalDir.toString().startsWith(rootDir.toString() + "/")) {<a name="line.414"></a> |
| <span class="sourceLineNo">415</span> throw new IllegalStateException("Illegal WAL directory specified. " +<a name="line.415"></a> |
| <span class="sourceLineNo">416</span> "WAL directories are not permitted to be under the root directory if set.");<a name="line.416"></a> |
| <span class="sourceLineNo">417</span> }<a name="line.417"></a> |
| <span class="sourceLineNo">418</span> }<a name="line.418"></a> |
| <span class="sourceLineNo">419</span> return true;<a name="line.419"></a> |
| <span class="sourceLineNo">420</span> }<a name="line.420"></a> |
| <span class="sourceLineNo">421</span><a name="line.421"></a> |
| <span class="sourceLineNo">422</span> /**<a name="line.422"></a> |
| <span class="sourceLineNo">423</span> * Returns the WAL region directory based on the given table name and region name<a name="line.423"></a> |
| <span class="sourceLineNo">424</span> * @param conf configuration to determine WALRootDir<a name="line.424"></a> |
| <span class="sourceLineNo">425</span> * @param tableName Table that the region is under<a name="line.425"></a> |
| <span class="sourceLineNo">426</span> * @param encodedRegionName Region name used for creating the final region directory<a name="line.426"></a> |
| <span class="sourceLineNo">427</span> * @return the region directory used to store WALs under the WALRootDir<a name="line.427"></a> |
| <span class="sourceLineNo">428</span> * @throws IOException if there is an exception determining the WALRootDir<a name="line.428"></a> |
| <span class="sourceLineNo">429</span> */<a name="line.429"></a> |
| <span class="sourceLineNo">430</span> public static Path getWALRegionDir(final Configuration conf, final TableName tableName,<a name="line.430"></a> |
| <span class="sourceLineNo">431</span> final String encodedRegionName) throws IOException {<a name="line.431"></a> |
| <span class="sourceLineNo">432</span> return new Path(getWALTableDir(conf, tableName), encodedRegionName);<a name="line.432"></a> |
| <span class="sourceLineNo">433</span> }<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> * Returns the Table directory under the WALRootDir for the specified table name<a name="line.436"></a> |
| <span class="sourceLineNo">437</span> * @param conf configuration used to get the WALRootDir<a name="line.437"></a> |
| <span class="sourceLineNo">438</span> * @param tableName Table to get the directory for<a name="line.438"></a> |
| <span class="sourceLineNo">439</span> * @return a path to the WAL table directory for the specified table<a name="line.439"></a> |
| <span class="sourceLineNo">440</span> * @throws IOException if there is an exception determining the WALRootDir<a name="line.440"></a> |
| <span class="sourceLineNo">441</span> */<a name="line.441"></a> |
| <span class="sourceLineNo">442</span> public static Path getWALTableDir(final Configuration conf, final TableName tableName)<a name="line.442"></a> |
| <span class="sourceLineNo">443</span> throws IOException {<a name="line.443"></a> |
| <span class="sourceLineNo">444</span> Path baseDir = new Path(getWALRootDir(conf), HConstants.BASE_NAMESPACE_DIR);<a name="line.444"></a> |
| <span class="sourceLineNo">445</span> return new Path(new Path(baseDir, tableName.getNamespaceAsString()),<a name="line.445"></a> |
| <span class="sourceLineNo">446</span> tableName.getQualifierAsString());<a name="line.446"></a> |
| <span class="sourceLineNo">447</span> }<a name="line.447"></a> |
| <span class="sourceLineNo">448</span><a name="line.448"></a> |
| <span class="sourceLineNo">449</span> /**<a name="line.449"></a> |
| <span class="sourceLineNo">450</span> * For backward compatibility with HBASE-20734, where we store recovered edits in a wrong<a name="line.450"></a> |
| <span class="sourceLineNo">451</span> * directory without BASE_NAMESPACE_DIR. See HBASE-22617 for more details.<a name="line.451"></a> |
| <span class="sourceLineNo">452</span> * @deprecated For compatibility, will be removed in 4.0.0.<a name="line.452"></a> |
| <span class="sourceLineNo">453</span> */<a name="line.453"></a> |
| <span class="sourceLineNo">454</span> @Deprecated<a name="line.454"></a> |
| <span class="sourceLineNo">455</span> public static Path getWrongWALRegionDir(final Configuration conf, final TableName tableName,<a name="line.455"></a> |
| <span class="sourceLineNo">456</span> final String encodedRegionName) throws IOException {<a name="line.456"></a> |
| <span class="sourceLineNo">457</span> Path wrongTableDir = new Path(new Path(getWALRootDir(conf), tableName.getNamespaceAsString()),<a name="line.457"></a> |
| <span class="sourceLineNo">458</span> tableName.getQualifierAsString());<a name="line.458"></a> |
| <span class="sourceLineNo">459</span> return new Path(wrongTableDir, encodedRegionName);<a name="line.459"></a> |
| <span class="sourceLineNo">460</span> }<a name="line.460"></a> |
| <span class="sourceLineNo">461</span><a name="line.461"></a> |
| <span class="sourceLineNo">462</span> /**<a name="line.462"></a> |
| <span class="sourceLineNo">463</span> * Returns the {@link org.apache.hadoop.fs.Path} object representing the table directory under<a name="line.463"></a> |
| <span class="sourceLineNo">464</span> * path rootdir<a name="line.464"></a> |
| <span class="sourceLineNo">465</span> *<a name="line.465"></a> |
| <span class="sourceLineNo">466</span> * @param rootdir qualified path of HBase root directory<a name="line.466"></a> |
| <span class="sourceLineNo">467</span> * @param tableName name of table<a name="line.467"></a> |
| <span class="sourceLineNo">468</span> * @return {@link org.apache.hadoop.fs.Path} for table<a name="line.468"></a> |
| <span class="sourceLineNo">469</span> */<a name="line.469"></a> |
| <span class="sourceLineNo">470</span> public static Path getTableDir(Path rootdir, final TableName tableName) {<a name="line.470"></a> |
| <span class="sourceLineNo">471</span> return new Path(getNamespaceDir(rootdir, tableName.getNamespaceAsString()),<a name="line.471"></a> |
| <span class="sourceLineNo">472</span> tableName.getQualifierAsString());<a name="line.472"></a> |
| <span class="sourceLineNo">473</span> }<a name="line.473"></a> |
| <span class="sourceLineNo">474</span><a name="line.474"></a> |
| <span class="sourceLineNo">475</span> /**<a name="line.475"></a> |
| <span class="sourceLineNo">476</span> * Returns the {@link org.apache.hadoop.hbase.TableName} object representing<a name="line.476"></a> |
| <span class="sourceLineNo">477</span> * the table directory under<a name="line.477"></a> |
| <span class="sourceLineNo">478</span> * path rootdir<a name="line.478"></a> |
| <span class="sourceLineNo">479</span> *<a name="line.479"></a> |
| <span class="sourceLineNo">480</span> * @param tablePath path of table<a name="line.480"></a> |
| <span class="sourceLineNo">481</span> * @return {@link org.apache.hadoop.fs.Path} for table<a name="line.481"></a> |
| <span class="sourceLineNo">482</span> */<a name="line.482"></a> |
| <span class="sourceLineNo">483</span> public static TableName getTableName(Path tablePath) {<a name="line.483"></a> |
| <span class="sourceLineNo">484</span> return TableName.valueOf(tablePath.getParent().getName(), tablePath.getName());<a name="line.484"></a> |
| <span class="sourceLineNo">485</span> }<a name="line.485"></a> |
| <span class="sourceLineNo">486</span><a name="line.486"></a> |
| <span class="sourceLineNo">487</span> /**<a name="line.487"></a> |
| <span class="sourceLineNo">488</span> * Returns the {@link org.apache.hadoop.fs.Path} object representing<a name="line.488"></a> |
| <span class="sourceLineNo">489</span> * the namespace directory under path rootdir<a name="line.489"></a> |
| <span class="sourceLineNo">490</span> *<a name="line.490"></a> |
| <span class="sourceLineNo">491</span> * @param rootdir qualified path of HBase root directory<a name="line.491"></a> |
| <span class="sourceLineNo">492</span> * @param namespace namespace name<a name="line.492"></a> |
| <span class="sourceLineNo">493</span> * @return {@link org.apache.hadoop.fs.Path} for table<a name="line.493"></a> |
| <span class="sourceLineNo">494</span> */<a name="line.494"></a> |
| <span class="sourceLineNo">495</span> public static Path getNamespaceDir(Path rootdir, final String namespace) {<a name="line.495"></a> |
| <span class="sourceLineNo">496</span> return new Path(rootdir, new Path(HConstants.BASE_NAMESPACE_DIR,<a name="line.496"></a> |
| <span class="sourceLineNo">497</span> new Path(namespace)));<a name="line.497"></a> |
| <span class="sourceLineNo">498</span> }<a name="line.498"></a> |
| <span class="sourceLineNo">499</span><a name="line.499"></a> |
| <span class="sourceLineNo">500</span> // this mapping means that under a federated FileSystem implementation, we'll<a name="line.500"></a> |
| <span class="sourceLineNo">501</span> // only log the first failure from any of the underlying FileSystems at WARN and all others<a name="line.501"></a> |
| <span class="sourceLineNo">502</span> // will be at DEBUG.<a name="line.502"></a> |
| <span class="sourceLineNo">503</span> private static final Map<FileSystem, Boolean> warningMap =<a name="line.503"></a> |
| <span class="sourceLineNo">504</span> new ConcurrentHashMap<FileSystem, Boolean>();<a name="line.504"></a> |
| <span class="sourceLineNo">505</span><a name="line.505"></a> |
| <span class="sourceLineNo">506</span> /**<a name="line.506"></a> |
| <span class="sourceLineNo">507</span> * Sets storage policy for given path.<a name="line.507"></a> |
| <span class="sourceLineNo">508</span> * If the passed path is a directory, we'll set the storage policy for all files<a name="line.508"></a> |
| <span class="sourceLineNo">509</span> * created in the future in said directory. Note that this change in storage<a name="line.509"></a> |
| <span class="sourceLineNo">510</span> * policy takes place at the FileSystem level; it will persist beyond this RS's lifecycle.<a name="line.510"></a> |
| <span class="sourceLineNo">511</span> * If we're running on a version of FileSystem that doesn't support the given storage policy<a name="line.511"></a> |
| <span class="sourceLineNo">512</span> * (or storage policies at all), then we'll issue a log message and continue.<a name="line.512"></a> |
| <span class="sourceLineNo">513</span> *<a name="line.513"></a> |
| <span class="sourceLineNo">514</span> * See http://hadoop.apache.org/docs/r2.6.0/hadoop-project-dist/hadoop-hdfs/ArchivalStorage.html<a name="line.514"></a> |
| <span class="sourceLineNo">515</span> *<a name="line.515"></a> |
| <span class="sourceLineNo">516</span> * @param fs We only do anything it implements a setStoragePolicy method<a name="line.516"></a> |
| <span class="sourceLineNo">517</span> * @param path the Path whose storage policy is to be set<a name="line.517"></a> |
| <span class="sourceLineNo">518</span> * @param storagePolicy Policy to set on <code>path</code>; see hadoop 2.6+<a name="line.518"></a> |
| <span class="sourceLineNo">519</span> * org.apache.hadoop.hdfs.protocol.HdfsConstants for possible list e.g<a name="line.519"></a> |
| <span class="sourceLineNo">520</span> * 'COLD', 'WARM', 'HOT', 'ONE_SSD', 'ALL_SSD', 'LAZY_PERSIST'.<a name="line.520"></a> |
| <span class="sourceLineNo">521</span> */<a name="line.521"></a> |
| <span class="sourceLineNo">522</span> public static void setStoragePolicy(final FileSystem fs, final Path path,<a name="line.522"></a> |
| <span class="sourceLineNo">523</span> final String storagePolicy) {<a name="line.523"></a> |
| <span class="sourceLineNo">524</span> try {<a name="line.524"></a> |
| <span class="sourceLineNo">525</span> setStoragePolicy(fs, path, storagePolicy, false);<a name="line.525"></a> |
| <span class="sourceLineNo">526</span> } catch (IOException e) {<a name="line.526"></a> |
| <span class="sourceLineNo">527</span> // should never arrive here<a name="line.527"></a> |
| <span class="sourceLineNo">528</span> LOG.warn("We have chosen not to throw exception but some unexpectedly thrown out", e);<a name="line.528"></a> |
| <span class="sourceLineNo">529</span> }<a name="line.529"></a> |
| <span class="sourceLineNo">530</span> }<a name="line.530"></a> |
| <span class="sourceLineNo">531</span><a name="line.531"></a> |
| <span class="sourceLineNo">532</span> static void setStoragePolicy(final FileSystem fs, final Path path, final String storagePolicy,<a name="line.532"></a> |
| <span class="sourceLineNo">533</span> boolean throwException) throws IOException {<a name="line.533"></a> |
| <span class="sourceLineNo">534</span> if (storagePolicy == null) {<a name="line.534"></a> |
| <span class="sourceLineNo">535</span> if (LOG.isTraceEnabled()) {<a name="line.535"></a> |
| <span class="sourceLineNo">536</span> LOG.trace("We were passed a null storagePolicy, exiting early.");<a name="line.536"></a> |
| <span class="sourceLineNo">537</span> }<a name="line.537"></a> |
| <span class="sourceLineNo">538</span> return;<a name="line.538"></a> |
| <span class="sourceLineNo">539</span> }<a name="line.539"></a> |
| <span class="sourceLineNo">540</span> String trimmedStoragePolicy = storagePolicy.trim();<a name="line.540"></a> |
| <span class="sourceLineNo">541</span> if (trimmedStoragePolicy.isEmpty()) {<a name="line.541"></a> |
| <span class="sourceLineNo">542</span> if (LOG.isTraceEnabled()) {<a name="line.542"></a> |
| <span class="sourceLineNo">543</span> LOG.trace("We were passed an empty storagePolicy, exiting early.");<a name="line.543"></a> |
| <span class="sourceLineNo">544</span> }<a name="line.544"></a> |
| <span class="sourceLineNo">545</span> return;<a name="line.545"></a> |
| <span class="sourceLineNo">546</span> } else {<a name="line.546"></a> |
| <span class="sourceLineNo">547</span> trimmedStoragePolicy = trimmedStoragePolicy.toUpperCase(Locale.ROOT);<a name="line.547"></a> |
| <span class="sourceLineNo">548</span> }<a name="line.548"></a> |
| <span class="sourceLineNo">549</span> if (trimmedStoragePolicy.equals(HConstants.DEFER_TO_HDFS_STORAGE_POLICY)) {<a name="line.549"></a> |
| <span class="sourceLineNo">550</span> if (LOG.isTraceEnabled()) {<a name="line.550"></a> |
| <span class="sourceLineNo">551</span> LOG.trace("We were passed the defer-to-hdfs policy {}, exiting early.",<a name="line.551"></a> |
| <span class="sourceLineNo">552</span> trimmedStoragePolicy);<a name="line.552"></a> |
| <span class="sourceLineNo">553</span> }<a name="line.553"></a> |
| <span class="sourceLineNo">554</span> return;<a name="line.554"></a> |
| <span class="sourceLineNo">555</span> }<a name="line.555"></a> |
| <span class="sourceLineNo">556</span> try {<a name="line.556"></a> |
| <span class="sourceLineNo">557</span> invokeSetStoragePolicy(fs, path, trimmedStoragePolicy);<a name="line.557"></a> |
| <span class="sourceLineNo">558</span> } catch (IOException e) {<a name="line.558"></a> |
| <span class="sourceLineNo">559</span> if (LOG.isTraceEnabled()) {<a name="line.559"></a> |
| <span class="sourceLineNo">560</span> LOG.trace("Failed to invoke set storage policy API on FS", e);<a name="line.560"></a> |
| <span class="sourceLineNo">561</span> }<a name="line.561"></a> |
| <span class="sourceLineNo">562</span> if (throwException) {<a name="line.562"></a> |
| <span class="sourceLineNo">563</span> throw e;<a name="line.563"></a> |
| <span class="sourceLineNo">564</span> }<a name="line.564"></a> |
| <span class="sourceLineNo">565</span> }<a name="line.565"></a> |
| <span class="sourceLineNo">566</span> }<a name="line.566"></a> |
| <span class="sourceLineNo">567</span><a name="line.567"></a> |
| <span class="sourceLineNo">568</span> /*<a name="line.568"></a> |
| <span class="sourceLineNo">569</span> * All args have been checked and are good. Run the setStoragePolicy invocation.<a name="line.569"></a> |
| <span class="sourceLineNo">570</span> */<a name="line.570"></a> |
| <span class="sourceLineNo">571</span> private static void invokeSetStoragePolicy(final FileSystem fs, final Path path,<a name="line.571"></a> |
| <span class="sourceLineNo">572</span> final String storagePolicy) throws IOException {<a name="line.572"></a> |
| <span class="sourceLineNo">573</span> Method m = null;<a name="line.573"></a> |
| <span class="sourceLineNo">574</span> Exception toThrow = null;<a name="line.574"></a> |
| <span class="sourceLineNo">575</span> try {<a name="line.575"></a> |
| <span class="sourceLineNo">576</span> m = fs.getClass().getDeclaredMethod("setStoragePolicy",<a name="line.576"></a> |
| <span class="sourceLineNo">577</span> new Class<?>[] { Path.class, String.class });<a name="line.577"></a> |
| <span class="sourceLineNo">578</span> m.setAccessible(true);<a name="line.578"></a> |
| <span class="sourceLineNo">579</span> } catch (NoSuchMethodException e) {<a name="line.579"></a> |
| <span class="sourceLineNo">580</span> toThrow = e;<a name="line.580"></a> |
| <span class="sourceLineNo">581</span> final String msg = "FileSystem doesn't support setStoragePolicy; HDFS-6584, HDFS-9345 " +<a name="line.581"></a> |
| <span class="sourceLineNo">582</span> "not available. This is normal and expected on earlier Hadoop versions.";<a name="line.582"></a> |
| <span class="sourceLineNo">583</span> if (!warningMap.containsKey(fs)) {<a name="line.583"></a> |
| <span class="sourceLineNo">584</span> warningMap.put(fs, true);<a name="line.584"></a> |
| <span class="sourceLineNo">585</span> LOG.warn(msg, e);<a name="line.585"></a> |
| <span class="sourceLineNo">586</span> } else if (LOG.isDebugEnabled()) {<a name="line.586"></a> |
| <span class="sourceLineNo">587</span> LOG.debug(msg, e);<a name="line.587"></a> |
| <span class="sourceLineNo">588</span> }<a name="line.588"></a> |
| <span class="sourceLineNo">589</span> m = null;<a name="line.589"></a> |
| <span class="sourceLineNo">590</span> } catch (SecurityException e) {<a name="line.590"></a> |
| <span class="sourceLineNo">591</span> toThrow = e;<a name="line.591"></a> |
| <span class="sourceLineNo">592</span> final String msg = "No access to setStoragePolicy on FileSystem from the SecurityManager; " +<a name="line.592"></a> |
| <span class="sourceLineNo">593</span> "HDFS-6584, HDFS-9345 not available. This is unusual and probably warrants an email " +<a name="line.593"></a> |
| <span class="sourceLineNo">594</span> "to the user@hbase mailing list. Please be sure to include a link to your configs, and " +<a name="line.594"></a> |
| <span class="sourceLineNo">595</span> "logs that include this message and period of time before it. Logs around service " +<a name="line.595"></a> |
| <span class="sourceLineNo">596</span> "start up will probably be useful as well.";<a name="line.596"></a> |
| <span class="sourceLineNo">597</span> if (!warningMap.containsKey(fs)) {<a name="line.597"></a> |
| <span class="sourceLineNo">598</span> warningMap.put(fs, true);<a name="line.598"></a> |
| <span class="sourceLineNo">599</span> LOG.warn(msg, e);<a name="line.599"></a> |
| <span class="sourceLineNo">600</span> } else if (LOG.isDebugEnabled()) {<a name="line.600"></a> |
| <span class="sourceLineNo">601</span> LOG.debug(msg, e);<a name="line.601"></a> |
| <span class="sourceLineNo">602</span> }<a name="line.602"></a> |
| <span class="sourceLineNo">603</span> m = null; // could happen on setAccessible() or getDeclaredMethod()<a name="line.603"></a> |
| <span class="sourceLineNo">604</span> }<a name="line.604"></a> |
| <span class="sourceLineNo">605</span> if (m != null) {<a name="line.605"></a> |
| <span class="sourceLineNo">606</span> try {<a name="line.606"></a> |
| <span class="sourceLineNo">607</span> m.invoke(fs, path, storagePolicy);<a name="line.607"></a> |
| <span class="sourceLineNo">608</span> if (LOG.isDebugEnabled()) {<a name="line.608"></a> |
| <span class="sourceLineNo">609</span> LOG.debug("Set storagePolicy=" + storagePolicy + " for path=" + path);<a name="line.609"></a> |
| <span class="sourceLineNo">610</span> }<a name="line.610"></a> |
| <span class="sourceLineNo">611</span> } catch (Exception e) {<a name="line.611"></a> |
| <span class="sourceLineNo">612</span> toThrow = e;<a name="line.612"></a> |
| <span class="sourceLineNo">613</span> // This swallows FNFE, should we be throwing it? seems more likely to indicate dev<a name="line.613"></a> |
| <span class="sourceLineNo">614</span> // misuse than a runtime problem with HDFS.<a name="line.614"></a> |
| <span class="sourceLineNo">615</span> if (!warningMap.containsKey(fs)) {<a name="line.615"></a> |
| <span class="sourceLineNo">616</span> warningMap.put(fs, true);<a name="line.616"></a> |
| <span class="sourceLineNo">617</span> LOG.warn("Unable to set storagePolicy=" + storagePolicy + " for path=" + path + ". " +<a name="line.617"></a> |
| <span class="sourceLineNo">618</span> "DEBUG log level might have more details.", e);<a name="line.618"></a> |
| <span class="sourceLineNo">619</span> } else if (LOG.isDebugEnabled()) {<a name="line.619"></a> |
| <span class="sourceLineNo">620</span> LOG.debug("Unable to set storagePolicy=" + storagePolicy + " for path=" + path, e);<a name="line.620"></a> |
| <span class="sourceLineNo">621</span> }<a name="line.621"></a> |
| <span class="sourceLineNo">622</span> // check for lack of HDFS-7228<a name="line.622"></a> |
| <span class="sourceLineNo">623</span> if (e instanceof InvocationTargetException) {<a name="line.623"></a> |
| <span class="sourceLineNo">624</span> final Throwable exception = e.getCause();<a name="line.624"></a> |
| <span class="sourceLineNo">625</span> if (exception instanceof RemoteException &&<a name="line.625"></a> |
| <span class="sourceLineNo">626</span> HadoopIllegalArgumentException.class.getName().equals(<a name="line.626"></a> |
| <span class="sourceLineNo">627</span> ((RemoteException)exception).getClassName())) {<a name="line.627"></a> |
| <span class="sourceLineNo">628</span> if (LOG.isDebugEnabled()) {<a name="line.628"></a> |
| <span class="sourceLineNo">629</span> LOG.debug("Given storage policy, '" +storagePolicy +"', was rejected and probably " +<a name="line.629"></a> |
| <span class="sourceLineNo">630</span> "isn't a valid policy for the version of Hadoop you're running. I.e. if you're " +<a name="line.630"></a> |
| <span class="sourceLineNo">631</span> "trying to use SSD related policies then you're likely missing HDFS-7228. For " +<a name="line.631"></a> |
| <span class="sourceLineNo">632</span> "more information see the 'ArchivalStorage' docs for your Hadoop release.");<a name="line.632"></a> |
| <span class="sourceLineNo">633</span> }<a name="line.633"></a> |
| <span class="sourceLineNo">634</span> // Hadoop 2.8+, 3.0-a1+ added FileSystem.setStoragePolicy with a default implementation<a name="line.634"></a> |
| <span class="sourceLineNo">635</span> // that throws UnsupportedOperationException<a name="line.635"></a> |
| <span class="sourceLineNo">636</span> } else if (exception instanceof UnsupportedOperationException) {<a name="line.636"></a> |
| <span class="sourceLineNo">637</span> if (LOG.isDebugEnabled()) {<a name="line.637"></a> |
| <span class="sourceLineNo">638</span> LOG.debug("The underlying FileSystem implementation doesn't support " +<a name="line.638"></a> |
| <span class="sourceLineNo">639</span> "setStoragePolicy. This is probably intentional on their part, since HDFS-9345 " +<a name="line.639"></a> |
| <span class="sourceLineNo">640</span> "appears to be present in your version of Hadoop. For more information check " +<a name="line.640"></a> |
| <span class="sourceLineNo">641</span> "the Hadoop documentation on 'ArchivalStorage', the Hadoop FileSystem " +<a name="line.641"></a> |
| <span class="sourceLineNo">642</span> "specification docs from HADOOP-11981, and/or related documentation from the " +<a name="line.642"></a> |
| <span class="sourceLineNo">643</span> "provider of the underlying FileSystem (its name should appear in the " +<a name="line.643"></a> |
| <span class="sourceLineNo">644</span> "stacktrace that accompanies this message). Note in particular that Hadoop's " +<a name="line.644"></a> |
| <span class="sourceLineNo">645</span> "local filesystem implementation doesn't support storage policies.", exception);<a name="line.645"></a> |
| <span class="sourceLineNo">646</span> }<a name="line.646"></a> |
| <span class="sourceLineNo">647</span> }<a name="line.647"></a> |
| <span class="sourceLineNo">648</span> }<a name="line.648"></a> |
| <span class="sourceLineNo">649</span> }<a name="line.649"></a> |
| <span class="sourceLineNo">650</span> }<a name="line.650"></a> |
| <span class="sourceLineNo">651</span> if (toThrow != null) {<a name="line.651"></a> |
| <span class="sourceLineNo">652</span> throw new IOException(toThrow);<a name="line.652"></a> |
| <span class="sourceLineNo">653</span> }<a name="line.653"></a> |
| <span class="sourceLineNo">654</span> }<a name="line.654"></a> |
| <span class="sourceLineNo">655</span><a name="line.655"></a> |
| <span class="sourceLineNo">656</span> /**<a name="line.656"></a> |
| <span class="sourceLineNo">657</span> * @param conf must not be null<a name="line.657"></a> |
| <span class="sourceLineNo">658</span> * @return True if this filesystem whose scheme is 'hdfs'.<a name="line.658"></a> |
| <span class="sourceLineNo">659</span> * @throws IOException from underlying FileSystem<a name="line.659"></a> |
| <span class="sourceLineNo">660</span> */<a name="line.660"></a> |
| <span class="sourceLineNo">661</span> public static boolean isHDFS(final Configuration conf) throws IOException {<a name="line.661"></a> |
| <span class="sourceLineNo">662</span> FileSystem fs = FileSystem.get(conf);<a name="line.662"></a> |
| <span class="sourceLineNo">663</span> String scheme = fs.getUri().getScheme();<a name="line.663"></a> |
| <span class="sourceLineNo">664</span> return scheme.equalsIgnoreCase("hdfs");<a name="line.664"></a> |
| <span class="sourceLineNo">665</span> }<a name="line.665"></a> |
| <span class="sourceLineNo">666</span><a name="line.666"></a> |
| <span class="sourceLineNo">667</span> /**<a name="line.667"></a> |
| <span class="sourceLineNo">668</span> * Checks if the given path is the one with 'recovered.edits' dir.<a name="line.668"></a> |
| <span class="sourceLineNo">669</span> * @param path must not be null<a name="line.669"></a> |
| <span class="sourceLineNo">670</span> * @return True if we recovered edits<a name="line.670"></a> |
| <span class="sourceLineNo">671</span> */<a name="line.671"></a> |
| <span class="sourceLineNo">672</span> public static boolean isRecoveredEdits(Path path) {<a name="line.672"></a> |
| <span class="sourceLineNo">673</span> return path.toString().contains(HConstants.RECOVERED_EDITS_DIR);<a name="line.673"></a> |
| <span class="sourceLineNo">674</span> }<a name="line.674"></a> |
| <span class="sourceLineNo">675</span><a name="line.675"></a> |
| <span class="sourceLineNo">676</span> /**<a name="line.676"></a> |
| <span class="sourceLineNo">677</span> * @param conf must not be null<a name="line.677"></a> |
| <span class="sourceLineNo">678</span> * @return Returns the filesystem of the hbase rootdir.<a name="line.678"></a> |
| <span class="sourceLineNo">679</span> * @throws IOException from underlying FileSystem<a name="line.679"></a> |
| <span class="sourceLineNo">680</span> */<a name="line.680"></a> |
| <span class="sourceLineNo">681</span> public static FileSystem getCurrentFileSystem(Configuration conf)<a name="line.681"></a> |
| <span class="sourceLineNo">682</span> throws IOException {<a name="line.682"></a> |
| <span class="sourceLineNo">683</span> return getRootDir(conf).getFileSystem(conf);<a name="line.683"></a> |
| <span class="sourceLineNo">684</span> }<a name="line.684"></a> |
| <span class="sourceLineNo">685</span><a name="line.685"></a> |
| <span class="sourceLineNo">686</span> /**<a name="line.686"></a> |
| <span class="sourceLineNo">687</span> * Calls fs.listStatus() and treats FileNotFoundException as non-fatal<a name="line.687"></a> |
| <span class="sourceLineNo">688</span> * This accommodates differences between hadoop versions, where hadoop 1<a name="line.688"></a> |
| <span class="sourceLineNo">689</span> * does not throw a FileNotFoundException, and return an empty FileStatus[]<a name="line.689"></a> |
| <span class="sourceLineNo">690</span> * while Hadoop 2 will throw FileNotFoundException.<a name="line.690"></a> |
| <span class="sourceLineNo">691</span> *<a name="line.691"></a> |
| <span class="sourceLineNo">692</span> * Where possible, prefer FSUtils#listStatusWithStatusFilter(FileSystem,<a name="line.692"></a> |
| <span class="sourceLineNo">693</span> * Path, FileStatusFilter) instead.<a name="line.693"></a> |
| <span class="sourceLineNo">694</span> *<a name="line.694"></a> |
| <span class="sourceLineNo">695</span> * @param fs file system<a name="line.695"></a> |
| <span class="sourceLineNo">696</span> * @param dir directory<a name="line.696"></a> |
| <span class="sourceLineNo">697</span> * @param filter path filter<a name="line.697"></a> |
| <span class="sourceLineNo">698</span> * @return null if dir is empty or doesn't exist, otherwise FileStatus array<a name="line.698"></a> |
| <span class="sourceLineNo">699</span> */<a name="line.699"></a> |
| <span class="sourceLineNo">700</span> public static FileStatus [] listStatus(final FileSystem fs,<a name="line.700"></a> |
| <span class="sourceLineNo">701</span> final Path dir, final PathFilter filter) throws IOException {<a name="line.701"></a> |
| <span class="sourceLineNo">702</span> FileStatus [] status = null;<a name="line.702"></a> |
| <span class="sourceLineNo">703</span> try {<a name="line.703"></a> |
| <span class="sourceLineNo">704</span> status = filter == null ? fs.listStatus(dir) : fs.listStatus(dir, filter);<a name="line.704"></a> |
| <span class="sourceLineNo">705</span> } catch (FileNotFoundException fnfe) {<a name="line.705"></a> |
| <span class="sourceLineNo">706</span> // if directory doesn't exist, return null<a name="line.706"></a> |
| <span class="sourceLineNo">707</span> if (LOG.isTraceEnabled()) {<a name="line.707"></a> |
| <span class="sourceLineNo">708</span> LOG.trace(dir + " doesn't exist");<a name="line.708"></a> |
| <span class="sourceLineNo">709</span> }<a name="line.709"></a> |
| <span class="sourceLineNo">710</span> }<a name="line.710"></a> |
| <span class="sourceLineNo">711</span> if (status == null || status.length < 1) {<a name="line.711"></a> |
| <span class="sourceLineNo">712</span> return null;<a name="line.712"></a> |
| <span class="sourceLineNo">713</span> }<a name="line.713"></a> |
| <span class="sourceLineNo">714</span> return status;<a name="line.714"></a> |
| <span class="sourceLineNo">715</span> }<a name="line.715"></a> |
| <span class="sourceLineNo">716</span><a name="line.716"></a> |
| <span class="sourceLineNo">717</span> /**<a name="line.717"></a> |
| <span class="sourceLineNo">718</span> * Calls fs.listStatus() and treats FileNotFoundException as non-fatal<a name="line.718"></a> |
| <span class="sourceLineNo">719</span> * This would accommodates differences between hadoop versions<a name="line.719"></a> |
| <span class="sourceLineNo">720</span> *<a name="line.720"></a> |
| <span class="sourceLineNo">721</span> * @param fs file system<a name="line.721"></a> |
| <span class="sourceLineNo">722</span> * @param dir directory<a name="line.722"></a> |
| <span class="sourceLineNo">723</span> * @return null if dir is empty or doesn't exist, otherwise FileStatus array<a name="line.723"></a> |
| <span class="sourceLineNo">724</span> */<a name="line.724"></a> |
| <span class="sourceLineNo">725</span> public static FileStatus[] listStatus(final FileSystem fs, final Path dir) throws IOException {<a name="line.725"></a> |
| <span class="sourceLineNo">726</span> return listStatus(fs, dir, null);<a name="line.726"></a> |
| <span class="sourceLineNo">727</span> }<a name="line.727"></a> |
| <span class="sourceLineNo">728</span><a name="line.728"></a> |
| <span class="sourceLineNo">729</span> /**<a name="line.729"></a> |
| <span class="sourceLineNo">730</span> * Calls fs.listFiles() to get FileStatus and BlockLocations together for reducing rpc call<a name="line.730"></a> |
| <span class="sourceLineNo">731</span> *<a name="line.731"></a> |
| <span class="sourceLineNo">732</span> * @param fs file system<a name="line.732"></a> |
| <span class="sourceLineNo">733</span> * @param dir directory<a name="line.733"></a> |
| <span class="sourceLineNo">734</span> * @return LocatedFileStatus list<a name="line.734"></a> |
| <span class="sourceLineNo">735</span> */<a name="line.735"></a> |
| <span class="sourceLineNo">736</span> public static List<LocatedFileStatus> listLocatedStatus(final FileSystem fs,<a name="line.736"></a> |
| <span class="sourceLineNo">737</span> final Path dir) throws IOException {<a name="line.737"></a> |
| <span class="sourceLineNo">738</span> List<LocatedFileStatus> status = null;<a name="line.738"></a> |
| <span class="sourceLineNo">739</span> try {<a name="line.739"></a> |
| <span class="sourceLineNo">740</span> RemoteIterator<LocatedFileStatus> locatedFileStatusRemoteIterator = fs<a name="line.740"></a> |
| <span class="sourceLineNo">741</span> .listFiles(dir, false);<a name="line.741"></a> |
| <span class="sourceLineNo">742</span> while (locatedFileStatusRemoteIterator.hasNext()) {<a name="line.742"></a> |
| <span class="sourceLineNo">743</span> if (status == null) {<a name="line.743"></a> |
| <span class="sourceLineNo">744</span> status = Lists.newArrayList();<a name="line.744"></a> |
| <span class="sourceLineNo">745</span> }<a name="line.745"></a> |
| <span class="sourceLineNo">746</span> status.add(locatedFileStatusRemoteIterator.next());<a name="line.746"></a> |
| <span class="sourceLineNo">747</span> }<a name="line.747"></a> |
| <span class="sourceLineNo">748</span> } catch (FileNotFoundException fnfe) {<a name="line.748"></a> |
| <span class="sourceLineNo">749</span> // if directory doesn't exist, return null<a name="line.749"></a> |
| <span class="sourceLineNo">750</span> if (LOG.isTraceEnabled()) {<a name="line.750"></a> |
| <span class="sourceLineNo">751</span> LOG.trace(dir + " doesn't exist");<a name="line.751"></a> |
| <span class="sourceLineNo">752</span> }<a name="line.752"></a> |
| <span class="sourceLineNo">753</span> }<a name="line.753"></a> |
| <span class="sourceLineNo">754</span> return status;<a name="line.754"></a> |
| <span class="sourceLineNo">755</span> }<a name="line.755"></a> |
| <span class="sourceLineNo">756</span><a name="line.756"></a> |
| <span class="sourceLineNo">757</span> /**<a name="line.757"></a> |
| <span class="sourceLineNo">758</span> * Calls fs.delete() and returns the value returned by the fs.delete()<a name="line.758"></a> |
| <span class="sourceLineNo">759</span> *<a name="line.759"></a> |
| <span class="sourceLineNo">760</span> * @param fs must not be null<a name="line.760"></a> |
| <span class="sourceLineNo">761</span> * @param path must not be null<a name="line.761"></a> |
| <span class="sourceLineNo">762</span> * @param recursive delete tree rooted at path<a name="line.762"></a> |
| <span class="sourceLineNo">763</span> * @return the value returned by the fs.delete()<a name="line.763"></a> |
| <span class="sourceLineNo">764</span> * @throws IOException from underlying FileSystem<a name="line.764"></a> |
| <span class="sourceLineNo">765</span> */<a name="line.765"></a> |
| <span class="sourceLineNo">766</span> public static boolean delete(final FileSystem fs, final Path path, final boolean recursive)<a name="line.766"></a> |
| <span class="sourceLineNo">767</span> throws IOException {<a name="line.767"></a> |
| <span class="sourceLineNo">768</span> return fs.delete(path, recursive);<a name="line.768"></a> |
| <span class="sourceLineNo">769</span> }<a name="line.769"></a> |
| <span class="sourceLineNo">770</span><a name="line.770"></a> |
| <span class="sourceLineNo">771</span> /**<a name="line.771"></a> |
| <span class="sourceLineNo">772</span> * Calls fs.exists(). Checks if the specified path exists<a name="line.772"></a> |
| <span class="sourceLineNo">773</span> *<a name="line.773"></a> |
| <span class="sourceLineNo">774</span> * @param fs must not be null<a name="line.774"></a> |
| <span class="sourceLineNo">775</span> * @param path must not be null<a name="line.775"></a> |
| <span class="sourceLineNo">776</span> * @return the value returned by fs.exists()<a name="line.776"></a> |
| <span class="sourceLineNo">777</span> * @throws IOException from underlying FileSystem<a name="line.777"></a> |
| <span class="sourceLineNo">778</span> */<a name="line.778"></a> |
| <span class="sourceLineNo">779</span> public static boolean isExists(final FileSystem fs, final Path path) throws IOException {<a name="line.779"></a> |
| <span class="sourceLineNo">780</span> return fs.exists(path);<a name="line.780"></a> |
| <span class="sourceLineNo">781</span> }<a name="line.781"></a> |
| <span class="sourceLineNo">782</span><a name="line.782"></a> |
| <span class="sourceLineNo">783</span> /**<a name="line.783"></a> |
| <span class="sourceLineNo">784</span> * Log the current state of the filesystem from a certain root directory<a name="line.784"></a> |
| <span class="sourceLineNo">785</span> * @param fs filesystem to investigate<a name="line.785"></a> |
| <span class="sourceLineNo">786</span> * @param root root file/directory to start logging from<a name="line.786"></a> |
| <span class="sourceLineNo">787</span> * @param LOG log to output information<a name="line.787"></a> |
| <span class="sourceLineNo">788</span> * @throws IOException if an unexpected exception occurs<a name="line.788"></a> |
| <span class="sourceLineNo">789</span> */<a name="line.789"></a> |
| <span class="sourceLineNo">790</span> public static void logFileSystemState(final FileSystem fs, final Path root, Logger LOG)<a name="line.790"></a> |
| <span class="sourceLineNo">791</span> throws IOException {<a name="line.791"></a> |
| <span class="sourceLineNo">792</span> LOG.debug("File system contents for path " + root);<a name="line.792"></a> |
| <span class="sourceLineNo">793</span> logFSTree(LOG, fs, root, "|-");<a name="line.793"></a> |
| <span class="sourceLineNo">794</span> }<a name="line.794"></a> |
| <span class="sourceLineNo">795</span><a name="line.795"></a> |
| <span class="sourceLineNo">796</span> /**<a name="line.796"></a> |
| <span class="sourceLineNo">797</span> * Recursive helper to log the state of the FS<a name="line.797"></a> |
| <span class="sourceLineNo">798</span> *<a name="line.798"></a> |
| <span class="sourceLineNo">799</span> * @see #logFileSystemState(FileSystem, Path, Logger)<a name="line.799"></a> |
| <span class="sourceLineNo">800</span> */<a name="line.800"></a> |
| <span class="sourceLineNo">801</span> private static void logFSTree(Logger LOG, final FileSystem fs, final Path root, String prefix)<a name="line.801"></a> |
| <span class="sourceLineNo">802</span> throws IOException {<a name="line.802"></a> |
| <span class="sourceLineNo">803</span> FileStatus[] files = listStatus(fs, root, null);<a name="line.803"></a> |
| <span class="sourceLineNo">804</span> if (files == null) {<a name="line.804"></a> |
| <span class="sourceLineNo">805</span> return;<a name="line.805"></a> |
| <span class="sourceLineNo">806</span> }<a name="line.806"></a> |
| <span class="sourceLineNo">807</span><a name="line.807"></a> |
| <span class="sourceLineNo">808</span> for (FileStatus file : files) {<a name="line.808"></a> |
| <span class="sourceLineNo">809</span> if (file.isDirectory()) {<a name="line.809"></a> |
| <span class="sourceLineNo">810</span> LOG.debug(prefix + file.getPath().getName() + "/");<a name="line.810"></a> |
| <span class="sourceLineNo">811</span> logFSTree(LOG, fs, file.getPath(), prefix + "---");<a name="line.811"></a> |
| <span class="sourceLineNo">812</span> } else {<a name="line.812"></a> |
| <span class="sourceLineNo">813</span> LOG.debug(prefix + file.getPath().getName());<a name="line.813"></a> |
| <span class="sourceLineNo">814</span> }<a name="line.814"></a> |
| <span class="sourceLineNo">815</span> }<a name="line.815"></a> |
| <span class="sourceLineNo">816</span> }<a name="line.816"></a> |
| <span class="sourceLineNo">817</span><a name="line.817"></a> |
| <span class="sourceLineNo">818</span> public static boolean renameAndSetModifyTime(final FileSystem fs, final Path src, final Path dest)<a name="line.818"></a> |
| <span class="sourceLineNo">819</span> throws IOException {<a name="line.819"></a> |
| <span class="sourceLineNo">820</span> // set the modify time for TimeToLive Cleaner<a name="line.820"></a> |
| <span class="sourceLineNo">821</span> fs.setTimes(src, EnvironmentEdgeManager.currentTime(), -1);<a name="line.821"></a> |
| <span class="sourceLineNo">822</span> return fs.rename(src, dest);<a name="line.822"></a> |
| <span class="sourceLineNo">823</span> }<a name="line.823"></a> |
| <span class="sourceLineNo">824</span><a name="line.824"></a> |
| <span class="sourceLineNo">825</span> /**<a name="line.825"></a> |
| <span class="sourceLineNo">826</span> * Do our short circuit read setup.<a name="line.826"></a> |
| <span class="sourceLineNo">827</span> * Checks buffer size to use and whether to do checksumming in hbase or hdfs.<a name="line.827"></a> |
| <span class="sourceLineNo">828</span> * @param conf must not be null<a name="line.828"></a> |
| <span class="sourceLineNo">829</span> */<a name="line.829"></a> |
| <span class="sourceLineNo">830</span> public static void setupShortCircuitRead(final Configuration conf) {<a name="line.830"></a> |
| <span class="sourceLineNo">831</span> // Check that the user has not set the "dfs.client.read.shortcircuit.skip.checksum" property.<a name="line.831"></a> |
| <span class="sourceLineNo">832</span> boolean shortCircuitSkipChecksum =<a name="line.832"></a> |
| <span class="sourceLineNo">833</span> conf.getBoolean("dfs.client.read.shortcircuit.skip.checksum", false);<a name="line.833"></a> |
| <span class="sourceLineNo">834</span> boolean useHBaseChecksum = conf.getBoolean(HConstants.HBASE_CHECKSUM_VERIFICATION, true);<a name="line.834"></a> |
| <span class="sourceLineNo">835</span> if (shortCircuitSkipChecksum) {<a name="line.835"></a> |
| <span class="sourceLineNo">836</span> LOG.warn("Configuration \"dfs.client.read.shortcircuit.skip.checksum\" should not " +<a name="line.836"></a> |
| <span class="sourceLineNo">837</span> "be set to true." + (useHBaseChecksum ? " HBase checksum doesn't require " +<a name="line.837"></a> |
| <span class="sourceLineNo">838</span> "it, see https://issues.apache.org/jira/browse/HBASE-6868." : ""));<a name="line.838"></a> |
| <span class="sourceLineNo">839</span> assert !shortCircuitSkipChecksum; //this will fail if assertions are on<a name="line.839"></a> |
| <span class="sourceLineNo">840</span> }<a name="line.840"></a> |
| <span class="sourceLineNo">841</span> checkShortCircuitReadBufferSize(conf);<a name="line.841"></a> |
| <span class="sourceLineNo">842</span> }<a name="line.842"></a> |
| <span class="sourceLineNo">843</span><a name="line.843"></a> |
| <span class="sourceLineNo">844</span> /**<a name="line.844"></a> |
| <span class="sourceLineNo">845</span> * Check if short circuit read buffer size is set and if not, set it to hbase value.<a name="line.845"></a> |
| <span class="sourceLineNo">846</span> * @param conf must not be null<a name="line.846"></a> |
| <span class="sourceLineNo">847</span> */<a name="line.847"></a> |
| <span class="sourceLineNo">848</span> public static void checkShortCircuitReadBufferSize(final Configuration conf) {<a name="line.848"></a> |
| <span class="sourceLineNo">849</span> final int defaultSize = HConstants.DEFAULT_BLOCKSIZE * 2;<a name="line.849"></a> |
| <span class="sourceLineNo">850</span> final int notSet = -1;<a name="line.850"></a> |
| <span class="sourceLineNo">851</span> // DFSConfigKeys.DFS_CLIENT_READ_SHORTCIRCUIT_BUFFER_SIZE_KEY is only defined in h2<a name="line.851"></a> |
| <span class="sourceLineNo">852</span> final String dfsKey = "dfs.client.read.shortcircuit.buffer.size";<a name="line.852"></a> |
| <span class="sourceLineNo">853</span> int size = conf.getInt(dfsKey, notSet);<a name="line.853"></a> |
| <span class="sourceLineNo">854</span> // If a size is set, return -- we will use it.<a name="line.854"></a> |
| <span class="sourceLineNo">855</span> if (size != notSet) {<a name="line.855"></a> |
| <span class="sourceLineNo">856</span> return;<a name="line.856"></a> |
| <span class="sourceLineNo">857</span> }<a name="line.857"></a> |
| <span class="sourceLineNo">858</span> // But short circuit buffer size is normally not set. Put in place the hbase wanted size.<a name="line.858"></a> |
| <span class="sourceLineNo">859</span> int hbaseSize = conf.getInt("hbase." + dfsKey, defaultSize);<a name="line.859"></a> |
| <span class="sourceLineNo">860</span> conf.setIfUnset(dfsKey, Integer.toString(hbaseSize));<a name="line.860"></a> |
| <span class="sourceLineNo">861</span> }<a name="line.861"></a> |
| <span class="sourceLineNo">862</span><a name="line.862"></a> |
| <span class="sourceLineNo">863</span> private static class DfsBuilderUtility {<a name="line.863"></a> |
| <span class="sourceLineNo">864</span> static Class<?> dfsClass = null;<a name="line.864"></a> |
| <span class="sourceLineNo">865</span> static Method createMethod;<a name="line.865"></a> |
| <span class="sourceLineNo">866</span> static Method overwriteMethod;<a name="line.866"></a> |
| <span class="sourceLineNo">867</span> static Method bufferSizeMethod;<a name="line.867"></a> |
| <span class="sourceLineNo">868</span> static Method blockSizeMethod;<a name="line.868"></a> |
| <span class="sourceLineNo">869</span> static Method recursiveMethod;<a name="line.869"></a> |
| <span class="sourceLineNo">870</span> static Method replicateMethod;<a name="line.870"></a> |
| <span class="sourceLineNo">871</span> static Method replicationMethod;<a name="line.871"></a> |
| <span class="sourceLineNo">872</span> static Method buildMethod;<a name="line.872"></a> |
| <span class="sourceLineNo">873</span> static boolean allMethodsPresent = false;<a name="line.873"></a> |
| <span class="sourceLineNo">874</span><a name="line.874"></a> |
| <span class="sourceLineNo">875</span> static {<a name="line.875"></a> |
| <span class="sourceLineNo">876</span> String dfsName = "org.apache.hadoop.hdfs.DistributedFileSystem";<a name="line.876"></a> |
| <span class="sourceLineNo">877</span> String builderName = dfsName + "$HdfsDataOutputStreamBuilder";<a name="line.877"></a> |
| <span class="sourceLineNo">878</span> Class<?> builderClass = null;<a name="line.878"></a> |
| <span class="sourceLineNo">879</span><a name="line.879"></a> |
| <span class="sourceLineNo">880</span> try {<a name="line.880"></a> |
| <span class="sourceLineNo">881</span> dfsClass = Class.forName(dfsName);<a name="line.881"></a> |
| <span class="sourceLineNo">882</span> } catch (ClassNotFoundException e) {<a name="line.882"></a> |
| <span class="sourceLineNo">883</span> LOG.debug("{} not available, will not use builder API for file creation.", dfsName);<a name="line.883"></a> |
| <span class="sourceLineNo">884</span> }<a name="line.884"></a> |
| <span class="sourceLineNo">885</span> try {<a name="line.885"></a> |
| <span class="sourceLineNo">886</span> builderClass = Class.forName(builderName);<a name="line.886"></a> |
| <span class="sourceLineNo">887</span> } catch (ClassNotFoundException e) {<a name="line.887"></a> |
| <span class="sourceLineNo">888</span> LOG.debug("{} not available, will not use builder API for file creation.", builderName);<a name="line.888"></a> |
| <span class="sourceLineNo">889</span> }<a name="line.889"></a> |
| <span class="sourceLineNo">890</span><a name="line.890"></a> |
| <span class="sourceLineNo">891</span> if (dfsClass != null && builderClass != null) {<a name="line.891"></a> |
| <span class="sourceLineNo">892</span> try {<a name="line.892"></a> |
| <span class="sourceLineNo">893</span> createMethod = dfsClass.getMethod("createFile", Path.class);<a name="line.893"></a> |
| <span class="sourceLineNo">894</span> overwriteMethod = builderClass.getMethod("overwrite", boolean.class);<a name="line.894"></a> |
| <span class="sourceLineNo">895</span> bufferSizeMethod = builderClass.getMethod("bufferSize", int.class);<a name="line.895"></a> |
| <span class="sourceLineNo">896</span> blockSizeMethod = builderClass.getMethod("blockSize", long.class);<a name="line.896"></a> |
| <span class="sourceLineNo">897</span> recursiveMethod = builderClass.getMethod("recursive");<a name="line.897"></a> |
| <span class="sourceLineNo">898</span> replicateMethod = builderClass.getMethod("replicate");<a name="line.898"></a> |
| <span class="sourceLineNo">899</span> replicationMethod = builderClass.getMethod("replication", short.class);<a name="line.899"></a> |
| <span class="sourceLineNo">900</span> buildMethod = builderClass.getMethod("build");<a name="line.900"></a> |
| <span class="sourceLineNo">901</span><a name="line.901"></a> |
| <span class="sourceLineNo">902</span> allMethodsPresent = true;<a name="line.902"></a> |
| <span class="sourceLineNo">903</span> LOG.debug("Using builder API via reflection for DFS file creation.");<a name="line.903"></a> |
| <span class="sourceLineNo">904</span> } catch (NoSuchMethodException e) {<a name="line.904"></a> |
| <span class="sourceLineNo">905</span> LOG.debug("Could not find method on builder; will use old DFS API for file creation {}",<a name="line.905"></a> |
| <span class="sourceLineNo">906</span> e.getMessage());<a name="line.906"></a> |
| <span class="sourceLineNo">907</span> }<a name="line.907"></a> |
| <span class="sourceLineNo">908</span> }<a name="line.908"></a> |
| <span class="sourceLineNo">909</span> }<a name="line.909"></a> |
| <span class="sourceLineNo">910</span><a name="line.910"></a> |
| <span class="sourceLineNo">911</span> /**<a name="line.911"></a> |
| <span class="sourceLineNo">912</span> * Attempt to use builder API via reflection to create a file with the given parameters and<a name="line.912"></a> |
| <span class="sourceLineNo">913</span> * replication enabled.<a name="line.913"></a> |
| <span class="sourceLineNo">914</span> */<a name="line.914"></a> |
| <span class="sourceLineNo">915</span> static FSDataOutputStream createHelper(FileSystem fs, Path path, boolean overwritable,<a name="line.915"></a> |
| <span class="sourceLineNo">916</span> int bufferSize, short replication, long blockSize, boolean isRecursive) throws IOException {<a name="line.916"></a> |
| <span class="sourceLineNo">917</span> if (allMethodsPresent && dfsClass.isInstance(fs)) {<a name="line.917"></a> |
| <span class="sourceLineNo">918</span> try {<a name="line.918"></a> |
| <span class="sourceLineNo">919</span> Object builder;<a name="line.919"></a> |
| <span class="sourceLineNo">920</span><a name="line.920"></a> |
| <span class="sourceLineNo">921</span> builder = createMethod.invoke(fs, path);<a name="line.921"></a> |
| <span class="sourceLineNo">922</span> builder = overwriteMethod.invoke(builder, overwritable);<a name="line.922"></a> |
| <span class="sourceLineNo">923</span> builder = bufferSizeMethod.invoke(builder, bufferSize);<a name="line.923"></a> |
| <span class="sourceLineNo">924</span> builder = blockSizeMethod.invoke(builder, blockSize);<a name="line.924"></a> |
| <span class="sourceLineNo">925</span> if (isRecursive) {<a name="line.925"></a> |
| <span class="sourceLineNo">926</span> builder = recursiveMethod.invoke(builder);<a name="line.926"></a> |
| <span class="sourceLineNo">927</span> }<a name="line.927"></a> |
| <span class="sourceLineNo">928</span> builder = replicateMethod.invoke(builder);<a name="line.928"></a> |
| <span class="sourceLineNo">929</span> builder = replicationMethod.invoke(builder, replication);<a name="line.929"></a> |
| <span class="sourceLineNo">930</span> return (FSDataOutputStream) buildMethod.invoke(builder);<a name="line.930"></a> |
| <span class="sourceLineNo">931</span> } catch (IllegalAccessException | InvocationTargetException e) {<a name="line.931"></a> |
| <span class="sourceLineNo">932</span> // Should have caught this failure during initialization, so log full trace here<a name="line.932"></a> |
| <span class="sourceLineNo">933</span> LOG.warn("Couldn't use reflection with builder API", e);<a name="line.933"></a> |
| <span class="sourceLineNo">934</span> }<a name="line.934"></a> |
| <span class="sourceLineNo">935</span> }<a name="line.935"></a> |
| <span class="sourceLineNo">936</span><a name="line.936"></a> |
| <span class="sourceLineNo">937</span> if (isRecursive) {<a name="line.937"></a> |
| <span class="sourceLineNo">938</span> return fs.create(path, overwritable, bufferSize, replication, blockSize, null);<a name="line.938"></a> |
| <span class="sourceLineNo">939</span> }<a name="line.939"></a> |
| <span class="sourceLineNo">940</span> return fs.createNonRecursive(path, overwritable, bufferSize, replication, blockSize, null);<a name="line.940"></a> |
| <span class="sourceLineNo">941</span> }<a name="line.941"></a> |
| <span class="sourceLineNo">942</span><a name="line.942"></a> |
| <span class="sourceLineNo">943</span> /**<a name="line.943"></a> |
| <span class="sourceLineNo">944</span> * Attempt to use builder API via reflection to create a file with the given parameters and<a name="line.944"></a> |
| <span class="sourceLineNo">945</span> * replication enabled.<a name="line.945"></a> |
| <span class="sourceLineNo">946</span> */<a name="line.946"></a> |
| <span class="sourceLineNo">947</span> static FSDataOutputStream createHelper(FileSystem fs, Path path, boolean overwritable)<a name="line.947"></a> |
| <span class="sourceLineNo">948</span> throws IOException {<a name="line.948"></a> |
| <span class="sourceLineNo">949</span> if (allMethodsPresent && dfsClass.isInstance(fs)) {<a name="line.949"></a> |
| <span class="sourceLineNo">950</span> try {<a name="line.950"></a> |
| <span class="sourceLineNo">951</span> Object builder;<a name="line.951"></a> |
| <span class="sourceLineNo">952</span><a name="line.952"></a> |
| <span class="sourceLineNo">953</span> builder = createMethod.invoke(fs, path);<a name="line.953"></a> |
| <span class="sourceLineNo">954</span> builder = overwriteMethod.invoke(builder, overwritable);<a name="line.954"></a> |
| <span class="sourceLineNo">955</span> builder = replicateMethod.invoke(builder);<a name="line.955"></a> |
| <span class="sourceLineNo">956</span> return (FSDataOutputStream) buildMethod.invoke(builder);<a name="line.956"></a> |
| <span class="sourceLineNo">957</span> } catch (IllegalAccessException | InvocationTargetException e) {<a name="line.957"></a> |
| <span class="sourceLineNo">958</span> // Should have caught this failure during initialization, so log full trace here<a name="line.958"></a> |
| <span class="sourceLineNo">959</span> LOG.warn("Couldn't use reflection with builder API", e);<a name="line.959"></a> |
| <span class="sourceLineNo">960</span> }<a name="line.960"></a> |
| <span class="sourceLineNo">961</span> }<a name="line.961"></a> |
| <span class="sourceLineNo">962</span><a name="line.962"></a> |
| <span class="sourceLineNo">963</span> return fs.create(path, overwritable);<a name="line.963"></a> |
| <span class="sourceLineNo">964</span> }<a name="line.964"></a> |
| <span class="sourceLineNo">965</span> }<a name="line.965"></a> |
| <span class="sourceLineNo">966</span><a name="line.966"></a> |
| <span class="sourceLineNo">967</span> /**<a name="line.967"></a> |
| <span class="sourceLineNo">968</span> * Attempt to use builder API via reflection to create a file with the given parameters and<a name="line.968"></a> |
| <span class="sourceLineNo">969</span> * replication enabled.<a name="line.969"></a> |
| <span class="sourceLineNo">970</span> * <p><a name="line.970"></a> |
| <span class="sourceLineNo">971</span> * Will not attempt to enable replication when passed an HFileSystem.<a name="line.971"></a> |
| <span class="sourceLineNo">972</span> */<a name="line.972"></a> |
| <span class="sourceLineNo">973</span> public static FSDataOutputStream createForWal(FileSystem fs, Path path, boolean overwritable)<a name="line.973"></a> |
| <span class="sourceLineNo">974</span> throws IOException {<a name="line.974"></a> |
| <span class="sourceLineNo">975</span> return DfsBuilderUtility.createHelper(fs, path, overwritable);<a name="line.975"></a> |
| <span class="sourceLineNo">976</span> }<a name="line.976"></a> |
| <span class="sourceLineNo">977</span><a name="line.977"></a> |
| <span class="sourceLineNo">978</span> /**<a name="line.978"></a> |
| <span class="sourceLineNo">979</span> * Attempt to use builder API via reflection to create a file with the given parameters and<a name="line.979"></a> |
| <span class="sourceLineNo">980</span> * replication enabled.<a name="line.980"></a> |
| <span class="sourceLineNo">981</span> * <p><a name="line.981"></a> |
| <span class="sourceLineNo">982</span> * Will not attempt to enable replication when passed an HFileSystem.<a name="line.982"></a> |
| <span class="sourceLineNo">983</span> */<a name="line.983"></a> |
| <span class="sourceLineNo">984</span> public static FSDataOutputStream createForWal(FileSystem fs, Path path, boolean overwritable,<a name="line.984"></a> |
| <span class="sourceLineNo">985</span> int bufferSize, short replication, long blockSize, boolean isRecursive) throws IOException {<a name="line.985"></a> |
| <span class="sourceLineNo">986</span> return DfsBuilderUtility.createHelper(fs, path, overwritable, bufferSize, replication,<a name="line.986"></a> |
| <span class="sourceLineNo">987</span> blockSize, isRecursive);<a name="line.987"></a> |
| <span class="sourceLineNo">988</span> }<a name="line.988"></a> |
| <span class="sourceLineNo">989</span><a name="line.989"></a> |
| <span class="sourceLineNo">990</span> // Holder singleton idiom. JVM spec ensures this will be run at most once per Classloader, and<a name="line.990"></a> |
| <span class="sourceLineNo">991</span> // not until we attempt to reference it.<a name="line.991"></a> |
| <span class="sourceLineNo">992</span> private static class StreamCapabilities {<a name="line.992"></a> |
| <span class="sourceLineNo">993</span> public static final boolean PRESENT;<a name="line.993"></a> |
| <span class="sourceLineNo">994</span> public static final Class<?> CLASS;<a name="line.994"></a> |
| <span class="sourceLineNo">995</span> public static final Method METHOD;<a name="line.995"></a> |
| <span class="sourceLineNo">996</span> static {<a name="line.996"></a> |
| <span class="sourceLineNo">997</span> boolean tmp = false;<a name="line.997"></a> |
| <span class="sourceLineNo">998</span> Class<?> clazz = null;<a name="line.998"></a> |
| <span class="sourceLineNo">999</span> Method method = null;<a name="line.999"></a> |
| <span class="sourceLineNo">1000</span> try {<a name="line.1000"></a> |
| <span class="sourceLineNo">1001</span> clazz = Class.forName("org.apache.hadoop.fs.StreamCapabilities");<a name="line.1001"></a> |
| <span class="sourceLineNo">1002</span> method = clazz.getMethod("hasCapability", String.class);<a name="line.1002"></a> |
| <span class="sourceLineNo">1003</span> tmp = true;<a name="line.1003"></a> |
| <span class="sourceLineNo">1004</span> } catch(ClassNotFoundException|NoSuchMethodException|SecurityException exception) {<a name="line.1004"></a> |
| <span class="sourceLineNo">1005</span> LOG.warn("Your Hadoop installation does not include the StreamCapabilities class from " +<a name="line.1005"></a> |
| <span class="sourceLineNo">1006</span> "HDFS-11644, so we will skip checking if any FSDataOutputStreams actually " +<a name="line.1006"></a> |
| <span class="sourceLineNo">1007</span> "support hflush/hsync. If you are running on top of HDFS this probably just " +<a name="line.1007"></a> |
| <span class="sourceLineNo">1008</span> "means you have an older version and this can be ignored. If you are running on " +<a name="line.1008"></a> |
| <span class="sourceLineNo">1009</span> "top of an alternate FileSystem implementation you should manually verify that " +<a name="line.1009"></a> |
| <span class="sourceLineNo">1010</span> "hflush and hsync are implemented; otherwise you risk data loss and hard to " +<a name="line.1010"></a> |
| <span class="sourceLineNo">1011</span> "diagnose errors when our assumptions are violated.");<a name="line.1011"></a> |
| <span class="sourceLineNo">1012</span> LOG.debug("The first request to check for StreamCapabilities came from this stacktrace.",<a name="line.1012"></a> |
| <span class="sourceLineNo">1013</span> exception);<a name="line.1013"></a> |
| <span class="sourceLineNo">1014</span> } finally {<a name="line.1014"></a> |
| <span class="sourceLineNo">1015</span> PRESENT = tmp;<a name="line.1015"></a> |
| <span class="sourceLineNo">1016</span> CLASS = clazz;<a name="line.1016"></a> |
| <span class="sourceLineNo">1017</span> METHOD = method;<a name="line.1017"></a> |
| <span class="sourceLineNo">1018</span> }<a name="line.1018"></a> |
| <span class="sourceLineNo">1019</span> }<a name="line.1019"></a> |
| <span class="sourceLineNo">1020</span> }<a name="line.1020"></a> |
| <span class="sourceLineNo">1021</span><a name="line.1021"></a> |
| <span class="sourceLineNo">1022</span> /**<a name="line.1022"></a> |
| <span class="sourceLineNo">1023</span> * If our FileSystem version includes the StreamCapabilities class, check if<a name="line.1023"></a> |
| <span class="sourceLineNo">1024</span> * the given stream has a particular capability.<a name="line.1024"></a> |
| <span class="sourceLineNo">1025</span> * @param stream capabilities are per-stream instance, so check this one specifically. must not be<a name="line.1025"></a> |
| <span class="sourceLineNo">1026</span> * null<a name="line.1026"></a> |
| <span class="sourceLineNo">1027</span> * @param capability what to look for, per Hadoop Common's FileSystem docs<a name="line.1027"></a> |
| <span class="sourceLineNo">1028</span> * @return true if there are no StreamCapabilities. false if there are, but this stream doesn't<a name="line.1028"></a> |
| <span class="sourceLineNo">1029</span> * implement it. return result of asking the stream otherwise.<a name="line.1029"></a> |
| <span class="sourceLineNo">1030</span> */<a name="line.1030"></a> |
| <span class="sourceLineNo">1031</span> public static boolean hasCapability(FSDataOutputStream stream, String capability) {<a name="line.1031"></a> |
| <span class="sourceLineNo">1032</span> // be consistent whether or not StreamCapabilities is present<a name="line.1032"></a> |
| <span class="sourceLineNo">1033</span> if (stream == null) {<a name="line.1033"></a> |
| <span class="sourceLineNo">1034</span> throw new NullPointerException("stream parameter must not be null.");<a name="line.1034"></a> |
| <span class="sourceLineNo">1035</span> }<a name="line.1035"></a> |
| <span class="sourceLineNo">1036</span> // If o.a.h.fs.StreamCapabilities doesn't exist, assume everyone does everything<a name="line.1036"></a> |
| <span class="sourceLineNo">1037</span> // otherwise old versions of Hadoop will break.<a name="line.1037"></a> |
| <span class="sourceLineNo">1038</span> boolean result = true;<a name="line.1038"></a> |
| <span class="sourceLineNo">1039</span> if (StreamCapabilities.PRESENT) {<a name="line.1039"></a> |
| <span class="sourceLineNo">1040</span> // if StreamCapabilities is present, but the stream doesn't implement it<a name="line.1040"></a> |
| <span class="sourceLineNo">1041</span> // or we run into a problem invoking the method,<a name="line.1041"></a> |
| <span class="sourceLineNo">1042</span> // we treat that as equivalent to not declaring anything<a name="line.1042"></a> |
| <span class="sourceLineNo">1043</span> result = false;<a name="line.1043"></a> |
| <span class="sourceLineNo">1044</span> if (StreamCapabilities.CLASS.isAssignableFrom(stream.getClass())) {<a name="line.1044"></a> |
| <span class="sourceLineNo">1045</span> try {<a name="line.1045"></a> |
| <span class="sourceLineNo">1046</span> result = ((Boolean)StreamCapabilities.METHOD.invoke(stream, capability)).booleanValue();<a name="line.1046"></a> |
| <span class="sourceLineNo">1047</span> } catch (IllegalAccessException|IllegalArgumentException|InvocationTargetException<a name="line.1047"></a> |
| <span class="sourceLineNo">1048</span> exception) {<a name="line.1048"></a> |
| <span class="sourceLineNo">1049</span> LOG.warn("Your Hadoop installation's StreamCapabilities implementation doesn't match " +<a name="line.1049"></a> |
| <span class="sourceLineNo">1050</span> "our understanding of how it's supposed to work. Please file a JIRA and include " +<a name="line.1050"></a> |
| <span class="sourceLineNo">1051</span> "the following stack trace. In the mean time we're interpreting this behavior " +<a name="line.1051"></a> |
| <span class="sourceLineNo">1052</span> "difference as a lack of capability support, which will probably cause a failure.",<a name="line.1052"></a> |
| <span class="sourceLineNo">1053</span> exception);<a name="line.1053"></a> |
| <span class="sourceLineNo">1054</span> }<a name="line.1054"></a> |
| <span class="sourceLineNo">1055</span> }<a name="line.1055"></a> |
| <span class="sourceLineNo">1056</span> }<a name="line.1056"></a> |
| <span class="sourceLineNo">1057</span> return result;<a name="line.1057"></a> |
| <span class="sourceLineNo">1058</span> }<a name="line.1058"></a> |
| <span class="sourceLineNo">1059</span><a name="line.1059"></a> |
| <span class="sourceLineNo">1060</span> /**<a name="line.1060"></a> |
| <span class="sourceLineNo">1061</span> * Helper exception for those cases where the place where we need to check a stream capability<a name="line.1061"></a> |
| <span class="sourceLineNo">1062</span> * is not where we have the needed context to explain the impact and mitigation for a lack.<a name="line.1062"></a> |
| <span class="sourceLineNo">1063</span> */<a name="line.1063"></a> |
| <span class="sourceLineNo">1064</span> public static class StreamLacksCapabilityException extends Exception {<a name="line.1064"></a> |
| <span class="sourceLineNo">1065</span> public StreamLacksCapabilityException(String message, Throwable cause) {<a name="line.1065"></a> |
| <span class="sourceLineNo">1066</span> super(message, cause);<a name="line.1066"></a> |
| <span class="sourceLineNo">1067</span> }<a name="line.1067"></a> |
| <span class="sourceLineNo">1068</span> public StreamLacksCapabilityException(String message) {<a name="line.1068"></a> |
| <span class="sourceLineNo">1069</span> super(message);<a name="line.1069"></a> |
| <span class="sourceLineNo">1070</span> }<a name="line.1070"></a> |
| <span class="sourceLineNo">1071</span> }<a name="line.1071"></a> |
| <span class="sourceLineNo">1072</span>}<a name="line.1072"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
