| <!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.client, class: RegionReplicaUtil"> |
| <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.client;</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.util.ArrayList;</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.Iterator;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.util.List;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.util.Bytes;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">026</span><span id="line-26"></span> |
| <span class="source-line-no">027</span><span id="line-27">/**</span> |
| <span class="source-line-no">028</span><span id="line-28"> * Utility methods which contain the logic for regions and replicas.</span> |
| <span class="source-line-no">029</span><span id="line-29"> */</span> |
| <span class="source-line-no">030</span><span id="line-30">@InterfaceAudience.Private</span> |
| <span class="source-line-no">031</span><span id="line-31">public class RegionReplicaUtil {</span> |
| <span class="source-line-no">032</span><span id="line-32"></span> |
| <span class="source-line-no">033</span><span id="line-33"> /**</span> |
| <span class="source-line-no">034</span><span id="line-34"> * Whether or not the secondary region will wait for observing a flush / region open event from</span> |
| <span class="source-line-no">035</span><span id="line-35"> * the primary region via async wal replication before enabling read requests. Since replayed</span> |
| <span class="source-line-no">036</span><span id="line-36"> * edits from async wal replication from primary is not persisted in WAL, the memstore of the</span> |
| <span class="source-line-no">037</span><span id="line-37"> * secondary region might be non-empty at the time of close or crash. For ensuring seqId's not</span> |
| <span class="source-line-no">038</span><span id="line-38"> * "going back in time" in the secondary region replica, this should be enabled. However, in some</span> |
| <span class="source-line-no">039</span><span id="line-39"> * cases the above semantics might be ok for some application classes. See HBASE-11580 for more</span> |
| <span class="source-line-no">040</span><span id="line-40"> * context.</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 REGION_REPLICA_WAIT_FOR_PRIMARY_FLUSH_CONF_KEY =</span> |
| <span class="source-line-no">043</span><span id="line-43"> "hbase.region.replica.wait.for.primary.flush";</span> |
| <span class="source-line-no">044</span><span id="line-44"> protected static final boolean DEFAULT_REGION_REPLICA_WAIT_FOR_PRIMARY_FLUSH = true;</span> |
| <span class="source-line-no">045</span><span id="line-45"></span> |
| <span class="source-line-no">046</span><span id="line-46"> /**</span> |
| <span class="source-line-no">047</span><span id="line-47"> * The default replicaId for the region</span> |
| <span class="source-line-no">048</span><span id="line-48"> */</span> |
| <span class="source-line-no">049</span><span id="line-49"> static final int DEFAULT_REPLICA_ID = 0;</span> |
| <span class="source-line-no">050</span><span id="line-50"></span> |
| <span class="source-line-no">051</span><span id="line-51"> /**</span> |
| <span class="source-line-no">052</span><span id="line-52"> * Returns the RegionInfo for the given replicaId. RegionInfo's correspond to a range of a table,</span> |
| <span class="source-line-no">053</span><span id="line-53"> * but more than one "instance" of the same range can be deployed which are differentiated by the</span> |
| <span class="source-line-no">054</span><span id="line-54"> * replicaId.</span> |
| <span class="source-line-no">055</span><span id="line-55"> * @return an RegionInfo object corresponding to the same range (table, start and end key), but</span> |
| <span class="source-line-no">056</span><span id="line-56"> * for the given replicaId.</span> |
| <span class="source-line-no">057</span><span id="line-57"> */</span> |
| <span class="source-line-no">058</span><span id="line-58"> public static RegionInfo getRegionInfoForReplica(RegionInfo regionInfo, int replicaId) {</span> |
| <span class="source-line-no">059</span><span id="line-59"> if (regionInfo.getReplicaId() == replicaId) {</span> |
| <span class="source-line-no">060</span><span id="line-60"> return regionInfo;</span> |
| <span class="source-line-no">061</span><span id="line-61"> }</span> |
| <span class="source-line-no">062</span><span id="line-62"> return RegionInfoBuilder.newBuilder(regionInfo).setReplicaId(replicaId).build();</span> |
| <span class="source-line-no">063</span><span id="line-63"> }</span> |
| <span class="source-line-no">064</span><span id="line-64"></span> |
| <span class="source-line-no">065</span><span id="line-65"> /**</span> |
| <span class="source-line-no">066</span><span id="line-66"> * Returns the RegionInfo for the default replicaId (0). RegionInfo's correspond to a range of a</span> |
| <span class="source-line-no">067</span><span id="line-67"> * table, but more than one "instance" of the same range can be deployed which are differentiated</span> |
| <span class="source-line-no">068</span><span id="line-68"> * by the replicaId.</span> |
| <span class="source-line-no">069</span><span id="line-69"> * @return an RegionInfo object corresponding to the same range (table, start and end key), but</span> |
| <span class="source-line-no">070</span><span id="line-70"> * for the default replicaId.</span> |
| <span class="source-line-no">071</span><span id="line-71"> */</span> |
| <span class="source-line-no">072</span><span id="line-72"> public static RegionInfo getRegionInfoForDefaultReplica(RegionInfo regionInfo) {</span> |
| <span class="source-line-no">073</span><span id="line-73"> return getRegionInfoForReplica(regionInfo, DEFAULT_REPLICA_ID);</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"> /** Returns true if this replicaId corresponds to default replica for the region */</span> |
| <span class="source-line-no">077</span><span id="line-77"> public static boolean isDefaultReplica(int replicaId) {</span> |
| <span class="source-line-no">078</span><span id="line-78"> return DEFAULT_REPLICA_ID == replicaId;</span> |
| <span class="source-line-no">079</span><span id="line-79"> }</span> |
| <span class="source-line-no">080</span><span id="line-80"></span> |
| <span class="source-line-no">081</span><span id="line-81"> /** Returns true if this region is a default replica for the region */</span> |
| <span class="source-line-no">082</span><span id="line-82"> public static boolean isDefaultReplica(RegionInfo hri) {</span> |
| <span class="source-line-no">083</span><span id="line-83"> return hri.getReplicaId() == DEFAULT_REPLICA_ID;</span> |
| <span class="source-line-no">084</span><span id="line-84"> }</span> |
| <span class="source-line-no">085</span><span id="line-85"></span> |
| <span class="source-line-no">086</span><span id="line-86"> /**</span> |
| <span class="source-line-no">087</span><span id="line-87"> * Removes the non-default replicas from the passed regions collection</span> |
| <span class="source-line-no">088</span><span id="line-88"> */</span> |
| <span class="source-line-no">089</span><span id="line-89"> public static void removeNonDefaultRegions(Collection<RegionInfo> regions) {</span> |
| <span class="source-line-no">090</span><span id="line-90"> Iterator<RegionInfo> iterator = regions.iterator();</span> |
| <span class="source-line-no">091</span><span id="line-91"> while (iterator.hasNext()) {</span> |
| <span class="source-line-no">092</span><span id="line-92"> RegionInfo hri = iterator.next();</span> |
| <span class="source-line-no">093</span><span id="line-93"> if (!RegionReplicaUtil.isDefaultReplica(hri)) {</span> |
| <span class="source-line-no">094</span><span id="line-94"> iterator.remove();</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"> }</span> |
| <span class="source-line-no">098</span><span id="line-98"></span> |
| <span class="source-line-no">099</span><span id="line-99"> public static boolean isReplicasForSameRegion(RegionInfo regionInfoA, RegionInfo regionInfoB) {</span> |
| <span class="source-line-no">100</span><span id="line-100"> return compareRegionInfosWithoutReplicaId(regionInfoA, regionInfoB) == 0;</span> |
| <span class="source-line-no">101</span><span id="line-101"> }</span> |
| <span class="source-line-no">102</span><span id="line-102"></span> |
| <span class="source-line-no">103</span><span id="line-103"> private static int compareRegionInfosWithoutReplicaId(RegionInfo regionInfoA,</span> |
| <span class="source-line-no">104</span><span id="line-104"> RegionInfo regionInfoB) {</span> |
| <span class="source-line-no">105</span><span id="line-105"> int result = regionInfoA.getTable().compareTo(regionInfoB.getTable());</span> |
| <span class="source-line-no">106</span><span id="line-106"> if (result != 0) {</span> |
| <span class="source-line-no">107</span><span id="line-107"> return result;</span> |
| <span class="source-line-no">108</span><span id="line-108"> }</span> |
| <span class="source-line-no">109</span><span id="line-109"></span> |
| <span class="source-line-no">110</span><span id="line-110"> // Compare start keys.</span> |
| <span class="source-line-no">111</span><span id="line-111"> result = Bytes.compareTo(regionInfoA.getStartKey(), regionInfoB.getStartKey());</span> |
| <span class="source-line-no">112</span><span id="line-112"> if (result != 0) {</span> |
| <span class="source-line-no">113</span><span id="line-113"> return result;</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"> // Compare end keys.</span> |
| <span class="source-line-no">117</span><span id="line-117"> result = Bytes.compareTo(regionInfoA.getEndKey(), regionInfoB.getEndKey());</span> |
| <span class="source-line-no">118</span><span id="line-118"></span> |
| <span class="source-line-no">119</span><span id="line-119"> if (result != 0) {</span> |
| <span class="source-line-no">120</span><span id="line-120"> if (regionInfoA.getStartKey().length != 0 && regionInfoA.getEndKey().length == 0) {</span> |
| <span class="source-line-no">121</span><span id="line-121"> return 1; // this is last region</span> |
| <span class="source-line-no">122</span><span id="line-122"> }</span> |
| <span class="source-line-no">123</span><span id="line-123"> if (regionInfoB.getStartKey().length != 0 && regionInfoB.getEndKey().length == 0) {</span> |
| <span class="source-line-no">124</span><span id="line-124"> return -1; // o is the last region</span> |
| <span class="source-line-no">125</span><span id="line-125"> }</span> |
| <span class="source-line-no">126</span><span id="line-126"> return result;</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"> // regionId is usually milli timestamp -- this defines older stamps</span> |
| <span class="source-line-no">130</span><span id="line-130"> // to be "smaller" than newer stamps in sort order.</span> |
| <span class="source-line-no">131</span><span id="line-131"> if (regionInfoA.getRegionId() > regionInfoB.getRegionId()) {</span> |
| <span class="source-line-no">132</span><span id="line-132"> return 1;</span> |
| <span class="source-line-no">133</span><span id="line-133"> } else if (regionInfoA.getRegionId() < regionInfoB.getRegionId()) {</span> |
| <span class="source-line-no">134</span><span id="line-134"> return -1;</span> |
| <span class="source-line-no">135</span><span id="line-135"> }</span> |
| <span class="source-line-no">136</span><span id="line-136"> return 0;</span> |
| <span class="source-line-no">137</span><span id="line-137"> }</span> |
| <span class="source-line-no">138</span><span id="line-138"></span> |
| <span class="source-line-no">139</span><span id="line-139"> /**</span> |
| <span class="source-line-no">140</span><span id="line-140"> * Create any replicas for the regions (the default replicas that was already created is passed to</span> |
| <span class="source-line-no">141</span><span id="line-141"> * the method)</span> |
| <span class="source-line-no">142</span><span id="line-142"> * @param regions existing regions</span> |
| <span class="source-line-no">143</span><span id="line-143"> * @param oldReplicaCount existing replica count</span> |
| <span class="source-line-no">144</span><span id="line-144"> * @param newReplicaCount updated replica count due to modify table</span> |
| <span class="source-line-no">145</span><span id="line-145"> * @return the combined list of default and non-default replicas</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 List<RegionInfo> addReplicas(final List<RegionInfo> regions, int oldReplicaCount,</span> |
| <span class="source-line-no">148</span><span id="line-148"> int newReplicaCount) {</span> |
| <span class="source-line-no">149</span><span id="line-149"> if ((newReplicaCount - 1) <= 0) {</span> |
| <span class="source-line-no">150</span><span id="line-150"> return regions;</span> |
| <span class="source-line-no">151</span><span id="line-151"> }</span> |
| <span class="source-line-no">152</span><span id="line-152"> List<RegionInfo> hRegionInfos = new ArrayList<>(newReplicaCount * regions.size());</span> |
| <span class="source-line-no">153</span><span id="line-153"> for (RegionInfo ri : regions) {</span> |
| <span class="source-line-no">154</span><span id="line-154"> if (</span> |
| <span class="source-line-no">155</span><span id="line-155"> RegionReplicaUtil.isDefaultReplica(ri)</span> |
| <span class="source-line-no">156</span><span id="line-156"> && (!ri.isOffline() || (!ri.isSplit() && !ri.isSplitParent()))</span> |
| <span class="source-line-no">157</span><span id="line-157"> ) {</span> |
| <span class="source-line-no">158</span><span id="line-158"> // region level replica index starts from 0. So if oldReplicaCount was 2 then the max</span> |
| <span class="source-line-no">159</span><span id="line-159"> // replicaId for</span> |
| <span class="source-line-no">160</span><span id="line-160"> // the existing regions would be 1</span> |
| <span class="source-line-no">161</span><span id="line-161"> for (int j = oldReplicaCount; j < newReplicaCount; j++) {</span> |
| <span class="source-line-no">162</span><span id="line-162"> hRegionInfos.add(RegionReplicaUtil.getRegionInfoForReplica(ri, j));</span> |
| <span class="source-line-no">163</span><span id="line-163"> }</span> |
| <span class="source-line-no">164</span><span id="line-164"> }</span> |
| <span class="source-line-no">165</span><span id="line-165"> }</span> |
| <span class="source-line-no">166</span><span id="line-166"> hRegionInfos.addAll(regions);</span> |
| <span class="source-line-no">167</span><span id="line-167"> return hRegionInfos;</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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
