blob: 343d139539e5c308178796c2abac3d90ea985959 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Source code</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="source: package: org.apache.hadoop.hbase.util, class: CommonFSUtils, class: StreamLacksCapabilityException">
<meta name="generator" content="javadoc/SourceToHTMLConverter">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body class="source-page">
<main role="main">
<div class="source-container">
<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span>
<span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span>
<span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span>
<span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span>
<span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span>
<span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span>
<span class="source-line-no">009</span><span id="line-9"> *</span>
<span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="source-line-no">011</span><span id="line-11"> *</span>
<span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span>
<span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span>
<span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span>
<span class="source-line-no">017</span><span id="line-17"> */</span>
<span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.util;</span>
<span class="source-line-no">019</span><span id="line-19"></span>
<span class="source-line-no">020</span><span id="line-20">import static org.apache.hadoop.fs.CommonPathCapabilities.FS_STORAGEPOLICY;</span>
<span class="source-line-no">021</span><span id="line-21"></span>
<span class="source-line-no">022</span><span id="line-22">import java.io.FileNotFoundException;</span>
<span class="source-line-no">023</span><span id="line-23">import java.io.IOException;</span>
<span class="source-line-no">024</span><span id="line-24">import java.net.URI;</span>
<span class="source-line-no">025</span><span id="line-25">import java.net.URISyntaxException;</span>
<span class="source-line-no">026</span><span id="line-26">import java.util.List;</span>
<span class="source-line-no">027</span><span id="line-27">import java.util.Locale;</span>
<span class="source-line-no">028</span><span id="line-28">import java.util.Map;</span>
<span class="source-line-no">029</span><span id="line-29">import java.util.concurrent.ConcurrentHashMap;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.fs.FSDataOutputStream;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.fs.FileStatus;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.fs.FileSystem;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.fs.LocatedFileStatus;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.fs.Path;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.fs.PathFilter;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.fs.RemoteIterator;</span>
<span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.fs.permission.FsPermission;</span>
<span class="source-line-no">039</span><span id="line-39">import org.apache.hadoop.hbase.HConstants;</span>
<span class="source-line-no">040</span><span id="line-40">import org.apache.hadoop.hbase.TableName;</span>
<span class="source-line-no">041</span><span id="line-41">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">042</span><span id="line-42">import org.slf4j.Logger;</span>
<span class="source-line-no">043</span><span id="line-43">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">044</span><span id="line-44"></span>
<span class="source-line-no">045</span><span id="line-45">import org.apache.hbase.thirdparty.com.google.common.collect.Lists;</span>
<span class="source-line-no">046</span><span id="line-46"></span>
<span class="source-line-no">047</span><span id="line-47">/**</span>
<span class="source-line-no">048</span><span id="line-48"> * Utility methods for interacting with the underlying file system.</span>
<span class="source-line-no">049</span><span id="line-49"> * &lt;p/&gt;</span>
<span class="source-line-no">050</span><span id="line-50"> * Note that {@link #setStoragePolicy(FileSystem, Path, String)} is tested in TestFSUtils and</span>
<span class="source-line-no">051</span><span id="line-51"> * pre-commit will run the hbase-server tests if there's code change in this class. See</span>
<span class="source-line-no">052</span><span id="line-52"> * &lt;a href="https://issues.apache.org/jira/browse/HBASE-20838"&gt;HBASE-20838&lt;/a&gt; for more details.</span>
<span class="source-line-no">053</span><span id="line-53"> */</span>
<span class="source-line-no">054</span><span id="line-54">@InterfaceAudience.Private</span>
<span class="source-line-no">055</span><span id="line-55">public final class CommonFSUtils {</span>
<span class="source-line-no">056</span><span id="line-56"> private static final Logger LOG = LoggerFactory.getLogger(CommonFSUtils.class);</span>
<span class="source-line-no">057</span><span id="line-57"></span>
<span class="source-line-no">058</span><span id="line-58"> /** Parameter name for HBase WAL directory */</span>
<span class="source-line-no">059</span><span id="line-59"> public static final String HBASE_WAL_DIR = "hbase.wal.dir";</span>
<span class="source-line-no">060</span><span id="line-60"></span>
<span class="source-line-no">061</span><span id="line-61"> /** Parameter to disable stream capability enforcement checks */</span>
<span class="source-line-no">062</span><span id="line-62"> public static final String UNSAFE_STREAM_CAPABILITY_ENFORCE =</span>
<span class="source-line-no">063</span><span id="line-63"> "hbase.unsafe.stream.capability.enforce";</span>
<span class="source-line-no">064</span><span id="line-64"></span>
<span class="source-line-no">065</span><span id="line-65"> /** Full access permissions (starting point for a umask) */</span>
<span class="source-line-no">066</span><span id="line-66"> public static final String FULL_RWX_PERMISSIONS = "777";</span>
<span class="source-line-no">067</span><span id="line-67"></span>
<span class="source-line-no">068</span><span id="line-68"> private CommonFSUtils() {</span>
<span class="source-line-no">069</span><span id="line-69"> }</span>
<span class="source-line-no">070</span><span id="line-70"></span>
<span class="source-line-no">071</span><span id="line-71"> /**</span>
<span class="source-line-no">072</span><span id="line-72"> * Compare of path component. Does not consider schema; i.e. if schemas different but</span>
<span class="source-line-no">073</span><span id="line-73"> * &lt;code&gt;path&lt;/code&gt; starts with &lt;code&gt;rootPath&lt;/code&gt;, then the function returns true</span>
<span class="source-line-no">074</span><span id="line-74"> * @param rootPath value to check for</span>
<span class="source-line-no">075</span><span id="line-75"> * @param path subject to check</span>
<span class="source-line-no">076</span><span id="line-76"> * @return True if &lt;code&gt;path&lt;/code&gt; starts with &lt;code&gt;rootPath&lt;/code&gt;</span>
<span class="source-line-no">077</span><span id="line-77"> */</span>
<span class="source-line-no">078</span><span id="line-78"> public static boolean isStartingWithPath(final Path rootPath, final String path) {</span>
<span class="source-line-no">079</span><span id="line-79"> String uriRootPath = rootPath.toUri().getPath();</span>
<span class="source-line-no">080</span><span id="line-80"> String tailUriPath = new Path(path).toUri().getPath();</span>
<span class="source-line-no">081</span><span id="line-81"> return tailUriPath.startsWith(uriRootPath);</span>
<span class="source-line-no">082</span><span id="line-82"> }</span>
<span class="source-line-no">083</span><span id="line-83"></span>
<span class="source-line-no">084</span><span id="line-84"> /**</span>
<span class="source-line-no">085</span><span id="line-85"> * Compare path component of the Path URI; e.g. if hdfs://a/b/c and /a/b/c, it will compare the</span>
<span class="source-line-no">086</span><span id="line-86"> * '/a/b/c' part. Does not consider schema; i.e. if schemas different but path or subpath matches,</span>
<span class="source-line-no">087</span><span id="line-87"> * the two will equate.</span>
<span class="source-line-no">088</span><span id="line-88"> * @param pathToSearch Path we will be trying to match against.</span>
<span class="source-line-no">089</span><span id="line-89"> * @param pathTail what to match</span>
<span class="source-line-no">090</span><span id="line-90"> * @return True if &lt;code&gt;pathTail&lt;/code&gt; is tail on the path of &lt;code&gt;pathToSearch&lt;/code&gt;</span>
<span class="source-line-no">091</span><span id="line-91"> */</span>
<span class="source-line-no">092</span><span id="line-92"> public static boolean isMatchingTail(final Path pathToSearch, String pathTail) {</span>
<span class="source-line-no">093</span><span id="line-93"> return isMatchingTail(pathToSearch, new Path(pathTail));</span>
<span class="source-line-no">094</span><span id="line-94"> }</span>
<span class="source-line-no">095</span><span id="line-95"></span>
<span class="source-line-no">096</span><span id="line-96"> /**</span>
<span class="source-line-no">097</span><span id="line-97"> * Compare path component of the Path URI; e.g. if hdfs://a/b/c and /a/b/c, it will compare the</span>
<span class="source-line-no">098</span><span id="line-98"> * '/a/b/c' part. If you passed in 'hdfs://a/b/c and b/c, it would return true. Does not consider</span>
<span class="source-line-no">099</span><span id="line-99"> * schema; i.e. if schemas different but path or subpath matches, the two will equate.</span>
<span class="source-line-no">100</span><span id="line-100"> * @param pathToSearch Path we will be trying to match agains against</span>
<span class="source-line-no">101</span><span id="line-101"> * @param pathTail what to match</span>
<span class="source-line-no">102</span><span id="line-102"> * @return True if &lt;code&gt;pathTail&lt;/code&gt; is tail on the path of &lt;code&gt;pathToSearch&lt;/code&gt;</span>
<span class="source-line-no">103</span><span id="line-103"> */</span>
<span class="source-line-no">104</span><span id="line-104"> public static boolean isMatchingTail(final Path pathToSearch, final Path pathTail) {</span>
<span class="source-line-no">105</span><span id="line-105"> if (pathToSearch.depth() != pathTail.depth()) {</span>
<span class="source-line-no">106</span><span id="line-106"> return false;</span>
<span class="source-line-no">107</span><span id="line-107"> }</span>
<span class="source-line-no">108</span><span id="line-108"> Path tailPath = pathTail;</span>
<span class="source-line-no">109</span><span id="line-109"> String tailName;</span>
<span class="source-line-no">110</span><span id="line-110"> Path toSearch = pathToSearch;</span>
<span class="source-line-no">111</span><span id="line-111"> String toSearchName;</span>
<span class="source-line-no">112</span><span id="line-112"> boolean result = false;</span>
<span class="source-line-no">113</span><span id="line-113"> do {</span>
<span class="source-line-no">114</span><span id="line-114"> tailName = tailPath.getName();</span>
<span class="source-line-no">115</span><span id="line-115"> if (tailName == null || tailName.length() &lt;= 0) {</span>
<span class="source-line-no">116</span><span id="line-116"> result = true;</span>
<span class="source-line-no">117</span><span id="line-117"> break;</span>
<span class="source-line-no">118</span><span id="line-118"> }</span>
<span class="source-line-no">119</span><span id="line-119"> toSearchName = toSearch.getName();</span>
<span class="source-line-no">120</span><span id="line-120"> if (toSearchName == null || toSearchName.length() &lt;= 0) {</span>
<span class="source-line-no">121</span><span id="line-121"> break;</span>
<span class="source-line-no">122</span><span id="line-122"> }</span>
<span class="source-line-no">123</span><span id="line-123"> // Move up a parent on each path for next go around. Path doesn't let us go off the end.</span>
<span class="source-line-no">124</span><span id="line-124"> tailPath = tailPath.getParent();</span>
<span class="source-line-no">125</span><span id="line-125"> toSearch = toSearch.getParent();</span>
<span class="source-line-no">126</span><span id="line-126"> } while (tailName.equals(toSearchName));</span>
<span class="source-line-no">127</span><span id="line-127"> return result;</span>
<span class="source-line-no">128</span><span id="line-128"> }</span>
<span class="source-line-no">129</span><span id="line-129"></span>
<span class="source-line-no">130</span><span id="line-130"> /**</span>
<span class="source-line-no">131</span><span id="line-131"> * Delete if exists.</span>
<span class="source-line-no">132</span><span id="line-132"> * @param fs filesystem object</span>
<span class="source-line-no">133</span><span id="line-133"> * @param dir directory to delete</span>
<span class="source-line-no">134</span><span id="line-134"> * @return True if deleted &lt;code&gt;dir&lt;/code&gt;</span>
<span class="source-line-no">135</span><span id="line-135"> * @throws IOException e</span>
<span class="source-line-no">136</span><span id="line-136"> */</span>
<span class="source-line-no">137</span><span id="line-137"> public static boolean deleteDirectory(final FileSystem fs, final Path dir) throws IOException {</span>
<span class="source-line-no">138</span><span id="line-138"> return fs.exists(dir) &amp;&amp; fs.delete(dir, true);</span>
<span class="source-line-no">139</span><span id="line-139"> }</span>
<span class="source-line-no">140</span><span id="line-140"></span>
<span class="source-line-no">141</span><span id="line-141"> /**</span>
<span class="source-line-no">142</span><span id="line-142"> * Return the number of bytes that large input files should be optimally be split into to minimize</span>
<span class="source-line-no">143</span><span id="line-143"> * i/o time.</span>
<span class="source-line-no">144</span><span id="line-144"> * @param fs filesystem object</span>
<span class="source-line-no">145</span><span id="line-145"> * @return the default block size for the path's filesystem</span>
<span class="source-line-no">146</span><span id="line-146"> */</span>
<span class="source-line-no">147</span><span id="line-147"> public static long getDefaultBlockSize(final FileSystem fs, final Path path) {</span>
<span class="source-line-no">148</span><span id="line-148"> return fs.getDefaultBlockSize(path);</span>
<span class="source-line-no">149</span><span id="line-149"> }</span>
<span class="source-line-no">150</span><span id="line-150"></span>
<span class="source-line-no">151</span><span id="line-151"> /*</span>
<span class="source-line-no">152</span><span id="line-152"> * Get the default replication.</span>
<span class="source-line-no">153</span><span id="line-153"> * @param fs filesystem object</span>
<span class="source-line-no">154</span><span id="line-154"> * @param f path of file</span>
<span class="source-line-no">155</span><span id="line-155"> * @return default replication for the path's filesystem</span>
<span class="source-line-no">156</span><span id="line-156"> */</span>
<span class="source-line-no">157</span><span id="line-157"> public static short getDefaultReplication(final FileSystem fs, final Path path) {</span>
<span class="source-line-no">158</span><span id="line-158"> return fs.getDefaultReplication(path);</span>
<span class="source-line-no">159</span><span id="line-159"> }</span>
<span class="source-line-no">160</span><span id="line-160"></span>
<span class="source-line-no">161</span><span id="line-161"> /**</span>
<span class="source-line-no">162</span><span id="line-162"> * Returns the default buffer size to use during writes. The size of the buffer should probably be</span>
<span class="source-line-no">163</span><span id="line-163"> * a multiple of hardware page size (4096 on Intel x86), and it determines how much data is</span>
<span class="source-line-no">164</span><span id="line-164"> * buffered during read and write operations.</span>
<span class="source-line-no">165</span><span id="line-165"> * @param fs filesystem object</span>
<span class="source-line-no">166</span><span id="line-166"> * @return default buffer size to use during writes</span>
<span class="source-line-no">167</span><span id="line-167"> */</span>
<span class="source-line-no">168</span><span id="line-168"> public static int getDefaultBufferSize(final FileSystem fs) {</span>
<span class="source-line-no">169</span><span id="line-169"> return fs.getConf().getInt("io.file.buffer.size", 4096);</span>
<span class="source-line-no">170</span><span id="line-170"> }</span>
<span class="source-line-no">171</span><span id="line-171"></span>
<span class="source-line-no">172</span><span id="line-172"> /**</span>
<span class="source-line-no">173</span><span id="line-173"> * Create the specified file on the filesystem. By default, this will:</span>
<span class="source-line-no">174</span><span id="line-174"> * &lt;ol&gt;</span>
<span class="source-line-no">175</span><span id="line-175"> * &lt;li&gt;apply the umask in the configuration (if it is enabled)&lt;/li&gt;</span>
<span class="source-line-no">176</span><span id="line-176"> * &lt;li&gt;use the fs configured buffer size (or 4096 if not set)&lt;/li&gt;</span>
<span class="source-line-no">177</span><span id="line-177"> * &lt;li&gt;use the default replication&lt;/li&gt;</span>
<span class="source-line-no">178</span><span id="line-178"> * &lt;li&gt;use the default block size&lt;/li&gt;</span>
<span class="source-line-no">179</span><span id="line-179"> * &lt;li&gt;not track progress&lt;/li&gt;</span>
<span class="source-line-no">180</span><span id="line-180"> * &lt;/ol&gt;</span>
<span class="source-line-no">181</span><span id="line-181"> * @param fs {@link FileSystem} on which to write the file</span>
<span class="source-line-no">182</span><span id="line-182"> * @param path {@link Path} to the file to write</span>
<span class="source-line-no">183</span><span id="line-183"> * @param perm intial permissions</span>
<span class="source-line-no">184</span><span id="line-184"> * @param overwrite Whether or not the created file should be overwritten.</span>
<span class="source-line-no">185</span><span id="line-185"> * @return output stream to the created file</span>
<span class="source-line-no">186</span><span id="line-186"> * @throws IOException if the file cannot be created</span>
<span class="source-line-no">187</span><span id="line-187"> */</span>
<span class="source-line-no">188</span><span id="line-188"> public static FSDataOutputStream create(FileSystem fs, Path path, FsPermission perm,</span>
<span class="source-line-no">189</span><span id="line-189"> boolean overwrite) throws IOException {</span>
<span class="source-line-no">190</span><span id="line-190"> if (LOG.isTraceEnabled()) {</span>
<span class="source-line-no">191</span><span id="line-191"> LOG.trace("Creating file={} with permission={}, overwrite={}", path, perm, overwrite);</span>
<span class="source-line-no">192</span><span id="line-192"> }</span>
<span class="source-line-no">193</span><span id="line-193"> return fs.create(path, perm, overwrite, getDefaultBufferSize(fs),</span>
<span class="source-line-no">194</span><span id="line-194"> getDefaultReplication(fs, path), getDefaultBlockSize(fs, path), null);</span>
<span class="source-line-no">195</span><span id="line-195"> }</span>
<span class="source-line-no">196</span><span id="line-196"></span>
<span class="source-line-no">197</span><span id="line-197"> /**</span>
<span class="source-line-no">198</span><span id="line-198"> * Get the file permissions specified in the configuration, if they are enabled.</span>
<span class="source-line-no">199</span><span id="line-199"> * @param fs filesystem that the file will be created on.</span>
<span class="source-line-no">200</span><span id="line-200"> * @param conf configuration to read for determining if permissions are enabled and</span>
<span class="source-line-no">201</span><span id="line-201"> * which to use</span>
<span class="source-line-no">202</span><span id="line-202"> * @param permssionConfKey property key in the configuration to use when finding the permission</span>
<span class="source-line-no">203</span><span id="line-203"> * @return the permission to use when creating a new file on the fs. If special permissions are</span>
<span class="source-line-no">204</span><span id="line-204"> * not specified in the configuration, then the default permissions on the the fs will be</span>
<span class="source-line-no">205</span><span id="line-205"> * returned.</span>
<span class="source-line-no">206</span><span id="line-206"> */</span>
<span class="source-line-no">207</span><span id="line-207"> public static FsPermission getFilePermissions(final FileSystem fs, final Configuration conf,</span>
<span class="source-line-no">208</span><span id="line-208"> final String permssionConfKey) {</span>
<span class="source-line-no">209</span><span id="line-209"> boolean enablePermissions = conf.getBoolean(HConstants.ENABLE_DATA_FILE_UMASK, false);</span>
<span class="source-line-no">210</span><span id="line-210"></span>
<span class="source-line-no">211</span><span id="line-211"> if (enablePermissions) {</span>
<span class="source-line-no">212</span><span id="line-212"> try {</span>
<span class="source-line-no">213</span><span id="line-213"> FsPermission perm = new FsPermission(FULL_RWX_PERMISSIONS);</span>
<span class="source-line-no">214</span><span id="line-214"> // make sure that we have a mask, if not, go default.</span>
<span class="source-line-no">215</span><span id="line-215"> String mask = conf.get(permssionConfKey);</span>
<span class="source-line-no">216</span><span id="line-216"> if (mask == null) {</span>
<span class="source-line-no">217</span><span id="line-217"> return FsPermission.getFileDefault();</span>
<span class="source-line-no">218</span><span id="line-218"> }</span>
<span class="source-line-no">219</span><span id="line-219"> // appy the umask</span>
<span class="source-line-no">220</span><span id="line-220"> FsPermission umask = new FsPermission(mask);</span>
<span class="source-line-no">221</span><span id="line-221"> return perm.applyUMask(umask);</span>
<span class="source-line-no">222</span><span id="line-222"> } catch (IllegalArgumentException e) {</span>
<span class="source-line-no">223</span><span id="line-223"> LOG.warn("Incorrect umask attempted to be created: " + conf.get(permssionConfKey)</span>
<span class="source-line-no">224</span><span id="line-224"> + ", using default file permissions.", e);</span>
<span class="source-line-no">225</span><span id="line-225"> return FsPermission.getFileDefault();</span>
<span class="source-line-no">226</span><span id="line-226"> }</span>
<span class="source-line-no">227</span><span id="line-227"> }</span>
<span class="source-line-no">228</span><span id="line-228"> return FsPermission.getFileDefault();</span>
<span class="source-line-no">229</span><span id="line-229"> }</span>
<span class="source-line-no">230</span><span id="line-230"></span>
<span class="source-line-no">231</span><span id="line-231"> /**</span>
<span class="source-line-no">232</span><span id="line-232"> * Verifies root directory path is a valid URI with a scheme</span>
<span class="source-line-no">233</span><span id="line-233"> * @param root root directory path</span>
<span class="source-line-no">234</span><span id="line-234"> * @return Passed &lt;code&gt;root&lt;/code&gt; argument.</span>
<span class="source-line-no">235</span><span id="line-235"> * @throws IOException if not a valid URI with a scheme</span>
<span class="source-line-no">236</span><span id="line-236"> */</span>
<span class="source-line-no">237</span><span id="line-237"> public static Path validateRootPath(Path root) throws IOException {</span>
<span class="source-line-no">238</span><span id="line-238"> try {</span>
<span class="source-line-no">239</span><span id="line-239"> URI rootURI = new URI(root.toString());</span>
<span class="source-line-no">240</span><span id="line-240"> String scheme = rootURI.getScheme();</span>
<span class="source-line-no">241</span><span id="line-241"> if (scheme == null) {</span>
<span class="source-line-no">242</span><span id="line-242"> throw new IOException("Root directory does not have a scheme");</span>
<span class="source-line-no">243</span><span id="line-243"> }</span>
<span class="source-line-no">244</span><span id="line-244"> return root;</span>
<span class="source-line-no">245</span><span id="line-245"> } catch (URISyntaxException e) {</span>
<span class="source-line-no">246</span><span id="line-246"> throw new IOException("Root directory path is not a valid " + "URI -- check your "</span>
<span class="source-line-no">247</span><span id="line-247"> + HConstants.HBASE_DIR + " configuration", e);</span>
<span class="source-line-no">248</span><span id="line-248"> }</span>
<span class="source-line-no">249</span><span id="line-249"> }</span>
<span class="source-line-no">250</span><span id="line-250"></span>
<span class="source-line-no">251</span><span id="line-251"> /**</span>
<span class="source-line-no">252</span><span id="line-252"> * Checks for the presence of the WAL log root path (using the provided conf object) in the given</span>
<span class="source-line-no">253</span><span id="line-253"> * path. If it exists, this method removes it and returns the String representation of remaining</span>
<span class="source-line-no">254</span><span id="line-254"> * relative path.</span>
<span class="source-line-no">255</span><span id="line-255"> * @param path must not be null</span>
<span class="source-line-no">256</span><span id="line-256"> * @param conf must not be null</span>
<span class="source-line-no">257</span><span id="line-257"> * @return String representation of the remaining relative path</span>
<span class="source-line-no">258</span><span id="line-258"> * @throws IOException from underlying filesystem</span>
<span class="source-line-no">259</span><span id="line-259"> */</span>
<span class="source-line-no">260</span><span id="line-260"> public static String removeWALRootPath(Path path, final Configuration conf) throws IOException {</span>
<span class="source-line-no">261</span><span id="line-261"> Path root = getWALRootDir(conf);</span>
<span class="source-line-no">262</span><span id="line-262"> String pathStr = path.toString();</span>
<span class="source-line-no">263</span><span id="line-263"> // check that the path is absolute... it has the root path in it.</span>
<span class="source-line-no">264</span><span id="line-264"> if (!pathStr.startsWith(root.toString())) {</span>
<span class="source-line-no">265</span><span id="line-265"> return pathStr;</span>
<span class="source-line-no">266</span><span id="line-266"> }</span>
<span class="source-line-no">267</span><span id="line-267"> // if not, return as it is.</span>
<span class="source-line-no">268</span><span id="line-268"> return pathStr.substring(root.toString().length() + 1);// remove the "/" too.</span>
<span class="source-line-no">269</span><span id="line-269"> }</span>
<span class="source-line-no">270</span><span id="line-270"></span>
<span class="source-line-no">271</span><span id="line-271"> /**</span>
<span class="source-line-no">272</span><span id="line-272"> * Return the 'path' component of a Path. In Hadoop, Path is a URI. This method returns the 'path'</span>
<span class="source-line-no">273</span><span id="line-273"> * component of a Path's URI: e.g. If a Path is</span>
<span class="source-line-no">274</span><span id="line-274"> * &lt;code&gt;hdfs://example.org:9000/hbase_trunk/TestTable/compaction.dir&lt;/code&gt;, this method returns</span>
<span class="source-line-no">275</span><span id="line-275"> * &lt;code&gt;/hbase_trunk/TestTable/compaction.dir&lt;/code&gt;. This method is useful if you want to print</span>
<span class="source-line-no">276</span><span id="line-276"> * out a Path without qualifying Filesystem instance.</span>
<span class="source-line-no">277</span><span id="line-277"> * @param p Filesystem Path whose 'path' component we are to return.</span>
<span class="source-line-no">278</span><span id="line-278"> * @return Path portion of the Filesystem</span>
<span class="source-line-no">279</span><span id="line-279"> */</span>
<span class="source-line-no">280</span><span id="line-280"> public static String getPath(Path p) {</span>
<span class="source-line-no">281</span><span id="line-281"> return p.toUri().getPath();</span>
<span class="source-line-no">282</span><span id="line-282"> }</span>
<span class="source-line-no">283</span><span id="line-283"></span>
<span class="source-line-no">284</span><span id="line-284"> /**</span>
<span class="source-line-no">285</span><span id="line-285"> * Get the path for the root data directory</span>
<span class="source-line-no">286</span><span id="line-286"> * @param c configuration</span>
<span class="source-line-no">287</span><span id="line-287"> * @return {@link Path} to hbase root directory from configuration as a qualified Path.</span>
<span class="source-line-no">288</span><span id="line-288"> * @throws IOException e</span>
<span class="source-line-no">289</span><span id="line-289"> */</span>
<span class="source-line-no">290</span><span id="line-290"> public static Path getRootDir(final Configuration c) throws IOException {</span>
<span class="source-line-no">291</span><span id="line-291"> Path p = new Path(c.get(HConstants.HBASE_DIR));</span>
<span class="source-line-no">292</span><span id="line-292"> FileSystem fs = p.getFileSystem(c);</span>
<span class="source-line-no">293</span><span id="line-293"> return p.makeQualified(fs.getUri(), fs.getWorkingDirectory());</span>
<span class="source-line-no">294</span><span id="line-294"> }</span>
<span class="source-line-no">295</span><span id="line-295"></span>
<span class="source-line-no">296</span><span id="line-296"> public static void setRootDir(final Configuration c, final Path root) {</span>
<span class="source-line-no">297</span><span id="line-297"> c.set(HConstants.HBASE_DIR, root.toString());</span>
<span class="source-line-no">298</span><span id="line-298"> }</span>
<span class="source-line-no">299</span><span id="line-299"></span>
<span class="source-line-no">300</span><span id="line-300"> public static void setFsDefault(final Configuration c, final Path root) {</span>
<span class="source-line-no">301</span><span id="line-301"> c.set("fs.defaultFS", root.toString()); // for hadoop 0.21+</span>
<span class="source-line-no">302</span><span id="line-302"> }</span>
<span class="source-line-no">303</span><span id="line-303"></span>
<span class="source-line-no">304</span><span id="line-304"> public static void setFsDefault(final Configuration c, final String uri) {</span>
<span class="source-line-no">305</span><span id="line-305"> c.set("fs.defaultFS", uri); // for hadoop 0.21+</span>
<span class="source-line-no">306</span><span id="line-306"> }</span>
<span class="source-line-no">307</span><span id="line-307"></span>
<span class="source-line-no">308</span><span id="line-308"> public static FileSystem getRootDirFileSystem(final Configuration c) throws IOException {</span>
<span class="source-line-no">309</span><span id="line-309"> Path p = getRootDir(c);</span>
<span class="source-line-no">310</span><span id="line-310"> return p.getFileSystem(c);</span>
<span class="source-line-no">311</span><span id="line-311"> }</span>
<span class="source-line-no">312</span><span id="line-312"></span>
<span class="source-line-no">313</span><span id="line-313"> /**</span>
<span class="source-line-no">314</span><span id="line-314"> * Get the path for the root directory for WAL data</span>
<span class="source-line-no">315</span><span id="line-315"> * @param c configuration</span>
<span class="source-line-no">316</span><span id="line-316"> * @return {@link Path} to hbase log root directory: e.g. {@value HBASE_WAL_DIR} from</span>
<span class="source-line-no">317</span><span id="line-317"> * configuration as a qualified Path. Defaults to HBase root dir.</span>
<span class="source-line-no">318</span><span id="line-318"> * @throws IOException e</span>
<span class="source-line-no">319</span><span id="line-319"> */</span>
<span class="source-line-no">320</span><span id="line-320"> public static Path getWALRootDir(final Configuration c) throws IOException {</span>
<span class="source-line-no">321</span><span id="line-321"> Path p = new Path(c.get(HBASE_WAL_DIR, c.get(HConstants.HBASE_DIR)));</span>
<span class="source-line-no">322</span><span id="line-322"> if (!isValidWALRootDir(p, c)) {</span>
<span class="source-line-no">323</span><span id="line-323"> return getRootDir(c);</span>
<span class="source-line-no">324</span><span id="line-324"> }</span>
<span class="source-line-no">325</span><span id="line-325"> FileSystem fs = p.getFileSystem(c);</span>
<span class="source-line-no">326</span><span id="line-326"> return p.makeQualified(fs.getUri(), fs.getWorkingDirectory());</span>
<span class="source-line-no">327</span><span id="line-327"> }</span>
<span class="source-line-no">328</span><span id="line-328"></span>
<span class="source-line-no">329</span><span id="line-329"> /**</span>
<span class="source-line-no">330</span><span id="line-330"> * Returns the URI in the string format</span>
<span class="source-line-no">331</span><span id="line-331"> * @param c configuration</span>
<span class="source-line-no">332</span><span id="line-332"> * @param p path</span>
<span class="source-line-no">333</span><span id="line-333"> * @return - the URI's to string format</span>
<span class="source-line-no">334</span><span id="line-334"> */</span>
<span class="source-line-no">335</span><span id="line-335"> public static String getDirUri(final Configuration c, Path p) throws IOException {</span>
<span class="source-line-no">336</span><span id="line-336"> if (p.toUri().getScheme() != null) {</span>
<span class="source-line-no">337</span><span id="line-337"> return p.toUri().toString();</span>
<span class="source-line-no">338</span><span id="line-338"> }</span>
<span class="source-line-no">339</span><span id="line-339"> return null;</span>
<span class="source-line-no">340</span><span id="line-340"> }</span>
<span class="source-line-no">341</span><span id="line-341"></span>
<span class="source-line-no">342</span><span id="line-342"> public static void setWALRootDir(final Configuration c, final Path root) {</span>
<span class="source-line-no">343</span><span id="line-343"> c.set(HBASE_WAL_DIR, root.toString());</span>
<span class="source-line-no">344</span><span id="line-344"> }</span>
<span class="source-line-no">345</span><span id="line-345"></span>
<span class="source-line-no">346</span><span id="line-346"> public static FileSystem getWALFileSystem(final Configuration c) throws IOException {</span>
<span class="source-line-no">347</span><span id="line-347"> Path p = getWALRootDir(c);</span>
<span class="source-line-no">348</span><span id="line-348"> FileSystem fs = p.getFileSystem(c);</span>
<span class="source-line-no">349</span><span id="line-349"> // hadoop-core does fs caching, so need to propagate this if set</span>
<span class="source-line-no">350</span><span id="line-350"> String enforceStreamCapability = c.get(UNSAFE_STREAM_CAPABILITY_ENFORCE);</span>
<span class="source-line-no">351</span><span id="line-351"> if (enforceStreamCapability != null) {</span>
<span class="source-line-no">352</span><span id="line-352"> fs.getConf().set(UNSAFE_STREAM_CAPABILITY_ENFORCE, enforceStreamCapability);</span>
<span class="source-line-no">353</span><span id="line-353"> }</span>
<span class="source-line-no">354</span><span id="line-354"> return fs;</span>
<span class="source-line-no">355</span><span id="line-355"> }</span>
<span class="source-line-no">356</span><span id="line-356"></span>
<span class="source-line-no">357</span><span id="line-357"> private static boolean isValidWALRootDir(Path walDir, final Configuration c) throws IOException {</span>
<span class="source-line-no">358</span><span id="line-358"> Path rootDir = getRootDir(c);</span>
<span class="source-line-no">359</span><span id="line-359"> FileSystem fs = walDir.getFileSystem(c);</span>
<span class="source-line-no">360</span><span id="line-360"> Path qualifiedWalDir = walDir.makeQualified(fs.getUri(), fs.getWorkingDirectory());</span>
<span class="source-line-no">361</span><span id="line-361"> if (!qualifiedWalDir.equals(rootDir)) {</span>
<span class="source-line-no">362</span><span id="line-362"> if (qualifiedWalDir.toString().startsWith(rootDir.toString() + "/")) {</span>
<span class="source-line-no">363</span><span id="line-363"> throw new IllegalStateException("Illegal WAL directory specified. "</span>
<span class="source-line-no">364</span><span id="line-364"> + "WAL directories are not permitted to be under root directory: rootDir="</span>
<span class="source-line-no">365</span><span id="line-365"> + rootDir.toString() + ", qualifiedWALDir=" + qualifiedWalDir);</span>
<span class="source-line-no">366</span><span id="line-366"> }</span>
<span class="source-line-no">367</span><span id="line-367"> }</span>
<span class="source-line-no">368</span><span id="line-368"> return true;</span>
<span class="source-line-no">369</span><span id="line-369"> }</span>
<span class="source-line-no">370</span><span id="line-370"></span>
<span class="source-line-no">371</span><span id="line-371"> /**</span>
<span class="source-line-no">372</span><span id="line-372"> * Returns the WAL region directory based on the given table name and region name</span>
<span class="source-line-no">373</span><span id="line-373"> * @param conf configuration to determine WALRootDir</span>
<span class="source-line-no">374</span><span id="line-374"> * @param tableName Table that the region is under</span>
<span class="source-line-no">375</span><span id="line-375"> * @param encodedRegionName Region name used for creating the final region directory</span>
<span class="source-line-no">376</span><span id="line-376"> * @return the region directory used to store WALs under the WALRootDir</span>
<span class="source-line-no">377</span><span id="line-377"> * @throws IOException if there is an exception determining the WALRootDir</span>
<span class="source-line-no">378</span><span id="line-378"> */</span>
<span class="source-line-no">379</span><span id="line-379"> public static Path getWALRegionDir(final Configuration conf, final TableName tableName,</span>
<span class="source-line-no">380</span><span id="line-380"> final String encodedRegionName) throws IOException {</span>
<span class="source-line-no">381</span><span id="line-381"> return new Path(getWALTableDir(conf, tableName), encodedRegionName);</span>
<span class="source-line-no">382</span><span id="line-382"> }</span>
<span class="source-line-no">383</span><span id="line-383"></span>
<span class="source-line-no">384</span><span id="line-384"> /**</span>
<span class="source-line-no">385</span><span id="line-385"> * Returns the Table directory under the WALRootDir for the specified table name</span>
<span class="source-line-no">386</span><span id="line-386"> * @param conf configuration used to get the WALRootDir</span>
<span class="source-line-no">387</span><span id="line-387"> * @param tableName Table to get the directory for</span>
<span class="source-line-no">388</span><span id="line-388"> * @return a path to the WAL table directory for the specified table</span>
<span class="source-line-no">389</span><span id="line-389"> * @throws IOException if there is an exception determining the WALRootDir</span>
<span class="source-line-no">390</span><span id="line-390"> */</span>
<span class="source-line-no">391</span><span id="line-391"> public static Path getWALTableDir(final Configuration conf, final TableName tableName)</span>
<span class="source-line-no">392</span><span id="line-392"> throws IOException {</span>
<span class="source-line-no">393</span><span id="line-393"> Path baseDir = new Path(getWALRootDir(conf), HConstants.BASE_NAMESPACE_DIR);</span>
<span class="source-line-no">394</span><span id="line-394"> return new Path(new Path(baseDir, tableName.getNamespaceAsString()),</span>
<span class="source-line-no">395</span><span id="line-395"> tableName.getQualifierAsString());</span>
<span class="source-line-no">396</span><span id="line-396"> }</span>
<span class="source-line-no">397</span><span id="line-397"></span>
<span class="source-line-no">398</span><span id="line-398"> /**</span>
<span class="source-line-no">399</span><span id="line-399"> * For backward compatibility with HBASE-20734, where we store recovered edits in a wrong</span>
<span class="source-line-no">400</span><span id="line-400"> * directory without BASE_NAMESPACE_DIR. See HBASE-22617 for more details.</span>
<span class="source-line-no">401</span><span id="line-401"> * @deprecated For compatibility, will be removed in 4.0.0.</span>
<span class="source-line-no">402</span><span id="line-402"> */</span>
<span class="source-line-no">403</span><span id="line-403"> @Deprecated</span>
<span class="source-line-no">404</span><span id="line-404"> public static Path getWrongWALRegionDir(final Configuration conf, final TableName tableName,</span>
<span class="source-line-no">405</span><span id="line-405"> final String encodedRegionName) throws IOException {</span>
<span class="source-line-no">406</span><span id="line-406"> Path wrongTableDir = new Path(new Path(getWALRootDir(conf), tableName.getNamespaceAsString()),</span>
<span class="source-line-no">407</span><span id="line-407"> tableName.getQualifierAsString());</span>
<span class="source-line-no">408</span><span id="line-408"> return new Path(wrongTableDir, encodedRegionName);</span>
<span class="source-line-no">409</span><span id="line-409"> }</span>
<span class="source-line-no">410</span><span id="line-410"></span>
<span class="source-line-no">411</span><span id="line-411"> /**</span>
<span class="source-line-no">412</span><span id="line-412"> * Returns the {@link org.apache.hadoop.fs.Path} object representing the table directory under</span>
<span class="source-line-no">413</span><span id="line-413"> * path rootdir</span>
<span class="source-line-no">414</span><span id="line-414"> * @param rootdir qualified path of HBase root directory</span>
<span class="source-line-no">415</span><span id="line-415"> * @param tableName name of table</span>
<span class="source-line-no">416</span><span id="line-416"> * @return {@link org.apache.hadoop.fs.Path} for table</span>
<span class="source-line-no">417</span><span id="line-417"> */</span>
<span class="source-line-no">418</span><span id="line-418"> public static Path getTableDir(Path rootdir, final TableName tableName) {</span>
<span class="source-line-no">419</span><span id="line-419"> return new Path(getNamespaceDir(rootdir, tableName.getNamespaceAsString()),</span>
<span class="source-line-no">420</span><span id="line-420"> tableName.getQualifierAsString());</span>
<span class="source-line-no">421</span><span id="line-421"> }</span>
<span class="source-line-no">422</span><span id="line-422"></span>
<span class="source-line-no">423</span><span id="line-423"> /**</span>
<span class="source-line-no">424</span><span id="line-424"> * Returns the {@link org.apache.hadoop.fs.Path} object representing the region directory under</span>
<span class="source-line-no">425</span><span id="line-425"> * path rootdir</span>
<span class="source-line-no">426</span><span id="line-426"> * @param rootdir qualified path of HBase root directory</span>
<span class="source-line-no">427</span><span id="line-427"> * @param tableName name of table</span>
<span class="source-line-no">428</span><span id="line-428"> * @param regionName The encoded region name</span>
<span class="source-line-no">429</span><span id="line-429"> * @return {@link org.apache.hadoop.fs.Path} for region</span>
<span class="source-line-no">430</span><span id="line-430"> */</span>
<span class="source-line-no">431</span><span id="line-431"> public static Path getRegionDir(Path rootdir, TableName tableName, String regionName) {</span>
<span class="source-line-no">432</span><span id="line-432"> return new Path(getTableDir(rootdir, tableName), regionName);</span>
<span class="source-line-no">433</span><span id="line-433"> }</span>
<span class="source-line-no">434</span><span id="line-434"></span>
<span class="source-line-no">435</span><span id="line-435"> /**</span>
<span class="source-line-no">436</span><span id="line-436"> * Returns the {@link org.apache.hadoop.hbase.TableName} object representing the table directory</span>
<span class="source-line-no">437</span><span id="line-437"> * under path rootdir</span>
<span class="source-line-no">438</span><span id="line-438"> * @param tablePath path of table</span>
<span class="source-line-no">439</span><span id="line-439"> * @return {@link org.apache.hadoop.fs.Path} for table</span>
<span class="source-line-no">440</span><span id="line-440"> */</span>
<span class="source-line-no">441</span><span id="line-441"> public static TableName getTableName(Path tablePath) {</span>
<span class="source-line-no">442</span><span id="line-442"> return TableName.valueOf(tablePath.getParent().getName(), tablePath.getName());</span>
<span class="source-line-no">443</span><span id="line-443"> }</span>
<span class="source-line-no">444</span><span id="line-444"></span>
<span class="source-line-no">445</span><span id="line-445"> /**</span>
<span class="source-line-no">446</span><span id="line-446"> * Returns the {@link org.apache.hadoop.fs.Path} object representing the namespace directory under</span>
<span class="source-line-no">447</span><span id="line-447"> * path rootdir</span>
<span class="source-line-no">448</span><span id="line-448"> * @param rootdir qualified path of HBase root directory</span>
<span class="source-line-no">449</span><span id="line-449"> * @param namespace namespace name</span>
<span class="source-line-no">450</span><span id="line-450"> * @return {@link org.apache.hadoop.fs.Path} for table</span>
<span class="source-line-no">451</span><span id="line-451"> */</span>
<span class="source-line-no">452</span><span id="line-452"> public static Path getNamespaceDir(Path rootdir, final String namespace) {</span>
<span class="source-line-no">453</span><span id="line-453"> return new Path(rootdir, new Path(HConstants.BASE_NAMESPACE_DIR, new Path(namespace)));</span>
<span class="source-line-no">454</span><span id="line-454"> }</span>
<span class="source-line-no">455</span><span id="line-455"></span>
<span class="source-line-no">456</span><span id="line-456"> // this mapping means that under a federated FileSystem implementation, we'll</span>
<span class="source-line-no">457</span><span id="line-457"> // only log the first failure from any of the underlying FileSystems at WARN and all others</span>
<span class="source-line-no">458</span><span id="line-458"> // will be at DEBUG.</span>
<span class="source-line-no">459</span><span id="line-459"> private static final Map&lt;FileSystem, Boolean&gt; warningMap = new ConcurrentHashMap&lt;&gt;();</span>
<span class="source-line-no">460</span><span id="line-460"></span>
<span class="source-line-no">461</span><span id="line-461"> /**</span>
<span class="source-line-no">462</span><span id="line-462"> * Sets storage policy for given path. If the passed path is a directory, we'll set the storage</span>
<span class="source-line-no">463</span><span id="line-463"> * policy for all files created in the future in said directory. Note that this change in storage</span>
<span class="source-line-no">464</span><span id="line-464"> * policy takes place at the FileSystem level; it will persist beyond this RS's lifecycle. If</span>
<span class="source-line-no">465</span><span id="line-465"> * we're running on a version of FileSystem that doesn't support the given storage policy (or</span>
<span class="source-line-no">466</span><span id="line-466"> * storage policies at all), then we'll issue a log message and continue. See</span>
<span class="source-line-no">467</span><span id="line-467"> * http://hadoop.apache.org/docs/r2.6.0/hadoop-project-dist/hadoop-hdfs/ArchivalStorage.html</span>
<span class="source-line-no">468</span><span id="line-468"> * @param fs We only do anything it implements a setStoragePolicy method</span>
<span class="source-line-no">469</span><span id="line-469"> * @param path the Path whose storage policy is to be set</span>
<span class="source-line-no">470</span><span id="line-470"> * @param storagePolicy Policy to set on &lt;code&gt;path&lt;/code&gt;; see hadoop 2.6+</span>
<span class="source-line-no">471</span><span id="line-471"> * org.apache.hadoop.hdfs.protocol.HdfsConstants for possible list e.g</span>
<span class="source-line-no">472</span><span id="line-472"> * 'COLD', 'WARM', 'HOT', 'ONE_SSD', 'ALL_SSD', 'LAZY_PERSIST'.</span>
<span class="source-line-no">473</span><span id="line-473"> */</span>
<span class="source-line-no">474</span><span id="line-474"> public static void setStoragePolicy(final FileSystem fs, final Path path,</span>
<span class="source-line-no">475</span><span id="line-475"> final String storagePolicy) {</span>
<span class="source-line-no">476</span><span id="line-476"> try {</span>
<span class="source-line-no">477</span><span id="line-477"> setStoragePolicy(fs, path, storagePolicy, false);</span>
<span class="source-line-no">478</span><span id="line-478"> } catch (IOException e) {</span>
<span class="source-line-no">479</span><span id="line-479"> // should never arrive here</span>
<span class="source-line-no">480</span><span id="line-480"> LOG.warn("We have chosen not to throw exception but some unexpectedly thrown out", e);</span>
<span class="source-line-no">481</span><span id="line-481"> }</span>
<span class="source-line-no">482</span><span id="line-482"> }</span>
<span class="source-line-no">483</span><span id="line-483"></span>
<span class="source-line-no">484</span><span id="line-484"> static void setStoragePolicy(final FileSystem fs, final Path path, final String storagePolicy,</span>
<span class="source-line-no">485</span><span id="line-485"> boolean throwException) throws IOException {</span>
<span class="source-line-no">486</span><span id="line-486"> if (storagePolicy == null) {</span>
<span class="source-line-no">487</span><span id="line-487"> if (LOG.isTraceEnabled()) {</span>
<span class="source-line-no">488</span><span id="line-488"> LOG.trace("We were passed a null storagePolicy, exiting early.");</span>
<span class="source-line-no">489</span><span id="line-489"> }</span>
<span class="source-line-no">490</span><span id="line-490"> return;</span>
<span class="source-line-no">491</span><span id="line-491"> }</span>
<span class="source-line-no">492</span><span id="line-492"> String trimmedStoragePolicy = storagePolicy.trim();</span>
<span class="source-line-no">493</span><span id="line-493"> if (trimmedStoragePolicy.isEmpty()) {</span>
<span class="source-line-no">494</span><span id="line-494"> LOG.trace("We were passed an empty storagePolicy, exiting early.");</span>
<span class="source-line-no">495</span><span id="line-495"> return;</span>
<span class="source-line-no">496</span><span id="line-496"> } else {</span>
<span class="source-line-no">497</span><span id="line-497"> trimmedStoragePolicy = trimmedStoragePolicy.toUpperCase(Locale.ROOT);</span>
<span class="source-line-no">498</span><span id="line-498"> }</span>
<span class="source-line-no">499</span><span id="line-499"> if (trimmedStoragePolicy.equals(HConstants.DEFER_TO_HDFS_STORAGE_POLICY)) {</span>
<span class="source-line-no">500</span><span id="line-500"> LOG.trace("We were passed the defer-to-hdfs policy {}, exiting early.", trimmedStoragePolicy);</span>
<span class="source-line-no">501</span><span id="line-501"> return;</span>
<span class="source-line-no">502</span><span id="line-502"> }</span>
<span class="source-line-no">503</span><span id="line-503"> try {</span>
<span class="source-line-no">504</span><span id="line-504"> invokeSetStoragePolicy(fs, path, trimmedStoragePolicy);</span>
<span class="source-line-no">505</span><span id="line-505"> } catch (IOException e) {</span>
<span class="source-line-no">506</span><span id="line-506"> LOG.trace("Failed to invoke set storage policy API on FS", e);</span>
<span class="source-line-no">507</span><span id="line-507"> if (throwException) {</span>
<span class="source-line-no">508</span><span id="line-508"> throw e;</span>
<span class="source-line-no">509</span><span id="line-509"> }</span>
<span class="source-line-no">510</span><span id="line-510"> }</span>
<span class="source-line-no">511</span><span id="line-511"> }</span>
<span class="source-line-no">512</span><span id="line-512"></span>
<span class="source-line-no">513</span><span id="line-513"> /*</span>
<span class="source-line-no">514</span><span id="line-514"> * All args have been checked and are good. Run the setStoragePolicy invocation.</span>
<span class="source-line-no">515</span><span id="line-515"> */</span>
<span class="source-line-no">516</span><span id="line-516"> private static void invokeSetStoragePolicy(final FileSystem fs, final Path path,</span>
<span class="source-line-no">517</span><span id="line-517"> final String storagePolicy) throws IOException {</span>
<span class="source-line-no">518</span><span id="line-518"> Exception toThrow = null;</span>
<span class="source-line-no">519</span><span id="line-519"></span>
<span class="source-line-no">520</span><span id="line-520"> if (!fs.hasPathCapability(path, FS_STORAGEPOLICY)) {</span>
<span class="source-line-no">521</span><span id="line-521"> LOG.debug("The file system does not support storage policy.");</span>
<span class="source-line-no">522</span><span id="line-522"> return;</span>
<span class="source-line-no">523</span><span id="line-523"> }</span>
<span class="source-line-no">524</span><span id="line-524"></span>
<span class="source-line-no">525</span><span id="line-525"> try {</span>
<span class="source-line-no">526</span><span id="line-526"> fs.setStoragePolicy(path, storagePolicy);</span>
<span class="source-line-no">527</span><span id="line-527"> LOG.debug("Set storagePolicy={} for path={}", storagePolicy, path);</span>
<span class="source-line-no">528</span><span id="line-528"> } catch (Exception e) {</span>
<span class="source-line-no">529</span><span id="line-529"> toThrow = e;</span>
<span class="source-line-no">530</span><span id="line-530"> // This swallows FNFE, should we be throwing it? seems more likely to indicate dev</span>
<span class="source-line-no">531</span><span id="line-531"> // misuse than a runtime problem with HDFS.</span>
<span class="source-line-no">532</span><span id="line-532"> if (!warningMap.containsKey(fs)) {</span>
<span class="source-line-no">533</span><span id="line-533"> warningMap.put(fs, true);</span>
<span class="source-line-no">534</span><span id="line-534"> LOG.warn("Unable to set storagePolicy=" + storagePolicy + " for path=" + path + ". "</span>
<span class="source-line-no">535</span><span id="line-535"> + "DEBUG log level might have more details.", e);</span>
<span class="source-line-no">536</span><span id="line-536"> } else if (LOG.isDebugEnabled()) {</span>
<span class="source-line-no">537</span><span id="line-537"> LOG.debug("Unable to set storagePolicy=" + storagePolicy + " for path=" + path, e);</span>
<span class="source-line-no">538</span><span id="line-538"> }</span>
<span class="source-line-no">539</span><span id="line-539"></span>
<span class="source-line-no">540</span><span id="line-540"> // Hadoop 2.8+, 3.0-a1+ added FileSystem.setStoragePolicy with a default implementation</span>
<span class="source-line-no">541</span><span id="line-541"> // that throws UnsupportedOperationException</span>
<span class="source-line-no">542</span><span id="line-542"> if (e instanceof UnsupportedOperationException) {</span>
<span class="source-line-no">543</span><span id="line-543"> if (LOG.isDebugEnabled()) {</span>
<span class="source-line-no">544</span><span id="line-544"> LOG.debug("The underlying FileSystem implementation doesn't support "</span>
<span class="source-line-no">545</span><span id="line-545"> + "setStoragePolicy. This is probably intentional on their part, since HDFS-9345 "</span>
<span class="source-line-no">546</span><span id="line-546"> + "appears to be present in your version of Hadoop. For more information check "</span>
<span class="source-line-no">547</span><span id="line-547"> + "the Hadoop documentation on 'ArchivalStorage', the Hadoop FileSystem "</span>
<span class="source-line-no">548</span><span id="line-548"> + "specification docs from HADOOP-11981, and/or related documentation from the "</span>
<span class="source-line-no">549</span><span id="line-549"> + "provider of the underlying FileSystem (its name should appear in the "</span>
<span class="source-line-no">550</span><span id="line-550"> + "stacktrace that accompanies this message). Note in particular that Hadoop's "</span>
<span class="source-line-no">551</span><span id="line-551"> + "local filesystem implementation doesn't support storage policies.", e);</span>
<span class="source-line-no">552</span><span id="line-552"> }</span>
<span class="source-line-no">553</span><span id="line-553"> }</span>
<span class="source-line-no">554</span><span id="line-554"> }</span>
<span class="source-line-no">555</span><span id="line-555"></span>
<span class="source-line-no">556</span><span id="line-556"> if (toThrow != null) {</span>
<span class="source-line-no">557</span><span id="line-557"> throw new IOException(toThrow);</span>
<span class="source-line-no">558</span><span id="line-558"> }</span>
<span class="source-line-no">559</span><span id="line-559"> }</span>
<span class="source-line-no">560</span><span id="line-560"></span>
<span class="source-line-no">561</span><span id="line-561"> /**</span>
<span class="source-line-no">562</span><span id="line-562"> * Return true if this is a filesystem whose scheme is 'hdfs'.</span>
<span class="source-line-no">563</span><span id="line-563"> * @throws IOException from underlying FileSystem</span>
<span class="source-line-no">564</span><span id="line-564"> */</span>
<span class="source-line-no">565</span><span id="line-565"> public static boolean isHDFS(final Configuration conf) throws IOException {</span>
<span class="source-line-no">566</span><span id="line-566"> FileSystem fs = FileSystem.get(conf);</span>
<span class="source-line-no">567</span><span id="line-567"> String scheme = fs.getUri().getScheme();</span>
<span class="source-line-no">568</span><span id="line-568"> return scheme.equalsIgnoreCase("hdfs");</span>
<span class="source-line-no">569</span><span id="line-569"> }</span>
<span class="source-line-no">570</span><span id="line-570"></span>
<span class="source-line-no">571</span><span id="line-571"> /**</span>
<span class="source-line-no">572</span><span id="line-572"> * Checks if the given path is the one with 'recovered.edits' dir.</span>
<span class="source-line-no">573</span><span id="line-573"> * @param path must not be null</span>
<span class="source-line-no">574</span><span id="line-574"> * @return True if we recovered edits</span>
<span class="source-line-no">575</span><span id="line-575"> */</span>
<span class="source-line-no">576</span><span id="line-576"> public static boolean isRecoveredEdits(Path path) {</span>
<span class="source-line-no">577</span><span id="line-577"> return path.toString().contains(HConstants.RECOVERED_EDITS_DIR);</span>
<span class="source-line-no">578</span><span id="line-578"> }</span>
<span class="source-line-no">579</span><span id="line-579"></span>
<span class="source-line-no">580</span><span id="line-580"> /**</span>
<span class="source-line-no">581</span><span id="line-581"> * Returns the filesystem of the hbase rootdir.</span>
<span class="source-line-no">582</span><span id="line-582"> * @throws IOException from underlying FileSystem</span>
<span class="source-line-no">583</span><span id="line-583"> */</span>
<span class="source-line-no">584</span><span id="line-584"> public static FileSystem getCurrentFileSystem(Configuration conf) throws IOException {</span>
<span class="source-line-no">585</span><span id="line-585"> return getRootDir(conf).getFileSystem(conf);</span>
<span class="source-line-no">586</span><span id="line-586"> }</span>
<span class="source-line-no">587</span><span id="line-587"></span>
<span class="source-line-no">588</span><span id="line-588"> /**</span>
<span class="source-line-no">589</span><span id="line-589"> * Calls fs.listStatus() and treats FileNotFoundException as non-fatal This accommodates</span>
<span class="source-line-no">590</span><span id="line-590"> * differences between hadoop versions, where hadoop 1 does not throw a FileNotFoundException, and</span>
<span class="source-line-no">591</span><span id="line-591"> * return an empty FileStatus[] while Hadoop 2 will throw FileNotFoundException. Where possible,</span>
<span class="source-line-no">592</span><span id="line-592"> * prefer FSUtils#listStatusWithStatusFilter(FileSystem, Path, FileStatusFilter) instead.</span>
<span class="source-line-no">593</span><span id="line-593"> * @param fs file system</span>
<span class="source-line-no">594</span><span id="line-594"> * @param dir directory</span>
<span class="source-line-no">595</span><span id="line-595"> * @param filter path filter</span>
<span class="source-line-no">596</span><span id="line-596"> * @return null if dir is empty or doesn't exist, otherwise FileStatus array</span>
<span class="source-line-no">597</span><span id="line-597"> */</span>
<span class="source-line-no">598</span><span id="line-598"> public static FileStatus[] listStatus(final FileSystem fs, final Path dir,</span>
<span class="source-line-no">599</span><span id="line-599"> final PathFilter filter) throws IOException {</span>
<span class="source-line-no">600</span><span id="line-600"> FileStatus[] status = null;</span>
<span class="source-line-no">601</span><span id="line-601"> try {</span>
<span class="source-line-no">602</span><span id="line-602"> status = filter == null ? fs.listStatus(dir) : fs.listStatus(dir, filter);</span>
<span class="source-line-no">603</span><span id="line-603"> } catch (FileNotFoundException fnfe) {</span>
<span class="source-line-no">604</span><span id="line-604"> // if directory doesn't exist, return null</span>
<span class="source-line-no">605</span><span id="line-605"> if (LOG.isTraceEnabled()) {</span>
<span class="source-line-no">606</span><span id="line-606"> LOG.trace("{} doesn't exist", dir);</span>
<span class="source-line-no">607</span><span id="line-607"> }</span>
<span class="source-line-no">608</span><span id="line-608"> }</span>
<span class="source-line-no">609</span><span id="line-609"> if (status == null || status.length &lt; 1) {</span>
<span class="source-line-no">610</span><span id="line-610"> return null;</span>
<span class="source-line-no">611</span><span id="line-611"> }</span>
<span class="source-line-no">612</span><span id="line-612"> return status;</span>
<span class="source-line-no">613</span><span id="line-613"> }</span>
<span class="source-line-no">614</span><span id="line-614"></span>
<span class="source-line-no">615</span><span id="line-615"> /**</span>
<span class="source-line-no">616</span><span id="line-616"> * Calls fs.listStatus() and treats FileNotFoundException as non-fatal This would accommodates</span>
<span class="source-line-no">617</span><span id="line-617"> * differences between hadoop versions</span>
<span class="source-line-no">618</span><span id="line-618"> * @param fs file system</span>
<span class="source-line-no">619</span><span id="line-619"> * @param dir directory</span>
<span class="source-line-no">620</span><span id="line-620"> * @return null if dir is empty or doesn't exist, otherwise FileStatus array</span>
<span class="source-line-no">621</span><span id="line-621"> */</span>
<span class="source-line-no">622</span><span id="line-622"> public static FileStatus[] listStatus(final FileSystem fs, final Path dir) throws IOException {</span>
<span class="source-line-no">623</span><span id="line-623"> return listStatus(fs, dir, null);</span>
<span class="source-line-no">624</span><span id="line-624"> }</span>
<span class="source-line-no">625</span><span id="line-625"></span>
<span class="source-line-no">626</span><span id="line-626"> /**</span>
<span class="source-line-no">627</span><span id="line-627"> * Calls fs.listFiles() to get FileStatus and BlockLocations together for reducing rpc call</span>
<span class="source-line-no">628</span><span id="line-628"> * @param fs file system</span>
<span class="source-line-no">629</span><span id="line-629"> * @param dir directory</span>
<span class="source-line-no">630</span><span id="line-630"> * @return LocatedFileStatus list</span>
<span class="source-line-no">631</span><span id="line-631"> */</span>
<span class="source-line-no">632</span><span id="line-632"> public static List&lt;LocatedFileStatus&gt; listLocatedStatus(final FileSystem fs, final Path dir)</span>
<span class="source-line-no">633</span><span id="line-633"> throws IOException {</span>
<span class="source-line-no">634</span><span id="line-634"> List&lt;LocatedFileStatus&gt; status = null;</span>
<span class="source-line-no">635</span><span id="line-635"> try {</span>
<span class="source-line-no">636</span><span id="line-636"> RemoteIterator&lt;LocatedFileStatus&gt; locatedFileStatusRemoteIterator = fs.listFiles(dir, false);</span>
<span class="source-line-no">637</span><span id="line-637"> while (locatedFileStatusRemoteIterator.hasNext()) {</span>
<span class="source-line-no">638</span><span id="line-638"> if (status == null) {</span>
<span class="source-line-no">639</span><span id="line-639"> status = Lists.newArrayList();</span>
<span class="source-line-no">640</span><span id="line-640"> }</span>
<span class="source-line-no">641</span><span id="line-641"> status.add(locatedFileStatusRemoteIterator.next());</span>
<span class="source-line-no">642</span><span id="line-642"> }</span>
<span class="source-line-no">643</span><span id="line-643"> } catch (FileNotFoundException fnfe) {</span>
<span class="source-line-no">644</span><span id="line-644"> // if directory doesn't exist, return null</span>
<span class="source-line-no">645</span><span id="line-645"> if (LOG.isTraceEnabled()) {</span>
<span class="source-line-no">646</span><span id="line-646"> LOG.trace("{} doesn't exist", dir);</span>
<span class="source-line-no">647</span><span id="line-647"> }</span>
<span class="source-line-no">648</span><span id="line-648"> }</span>
<span class="source-line-no">649</span><span id="line-649"> return status;</span>
<span class="source-line-no">650</span><span id="line-650"> }</span>
<span class="source-line-no">651</span><span id="line-651"></span>
<span class="source-line-no">652</span><span id="line-652"> /**</span>
<span class="source-line-no">653</span><span id="line-653"> * Calls fs.delete() and returns the value returned by the fs.delete()</span>
<span class="source-line-no">654</span><span id="line-654"> * @param fs must not be null</span>
<span class="source-line-no">655</span><span id="line-655"> * @param path must not be null</span>
<span class="source-line-no">656</span><span id="line-656"> * @param recursive delete tree rooted at path</span>
<span class="source-line-no">657</span><span id="line-657"> * @return the value returned by the fs.delete()</span>
<span class="source-line-no">658</span><span id="line-658"> * @throws IOException from underlying FileSystem</span>
<span class="source-line-no">659</span><span id="line-659"> */</span>
<span class="source-line-no">660</span><span id="line-660"> public static boolean delete(final FileSystem fs, final Path path, final boolean recursive)</span>
<span class="source-line-no">661</span><span id="line-661"> throws IOException {</span>
<span class="source-line-no">662</span><span id="line-662"> return fs.delete(path, recursive);</span>
<span class="source-line-no">663</span><span id="line-663"> }</span>
<span class="source-line-no">664</span><span id="line-664"></span>
<span class="source-line-no">665</span><span id="line-665"> /**</span>
<span class="source-line-no">666</span><span id="line-666"> * Calls fs.exists(). Checks if the specified path exists</span>
<span class="source-line-no">667</span><span id="line-667"> * @param fs must not be null</span>
<span class="source-line-no">668</span><span id="line-668"> * @param path must not be null</span>
<span class="source-line-no">669</span><span id="line-669"> * @return the value returned by fs.exists()</span>
<span class="source-line-no">670</span><span id="line-670"> * @throws IOException from underlying FileSystem</span>
<span class="source-line-no">671</span><span id="line-671"> */</span>
<span class="source-line-no">672</span><span id="line-672"> public static boolean isExists(final FileSystem fs, final Path path) throws IOException {</span>
<span class="source-line-no">673</span><span id="line-673"> return fs.exists(path);</span>
<span class="source-line-no">674</span><span id="line-674"> }</span>
<span class="source-line-no">675</span><span id="line-675"></span>
<span class="source-line-no">676</span><span id="line-676"> /**</span>
<span class="source-line-no">677</span><span id="line-677"> * Log the current state of the filesystem from a certain root directory</span>
<span class="source-line-no">678</span><span id="line-678"> * @param fs filesystem to investigate</span>
<span class="source-line-no">679</span><span id="line-679"> * @param root root file/directory to start logging from</span>
<span class="source-line-no">680</span><span id="line-680"> * @param log log to output information</span>
<span class="source-line-no">681</span><span id="line-681"> * @throws IOException if an unexpected exception occurs</span>
<span class="source-line-no">682</span><span id="line-682"> */</span>
<span class="source-line-no">683</span><span id="line-683"> public static void logFileSystemState(final FileSystem fs, final Path root, Logger log)</span>
<span class="source-line-no">684</span><span id="line-684"> throws IOException {</span>
<span class="source-line-no">685</span><span id="line-685"> log.debug("File system contents for path {}", root);</span>
<span class="source-line-no">686</span><span id="line-686"> logFSTree(log, fs, root, "|-");</span>
<span class="source-line-no">687</span><span id="line-687"> }</span>
<span class="source-line-no">688</span><span id="line-688"></span>
<span class="source-line-no">689</span><span id="line-689"> /**</span>
<span class="source-line-no">690</span><span id="line-690"> * Recursive helper to log the state of the FS</span>
<span class="source-line-no">691</span><span id="line-691"> * @see #logFileSystemState(FileSystem, Path, Logger)</span>
<span class="source-line-no">692</span><span id="line-692"> */</span>
<span class="source-line-no">693</span><span id="line-693"> private static void logFSTree(Logger log, final FileSystem fs, final Path root, String prefix)</span>
<span class="source-line-no">694</span><span id="line-694"> throws IOException {</span>
<span class="source-line-no">695</span><span id="line-695"> FileStatus[] files = listStatus(fs, root, null);</span>
<span class="source-line-no">696</span><span id="line-696"> if (files == null) {</span>
<span class="source-line-no">697</span><span id="line-697"> return;</span>
<span class="source-line-no">698</span><span id="line-698"> }</span>
<span class="source-line-no">699</span><span id="line-699"></span>
<span class="source-line-no">700</span><span id="line-700"> for (FileStatus file : files) {</span>
<span class="source-line-no">701</span><span id="line-701"> if (file.isDirectory()) {</span>
<span class="source-line-no">702</span><span id="line-702"> log.debug(prefix + file.getPath().getName() + "/");</span>
<span class="source-line-no">703</span><span id="line-703"> logFSTree(log, fs, file.getPath(), prefix + "---");</span>
<span class="source-line-no">704</span><span id="line-704"> } else {</span>
<span class="source-line-no">705</span><span id="line-705"> log.debug(prefix + file.getPath().getName());</span>
<span class="source-line-no">706</span><span id="line-706"> }</span>
<span class="source-line-no">707</span><span id="line-707"> }</span>
<span class="source-line-no">708</span><span id="line-708"> }</span>
<span class="source-line-no">709</span><span id="line-709"></span>
<span class="source-line-no">710</span><span id="line-710"> public static boolean renameAndSetModifyTime(final FileSystem fs, final Path src, final Path dest)</span>
<span class="source-line-no">711</span><span id="line-711"> throws IOException {</span>
<span class="source-line-no">712</span><span id="line-712"> // set the modify time for TimeToLive Cleaner</span>
<span class="source-line-no">713</span><span id="line-713"> fs.setTimes(src, EnvironmentEdgeManager.currentTime(), -1);</span>
<span class="source-line-no">714</span><span id="line-714"> return fs.rename(src, dest);</span>
<span class="source-line-no">715</span><span id="line-715"> }</span>
<span class="source-line-no">716</span><span id="line-716"></span>
<span class="source-line-no">717</span><span id="line-717"> /**</span>
<span class="source-line-no">718</span><span id="line-718"> * Check if short circuit read buffer size is set and if not, set it to hbase value.</span>
<span class="source-line-no">719</span><span id="line-719"> * @param conf must not be null</span>
<span class="source-line-no">720</span><span id="line-720"> */</span>
<span class="source-line-no">721</span><span id="line-721"> public static void checkShortCircuitReadBufferSize(final Configuration conf) {</span>
<span class="source-line-no">722</span><span id="line-722"> final int defaultSize = HConstants.DEFAULT_BLOCKSIZE * 2;</span>
<span class="source-line-no">723</span><span id="line-723"> final int notSet = -1;</span>
<span class="source-line-no">724</span><span id="line-724"> // DFSConfigKeys.DFS_CLIENT_READ_SHORTCIRCUIT_BUFFER_SIZE_KEY is only defined in h2</span>
<span class="source-line-no">725</span><span id="line-725"> final String dfsKey = "dfs.client.read.shortcircuit.buffer.size";</span>
<span class="source-line-no">726</span><span id="line-726"> int size = conf.getInt(dfsKey, notSet);</span>
<span class="source-line-no">727</span><span id="line-727"> // If a size is set, return -- we will use it.</span>
<span class="source-line-no">728</span><span id="line-728"> if (size != notSet) {</span>
<span class="source-line-no">729</span><span id="line-729"> return;</span>
<span class="source-line-no">730</span><span id="line-730"> }</span>
<span class="source-line-no">731</span><span id="line-731"> // But short circuit buffer size is normally not set. Put in place the hbase wanted size.</span>
<span class="source-line-no">732</span><span id="line-732"> int hbaseSize = conf.getInt("hbase." + dfsKey, defaultSize);</span>
<span class="source-line-no">733</span><span id="line-733"> conf.setIfUnset(dfsKey, Integer.toString(hbaseSize));</span>
<span class="source-line-no">734</span><span id="line-734"> }</span>
<span class="source-line-no">735</span><span id="line-735"></span>
<span class="source-line-no">736</span><span id="line-736"> /**</span>
<span class="source-line-no">737</span><span id="line-737"> * Helper exception for those cases where the place where we need to check a stream capability is</span>
<span class="source-line-no">738</span><span id="line-738"> * not where we have the needed context to explain the impact and mitigation for a lack.</span>
<span class="source-line-no">739</span><span id="line-739"> */</span>
<span class="source-line-no">740</span><span id="line-740"> public static class StreamLacksCapabilityException extends Exception {</span>
<span class="source-line-no">741</span><span id="line-741"> public StreamLacksCapabilityException(String message, Throwable cause) {</span>
<span class="source-line-no">742</span><span id="line-742"> super(message, cause);</span>
<span class="source-line-no">743</span><span id="line-743"> }</span>
<span class="source-line-no">744</span><span id="line-744"></span>
<span class="source-line-no">745</span><span id="line-745"> public StreamLacksCapabilityException(String message) {</span>
<span class="source-line-no">746</span><span id="line-746"> super(message);</span>
<span class="source-line-no">747</span><span id="line-747"> }</span>
<span class="source-line-no">748</span><span id="line-748"> }</span>
<span class="source-line-no">749</span><span id="line-749">}</span>
</pre>
</div>
</main>
</body>
</html>