blob: d229e7e275c2480ffa2f71431f5b12a9798d771c [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.replication, class: ReplicationUtils">
<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.replication;</span>
<span class="source-line-no">019</span><span id="line-19"></span>
<span class="source-line-no">020</span><span id="line-20">import java.io.IOException;</span>
<span class="source-line-no">021</span><span id="line-21">import java.util.Collection;</span>
<span class="source-line-no">022</span><span id="line-22">import java.util.List;</span>
<span class="source-line-no">023</span><span id="line-23">import java.util.Map;</span>
<span class="source-line-no">024</span><span id="line-24">import java.util.Set;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.fs.FileSystem;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.fs.Path;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.HConstants;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.TableName;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">031</span><span id="line-31">import org.slf4j.Logger;</span>
<span class="source-line-no">032</span><span id="line-32">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">033</span><span id="line-33"></span>
<span class="source-line-no">034</span><span id="line-34">/**</span>
<span class="source-line-no">035</span><span id="line-35"> * Helper class for replication.</span>
<span class="source-line-no">036</span><span id="line-36"> */</span>
<span class="source-line-no">037</span><span id="line-37">@InterfaceAudience.Private</span>
<span class="source-line-no">038</span><span id="line-38">public final class ReplicationUtils {</span>
<span class="source-line-no">039</span><span id="line-39"></span>
<span class="source-line-no">040</span><span id="line-40"> private static final Logger LOG = LoggerFactory.getLogger(ReplicationUtils.class);</span>
<span class="source-line-no">041</span><span id="line-41"></span>
<span class="source-line-no">042</span><span id="line-42"> public static final String REPLICATION_ATTR_NAME = "__rep__";</span>
<span class="source-line-no">043</span><span id="line-43"></span>
<span class="source-line-no">044</span><span id="line-44"> public static final String REMOTE_WAL_DIR_NAME = "remoteWALs";</span>
<span class="source-line-no">045</span><span id="line-45"></span>
<span class="source-line-no">046</span><span id="line-46"> public static final String SYNC_WAL_SUFFIX = ".syncrep";</span>
<span class="source-line-no">047</span><span id="line-47"></span>
<span class="source-line-no">048</span><span id="line-48"> public static final String REMOTE_WAL_REPLAY_SUFFIX = "-replay";</span>
<span class="source-line-no">049</span><span id="line-49"></span>
<span class="source-line-no">050</span><span id="line-50"> public static final String REMOTE_WAL_SNAPSHOT_SUFFIX = "-snapshot";</span>
<span class="source-line-no">051</span><span id="line-51"></span>
<span class="source-line-no">052</span><span id="line-52"> // This is used for copying sync replication log from local to remote and overwrite the old one</span>
<span class="source-line-no">053</span><span id="line-53"> // since some FileSystem implementation may not support atomic rename.</span>
<span class="source-line-no">054</span><span id="line-54"> public static final String RENAME_WAL_SUFFIX = ".ren";</span>
<span class="source-line-no">055</span><span id="line-55"></span>
<span class="source-line-no">056</span><span id="line-56"> public static final String LEGACY_REGION_REPLICATION_ENDPOINT_NAME =</span>
<span class="source-line-no">057</span><span id="line-57"> "org.apache.hadoop.hbase.replication.regionserver.RegionReplicaReplicationEndpoint";</span>
<span class="source-line-no">058</span><span id="line-58"></span>
<span class="source-line-no">059</span><span id="line-59"> private ReplicationUtils() {</span>
<span class="source-line-no">060</span><span id="line-60"> }</span>
<span class="source-line-no">061</span><span id="line-61"></span>
<span class="source-line-no">062</span><span id="line-62"> private static boolean isCollectionEqual(Collection&lt;String&gt; c1, Collection&lt;String&gt; c2) {</span>
<span class="source-line-no">063</span><span id="line-63"> if (c1 == null) {</span>
<span class="source-line-no">064</span><span id="line-64"> return c2 == null;</span>
<span class="source-line-no">065</span><span id="line-65"> }</span>
<span class="source-line-no">066</span><span id="line-66"> if (c2 == null) {</span>
<span class="source-line-no">067</span><span id="line-67"> return false;</span>
<span class="source-line-no">068</span><span id="line-68"> }</span>
<span class="source-line-no">069</span><span id="line-69"> return c1.size() == c2.size() &amp;&amp; c1.containsAll(c2);</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"> private static boolean isNamespacesEqual(Set&lt;String&gt; ns1, Set&lt;String&gt; ns2) {</span>
<span class="source-line-no">073</span><span id="line-73"> return isCollectionEqual(ns1, ns2);</span>
<span class="source-line-no">074</span><span id="line-74"> }</span>
<span class="source-line-no">075</span><span id="line-75"></span>
<span class="source-line-no">076</span><span id="line-76"> private static boolean isTableCFsEqual(Map&lt;TableName, List&lt;String&gt;&gt; tableCFs1,</span>
<span class="source-line-no">077</span><span id="line-77"> Map&lt;TableName, List&lt;String&gt;&gt; tableCFs2) {</span>
<span class="source-line-no">078</span><span id="line-78"> if (tableCFs1 == null) {</span>
<span class="source-line-no">079</span><span id="line-79"> return tableCFs2 == null;</span>
<span class="source-line-no">080</span><span id="line-80"> }</span>
<span class="source-line-no">081</span><span id="line-81"> if (tableCFs2 == null) {</span>
<span class="source-line-no">082</span><span id="line-82"> return false;</span>
<span class="source-line-no">083</span><span id="line-83"> }</span>
<span class="source-line-no">084</span><span id="line-84"> if (tableCFs1.size() != tableCFs2.size()) {</span>
<span class="source-line-no">085</span><span id="line-85"> return false;</span>
<span class="source-line-no">086</span><span id="line-86"> }</span>
<span class="source-line-no">087</span><span id="line-87"> for (Map.Entry&lt;TableName, List&lt;String&gt;&gt; entry1 : tableCFs1.entrySet()) {</span>
<span class="source-line-no">088</span><span id="line-88"> TableName table = entry1.getKey();</span>
<span class="source-line-no">089</span><span id="line-89"> if (!tableCFs2.containsKey(table)) {</span>
<span class="source-line-no">090</span><span id="line-90"> return false;</span>
<span class="source-line-no">091</span><span id="line-91"> }</span>
<span class="source-line-no">092</span><span id="line-92"> List&lt;String&gt; cfs1 = entry1.getValue();</span>
<span class="source-line-no">093</span><span id="line-93"> List&lt;String&gt; cfs2 = tableCFs2.get(table);</span>
<span class="source-line-no">094</span><span id="line-94"> if (!isCollectionEqual(cfs1, cfs2)) {</span>
<span class="source-line-no">095</span><span id="line-95"> return false;</span>
<span class="source-line-no">096</span><span id="line-96"> }</span>
<span class="source-line-no">097</span><span id="line-97"> }</span>
<span class="source-line-no">098</span><span id="line-98"> return true;</span>
<span class="source-line-no">099</span><span id="line-99"> }</span>
<span class="source-line-no">100</span><span id="line-100"></span>
<span class="source-line-no">101</span><span id="line-101"> public static boolean isNamespacesAndTableCFsEqual(ReplicationPeerConfig rpc1,</span>
<span class="source-line-no">102</span><span id="line-102"> ReplicationPeerConfig rpc2) {</span>
<span class="source-line-no">103</span><span id="line-103"> if (rpc1.replicateAllUserTables() != rpc2.replicateAllUserTables()) {</span>
<span class="source-line-no">104</span><span id="line-104"> return false;</span>
<span class="source-line-no">105</span><span id="line-105"> }</span>
<span class="source-line-no">106</span><span id="line-106"> if (rpc1.replicateAllUserTables()) {</span>
<span class="source-line-no">107</span><span id="line-107"> return isNamespacesEqual(rpc1.getExcludeNamespaces(), rpc2.getExcludeNamespaces())</span>
<span class="source-line-no">108</span><span id="line-108"> &amp;&amp; isTableCFsEqual(rpc1.getExcludeTableCFsMap(), rpc2.getExcludeTableCFsMap());</span>
<span class="source-line-no">109</span><span id="line-109"> } else {</span>
<span class="source-line-no">110</span><span id="line-110"> return isNamespacesEqual(rpc1.getNamespaces(), rpc2.getNamespaces())</span>
<span class="source-line-no">111</span><span id="line-111"> &amp;&amp; isTableCFsEqual(rpc1.getTableCFsMap(), rpc2.getTableCFsMap());</span>
<span class="source-line-no">112</span><span id="line-112"> }</span>
<span class="source-line-no">113</span><span id="line-113"> }</span>
<span class="source-line-no">114</span><span id="line-114"></span>
<span class="source-line-no">115</span><span id="line-115"> /**</span>
<span class="source-line-no">116</span><span id="line-116"> * @param c Configuration to look at</span>
<span class="source-line-no">117</span><span id="line-117"> * @return True if replication for bulk load data is enabled.</span>
<span class="source-line-no">118</span><span id="line-118"> */</span>
<span class="source-line-no">119</span><span id="line-119"> public static boolean isReplicationForBulkLoadDataEnabled(final Configuration c) {</span>
<span class="source-line-no">120</span><span id="line-120"> return c.getBoolean(HConstants.REPLICATION_BULKLOAD_ENABLE_KEY,</span>
<span class="source-line-no">121</span><span id="line-121"> HConstants.REPLICATION_BULKLOAD_ENABLE_DEFAULT);</span>
<span class="source-line-no">122</span><span id="line-122"> }</span>
<span class="source-line-no">123</span><span id="line-123"></span>
<span class="source-line-no">124</span><span id="line-124"> public static FileSystem getRemoteWALFileSystem(Configuration conf, String remoteWALDir)</span>
<span class="source-line-no">125</span><span id="line-125"> throws IOException {</span>
<span class="source-line-no">126</span><span id="line-126"> return new Path(remoteWALDir).getFileSystem(conf);</span>
<span class="source-line-no">127</span><span id="line-127"> }</span>
<span class="source-line-no">128</span><span id="line-128"></span>
<span class="source-line-no">129</span><span id="line-129"> public static Path getPeerRemoteWALDir(String remoteWALDir, String peerId) {</span>
<span class="source-line-no">130</span><span id="line-130"> return new Path(remoteWALDir, peerId);</span>
<span class="source-line-no">131</span><span id="line-131"> }</span>
<span class="source-line-no">132</span><span id="line-132"></span>
<span class="source-line-no">133</span><span id="line-133"> public static Path getPeerRemoteWALDir(Path remoteWALDir, String peerId) {</span>
<span class="source-line-no">134</span><span id="line-134"> return new Path(remoteWALDir, peerId);</span>
<span class="source-line-no">135</span><span id="line-135"> }</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 Path getPeerReplayWALDir(Path remoteWALDir, String peerId) {</span>
<span class="source-line-no">138</span><span id="line-138"> return getPeerRemoteWALDir(remoteWALDir, peerId).suffix(REMOTE_WAL_REPLAY_SUFFIX);</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"> public static Path getPeerSnapshotWALDir(String remoteWALDir, String peerId) {</span>
<span class="source-line-no">142</span><span id="line-142"> return getPeerRemoteWALDir(remoteWALDir, peerId).suffix(REMOTE_WAL_SNAPSHOT_SUFFIX);</span>
<span class="source-line-no">143</span><span id="line-143"> }</span>
<span class="source-line-no">144</span><span id="line-144"></span>
<span class="source-line-no">145</span><span id="line-145"> public static Path getPeerSnapshotWALDir(Path remoteWALDir, String peerId) {</span>
<span class="source-line-no">146</span><span id="line-146"> return getPeerRemoteWALDir(remoteWALDir, peerId).suffix(REMOTE_WAL_SNAPSHOT_SUFFIX);</span>
<span class="source-line-no">147</span><span id="line-147"> }</span>
<span class="source-line-no">148</span><span id="line-148"></span>
<span class="source-line-no">149</span><span id="line-149"> /**</span>
<span class="source-line-no">150</span><span id="line-150"> * Do the sleeping logic</span>
<span class="source-line-no">151</span><span id="line-151"> * @param msg Why we sleep</span>
<span class="source-line-no">152</span><span id="line-152"> * @param sleepForRetries the base sleep time.</span>
<span class="source-line-no">153</span><span id="line-153"> * @param sleepMultiplier by how many times the default sleeping time is augmented</span>
<span class="source-line-no">154</span><span id="line-154"> * @param maxRetriesMultiplier the max retry multiplier</span>
<span class="source-line-no">155</span><span id="line-155"> * @return True if &lt;code&gt;sleepMultiplier&lt;/code&gt; is &amp;lt; &lt;code&gt;maxRetriesMultiplier&lt;/code&gt;</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 boolean sleepForRetries(String msg, long sleepForRetries, int sleepMultiplier,</span>
<span class="source-line-no">158</span><span id="line-158"> int maxRetriesMultiplier) {</span>
<span class="source-line-no">159</span><span id="line-159"> try {</span>
<span class="source-line-no">160</span><span id="line-160"> LOG.trace("{}, sleeping {} times {}", msg, sleepForRetries, sleepMultiplier);</span>
<span class="source-line-no">161</span><span id="line-161"> Thread.sleep(sleepForRetries * sleepMultiplier);</span>
<span class="source-line-no">162</span><span id="line-162"> } catch (InterruptedException e) {</span>
<span class="source-line-no">163</span><span id="line-163"> LOG.debug("Interrupted while sleeping between retries");</span>
<span class="source-line-no">164</span><span id="line-164"> Thread.currentThread().interrupt();</span>
<span class="source-line-no">165</span><span id="line-165"> }</span>
<span class="source-line-no">166</span><span id="line-166"> return sleepMultiplier &lt; maxRetriesMultiplier;</span>
<span class="source-line-no">167</span><span id="line-167"> }</span>
<span class="source-line-no">168</span><span id="line-168"></span>
<span class="source-line-no">169</span><span id="line-169"> /**</span>
<span class="source-line-no">170</span><span id="line-170"> * Get the adaptive timeout value when performing a retry</span>
<span class="source-line-no">171</span><span id="line-171"> */</span>
<span class="source-line-no">172</span><span id="line-172"> public static int getAdaptiveTimeout(final int initialValue, final int retries) {</span>
<span class="source-line-no">173</span><span id="line-173"> int ntries = retries;</span>
<span class="source-line-no">174</span><span id="line-174"> if (ntries &gt;= HConstants.RETRY_BACKOFF.length) {</span>
<span class="source-line-no">175</span><span id="line-175"> ntries = HConstants.RETRY_BACKOFF.length - 1;</span>
<span class="source-line-no">176</span><span id="line-176"> }</span>
<span class="source-line-no">177</span><span id="line-177"> if (ntries &lt; 0) {</span>
<span class="source-line-no">178</span><span id="line-178"> ntries = 0;</span>
<span class="source-line-no">179</span><span id="line-179"> }</span>
<span class="source-line-no">180</span><span id="line-180"> return initialValue * HConstants.RETRY_BACKOFF[ntries];</span>
<span class="source-line-no">181</span><span id="line-181"> }</span>
<span class="source-line-no">182</span><span id="line-182">}</span>
</pre>
</div>
</main>
</body>
</html>