| <!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> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> */<a name="line.17"></a> |
| <span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.fs;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.Collection;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.Objects;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.stream.Collectors;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.hadoop.conf.Configuration;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.hadoop.fs.FSDataOutputStream;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.hadoop.fs.FileSystem;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.hadoop.fs.Path;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.DoNotRetryIOException;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.HBaseIOException;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.HConstants;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.TableName;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.client.TableDescriptor;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.util.CommonFSUtils;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.hadoop.hdfs.DistributedFileSystem;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.hadoop.hdfs.protocol.ErasureCodingPolicyInfo;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.slf4j.Logger;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.slf4j.LoggerFactory;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span><a name="line.39"></a> |
| <span class="sourceLineNo">040</span>@InterfaceAudience.Private<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>public final class ErasureCodingUtils {<a name="line.41"></a> |
| <span class="sourceLineNo">042</span><a name="line.42"></a> |
| <span class="sourceLineNo">043</span> private ErasureCodingUtils() {<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> }<a name="line.44"></a> |
| <span class="sourceLineNo">045</span><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> private static final Logger LOG = LoggerFactory.getLogger(ErasureCodingUtils.class);<a name="line.46"></a> |
| <span class="sourceLineNo">047</span><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> /**<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * Runs checks against the FileSystem, verifying that HDFS is supported and the policy is<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * available, enabled, and works with a simple write.<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> */<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> public static void verifySupport(Configuration conf, String policy) throws HBaseIOException {<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> DistributedFileSystem dfs = getDfs(conf);<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> checkAvailable(dfs, policy);<a name="line.54"></a> |
| <span class="sourceLineNo">055</span><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> // Enable the policy on a test directory. Try writing ot it to ensure that HDFS allows it<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> // This acts as a safeguard against topology issues (not enough nodes for policy, etc) and<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> // anything else. This is otherwise hard to validate more directly.<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> Path globalTempDir = new Path(conf.get(HConstants.HBASE_DIR), HConstants.HBASE_TEMP_DIRECTORY);<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> Path currentTempDir = createTempDir(dfs, globalTempDir);<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> try {<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> setPolicy(dfs, currentTempDir, policy);<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> try (FSDataOutputStream out = dfs.create(new Path(currentTempDir, "test.out"))) {<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> out.writeUTF("Testing " + policy);<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> }<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> } catch (IOException e) {<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> throw new DoNotRetryIOException("Failed write test for EC policy. Check cause or logs", e);<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> } finally {<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> try {<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> dfs.delete(currentTempDir, true);<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> } catch (IOException e) {<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> LOG.warn("Failed to delete temp path for ec test", e);<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><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> private static Path createTempDir(FileSystem fs, Path tempDir) throws HBaseIOException {<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> Path currentTempDir = new Path(tempDir, "ec-test-" + System.currentTimeMillis());<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> try {<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> fs.mkdirs(currentTempDir);<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> fs.deleteOnExit(currentTempDir);<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> } catch (IOException e) {<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> throw new HBaseIOException("Failed to create test dir for EC write test", e);<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> }<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> return currentTempDir;<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> }<a name="line.86"></a> |
| <span class="sourceLineNo">087</span><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> private static void checkAvailable(DistributedFileSystem dfs, String policy)<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> throws HBaseIOException {<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> Collection<ErasureCodingPolicyInfo> policies;<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> try {<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> policies = dfs.getAllErasureCodingPolicies();<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> } catch (IOException e) {<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> throw new HBaseIOException("Failed to check for Erasure Coding policy: " + policy, e);<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> }<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> for (ErasureCodingPolicyInfo policyInfo : policies) {<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> if (policyInfo.getPolicy().getName().equals(policy)) {<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> if (!policyInfo.isEnabled()) {<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> throw new DoNotRetryIOException("Cannot set Erasure Coding policy: " + policy<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> + ". The policy must be enabled, but has state " + policyInfo.getState());<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> }<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> return;<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> }<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> }<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> throw new DoNotRetryIOException(<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> "Cannot set Erasure Coding policy: " + policy + ". Policy not found. Available policies are: "<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> + policies.stream().map(p -> p.getPolicy().getName()).collect(Collectors.joining(", ")));<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> }<a name="line.108"></a> |
| <span class="sourceLineNo">109</span><a name="line.109"></a> |
| <span class="sourceLineNo">110</span> /**<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * Check if EC policy is different between two descriptors<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * @return true if a sync is necessary<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> */<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> public static boolean needsSync(TableDescriptor oldDescriptor, TableDescriptor newDescriptor) {<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> String newPolicy = oldDescriptor.getErasureCodingPolicy();<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> String oldPolicy = newDescriptor.getErasureCodingPolicy();<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> return !Objects.equals(oldPolicy, newPolicy);<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> }<a name="line.118"></a> |
| <span class="sourceLineNo">119</span><a name="line.119"></a> |
| <span class="sourceLineNo">120</span> /**<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * Sync the EC policy state from the newDescriptor onto the FS for the table dir of the provided<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * table descriptor. If the policy is null, we will remove erasure coding from the FS for the<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> * table dir. If it's non-null, we'll set it to that policy.<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * @param newDescriptor descriptor containing the policy and table name<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> */<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> public static void sync(FileSystem fs, Path rootDir, TableDescriptor newDescriptor)<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> throws IOException {<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> String newPolicy = newDescriptor.getErasureCodingPolicy();<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> if (newPolicy == null) {<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> unsetPolicy(fs, rootDir, newDescriptor.getTableName());<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> } else {<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> setPolicy(fs, rootDir, newDescriptor.getTableName(), newPolicy);<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> /**<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * Sets the EC policy on the table directory for the specified table<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> */<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> public static void setPolicy(FileSystem fs, Path rootDir, TableName tableName, String policy)<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> throws IOException {<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> Path path = CommonFSUtils.getTableDir(rootDir, tableName);<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> setPolicy(fs, path, policy);<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> }<a name="line.143"></a> |
| <span class="sourceLineNo">144</span><a name="line.144"></a> |
| <span class="sourceLineNo">145</span> /**<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> * Sets the EC policy on the path<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> */<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> public static void setPolicy(FileSystem fs, Path path, String policy) throws IOException {<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> getDfs(fs).setErasureCodingPolicy(path, policy);<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> }<a name="line.150"></a> |
| <span class="sourceLineNo">151</span><a name="line.151"></a> |
| <span class="sourceLineNo">152</span> /**<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> * Unsets any EC policy specified on the path.<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> */<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> public static void unsetPolicy(FileSystem fs, Path rootDir, TableName tableName)<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> throws IOException {<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> DistributedFileSystem dfs = getDfs(fs);<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> Path path = CommonFSUtils.getTableDir(rootDir, tableName);<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> if (dfs.getErasureCodingPolicy(path) == null) {<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> LOG.warn("No EC policy set for path {}, nothing to unset", path);<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> return;<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> }<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> dfs.unsetErasureCodingPolicy(path);<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> }<a name="line.164"></a> |
| <span class="sourceLineNo">165</span><a name="line.165"></a> |
| <span class="sourceLineNo">166</span> private static DistributedFileSystem getDfs(Configuration conf) throws HBaseIOException {<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> try {<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> return getDfs(FileSystem.get(conf));<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> } catch (DoNotRetryIOException e) {<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> throw e;<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> } catch (IOException e) {<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> throw new HBaseIOException("Failed to get FileSystem from conf", e);<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> }<a name="line.173"></a> |
| <span class="sourceLineNo">174</span><a name="line.174"></a> |
| <span class="sourceLineNo">175</span> }<a name="line.175"></a> |
| <span class="sourceLineNo">176</span><a name="line.176"></a> |
| <span class="sourceLineNo">177</span> private static DistributedFileSystem getDfs(FileSystem fs) throws DoNotRetryIOException {<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> if (!(fs instanceof DistributedFileSystem)) {<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> throw new DoNotRetryIOException(<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> "Cannot manage Erasure Coding policy. Erasure Coding is only available on HDFS, but fs is "<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> + fs.getClass().getSimpleName());<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> }<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> return (DistributedFileSystem) fs;<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> }<a name="line.184"></a> |
| <span class="sourceLineNo">185</span>}<a name="line.185"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
