| <!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.master.assignment, class: RegionStateNode"> |
| <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.master.assignment;</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.Arrays;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.util.concurrent.ConcurrentMap;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.hbase.HConstants;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.ServerName;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.TableName;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.client.DoNotRetryRegionException;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.client.RegionInfo;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.client.RegionOfflineException;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.exceptions.UnexpectedStateException;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.master.RegionState;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.master.RegionState.State;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.procedure2.Procedure;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.procedure2.ProcedureEvent;</span> |
| <span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.procedure2.ProcedureSuspendedException;</span> |
| <span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;</span> |
| <span class="source-line-no">035</span><span id="line-35">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">036</span><span id="line-36">import org.slf4j.Logger;</span> |
| <span class="source-line-no">037</span><span id="line-37">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">038</span><span id="line-38"></span> |
| <span class="source-line-no">039</span><span id="line-39">/**</span> |
| <span class="source-line-no">040</span><span id="line-40"> * Current Region State. Most fields are synchronized with meta region, i.e, we will update meta</span> |
| <span class="source-line-no">041</span><span id="line-41"> * immediately after we modify this RegionStateNode, and usually under the lock. The only exception</span> |
| <span class="source-line-no">042</span><span id="line-42"> * is {@link #lastHost}, which should not be used for critical condition.</span> |
| <span class="source-line-no">043</span><span id="line-43"> * <p/></span> |
| <span class="source-line-no">044</span><span id="line-44"> * Typically, the only way to modify this class is through {@link TransitRegionStateProcedure}, and</span> |
| <span class="source-line-no">045</span><span id="line-45"> * we will record the TRSP along with this RegionStateNode to make sure that there could at most one</span> |
| <span class="source-line-no">046</span><span id="line-46"> * TRSP. For other operations, such as SCP, we will first get the lock, and then try to schedule a</span> |
| <span class="source-line-no">047</span><span id="line-47"> * TRSP. If there is already one, then the solution will be different:</span> |
| <span class="source-line-no">048</span><span id="line-48"> * <ul></span> |
| <span class="source-line-no">049</span><span id="line-49"> * <li>For SCP, we will update the region state in meta to tell the TRSP to retry.</li></span> |
| <span class="source-line-no">050</span><span id="line-50"> * <li>For DisableTableProcedure, as we have the xlock, we can make sure that the TRSP has not been</span> |
| <span class="source-line-no">051</span><span id="line-51"> * executed yet, so just unset it and attach a new one. The original one will quit immediately when</span> |
| <span class="source-line-no">052</span><span id="line-52"> * executing.</li></span> |
| <span class="source-line-no">053</span><span id="line-53"> * <li>For split/merge, we will fail immediately as there is no actual operations yet so no</span> |
| <span class="source-line-no">054</span><span id="line-54"> * harm.</li></span> |
| <span class="source-line-no">055</span><span id="line-55"> * <li>For EnableTableProcedure/TruncateTableProcedure, we can make sure that there will be no TRSP</span> |
| <span class="source-line-no">056</span><span id="line-56"> * attached with the RSNs.</li></span> |
| <span class="source-line-no">057</span><span id="line-57"> * <li>For other procedures, you'd better use ReopenTableRegionsProcedure. The RTRP will take care</span> |
| <span class="source-line-no">058</span><span id="line-58"> * of lots of corner cases when reopening regions.</li></span> |
| <span class="source-line-no">059</span><span id="line-59"> * </ul></span> |
| <span class="source-line-no">060</span><span id="line-60"> * <p/></span> |
| <span class="source-line-no">061</span><span id="line-61"> * Several fields are declared with {@code volatile}, which means you are free to get it without</span> |
| <span class="source-line-no">062</span><span id="line-62"> * lock, but usually you should not use these fields without locking for critical condition, as it</span> |
| <span class="source-line-no">063</span><span id="line-63"> * will be easily to introduce inconsistency. For example, you are free to dump the status and show</span> |
| <span class="source-line-no">064</span><span id="line-64"> * it on web without locking, but if you want to change the state of the RegionStateNode by checking</span> |
| <span class="source-line-no">065</span><span id="line-65"> * the current state, you'd better have the lock...</span> |
| <span class="source-line-no">066</span><span id="line-66"> */</span> |
| <span class="source-line-no">067</span><span id="line-67">@InterfaceAudience.Private</span> |
| <span class="source-line-no">068</span><span id="line-68">public class RegionStateNode implements Comparable<RegionStateNode> {</span> |
| <span class="source-line-no">069</span><span id="line-69"></span> |
| <span class="source-line-no">070</span><span id="line-70"> private static final Logger LOG = LoggerFactory.getLogger(RegionStateNode.class);</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 final class AssignmentProcedureEvent extends ProcedureEvent<RegionInfo> {</span> |
| <span class="source-line-no">073</span><span id="line-73"> public AssignmentProcedureEvent(final RegionInfo regionInfo) {</span> |
| <span class="source-line-no">074</span><span id="line-74"> super(regionInfo);</span> |
| <span class="source-line-no">075</span><span id="line-75"> }</span> |
| <span class="source-line-no">076</span><span id="line-76"> }</span> |
| <span class="source-line-no">077</span><span id="line-77"></span> |
| <span class="source-line-no">078</span><span id="line-78"> private final RegionStateNodeLock lock;</span> |
| <span class="source-line-no">079</span><span id="line-79"> private final RegionInfo regionInfo;</span> |
| <span class="source-line-no">080</span><span id="line-80"> private final ProcedureEvent<?> event;</span> |
| <span class="source-line-no">081</span><span id="line-81"> private final ConcurrentMap<RegionInfo, RegionStateNode> ritMap;</span> |
| <span class="source-line-no">082</span><span id="line-82"></span> |
| <span class="source-line-no">083</span><span id="line-83"> // volatile only for getLastUpdate and test usage, the upper layer should sync on the</span> |
| <span class="source-line-no">084</span><span id="line-84"> // RegionStateNode before accessing usually.</span> |
| <span class="source-line-no">085</span><span id="line-85"> private volatile TransitRegionStateProcedure procedure = null;</span> |
| <span class="source-line-no">086</span><span id="line-86"> private volatile ServerName regionLocation = null;</span> |
| <span class="source-line-no">087</span><span id="line-87"> // notice that, the lastHost will only be updated when a region is successfully CLOSED through</span> |
| <span class="source-line-no">088</span><span id="line-88"> // UnassignProcedure, so do not use it for critical condition as the data maybe stale and unsync</span> |
| <span class="source-line-no">089</span><span id="line-89"> // with the data in meta.</span> |
| <span class="source-line-no">090</span><span id="line-90"> private volatile ServerName lastHost = null;</span> |
| <span class="source-line-no">091</span><span id="line-91"> /**</span> |
| <span class="source-line-no">092</span><span id="line-92"> * A Region-in-Transition (RIT) moves through states. See {@link State} for complete list. A</span> |
| <span class="source-line-no">093</span><span id="line-93"> * Region that is opened moves from OFFLINE => OPENING => OPENED.</span> |
| <span class="source-line-no">094</span><span id="line-94"> */</span> |
| <span class="source-line-no">095</span><span id="line-95"> private volatile State state = State.OFFLINE;</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"> * Updated whenever a call to {@link #setRegionLocation(ServerName)} or</span> |
| <span class="source-line-no">099</span><span id="line-99"> * {@link #setState(RegionState.State, RegionState.State...)}.</span> |
| <span class="source-line-no">100</span><span id="line-100"> */</span> |
| <span class="source-line-no">101</span><span id="line-101"> private volatile long lastUpdate = 0;</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 volatile long openSeqNum = HConstants.NO_SEQNUM;</span> |
| <span class="source-line-no">104</span><span id="line-104"></span> |
| <span class="source-line-no">105</span><span id="line-105"> RegionStateNode(RegionInfo regionInfo, ConcurrentMap<RegionInfo, RegionStateNode> ritMap) {</span> |
| <span class="source-line-no">106</span><span id="line-106"> this.regionInfo = regionInfo;</span> |
| <span class="source-line-no">107</span><span id="line-107"> this.event = new AssignmentProcedureEvent(regionInfo);</span> |
| <span class="source-line-no">108</span><span id="line-108"> this.ritMap = ritMap;</span> |
| <span class="source-line-no">109</span><span id="line-109"> this.lock = new RegionStateNodeLock(regionInfo);</span> |
| <span class="source-line-no">110</span><span id="line-110"> }</span> |
| <span class="source-line-no">111</span><span id="line-111"></span> |
| <span class="source-line-no">112</span><span id="line-112"> /**</span> |
| <span class="source-line-no">113</span><span id="line-113"> * @param update new region state this node should be assigned.</span> |
| <span class="source-line-no">114</span><span id="line-114"> * @param expected current state should be in this given list of expected states</span> |
| <span class="source-line-no">115</span><span id="line-115"> * @return true, if current state is in expected list; otherwise false.</span> |
| <span class="source-line-no">116</span><span id="line-116"> */</span> |
| <span class="source-line-no">117</span><span id="line-117"> public boolean setState(final State update, final State... expected) {</span> |
| <span class="source-line-no">118</span><span id="line-118"> if (!isInState(expected)) {</span> |
| <span class="source-line-no">119</span><span id="line-119"> return false;</span> |
| <span class="source-line-no">120</span><span id="line-120"> }</span> |
| <span class="source-line-no">121</span><span id="line-121"> this.state = update;</span> |
| <span class="source-line-no">122</span><span id="line-122"> this.lastUpdate = EnvironmentEdgeManager.currentTime();</span> |
| <span class="source-line-no">123</span><span id="line-123"> return true;</span> |
| <span class="source-line-no">124</span><span id="line-124"> }</span> |
| <span class="source-line-no">125</span><span id="line-125"></span> |
| <span class="source-line-no">126</span><span id="line-126"> /**</span> |
| <span class="source-line-no">127</span><span id="line-127"> * Put region into OFFLINE mode (set state and clear location).</span> |
| <span class="source-line-no">128</span><span id="line-128"> * @return Last recorded server deploy</span> |
| <span class="source-line-no">129</span><span id="line-129"> */</span> |
| <span class="source-line-no">130</span><span id="line-130"> public ServerName offline() {</span> |
| <span class="source-line-no">131</span><span id="line-131"> setState(State.OFFLINE);</span> |
| <span class="source-line-no">132</span><span id="line-132"> return setRegionLocation(null);</span> |
| <span class="source-line-no">133</span><span id="line-133"> }</span> |
| <span class="source-line-no">134</span><span id="line-134"></span> |
| <span class="source-line-no">135</span><span id="line-135"> /**</span> |
| <span class="source-line-no">136</span><span id="line-136"> * Set new {@link State} but only if currently in <code>expected</code> State (if not, throw</span> |
| <span class="source-line-no">137</span><span id="line-137"> * {@link UnexpectedStateException}.</span> |
| <span class="source-line-no">138</span><span id="line-138"> */</span> |
| <span class="source-line-no">139</span><span id="line-139"> public void transitionState(final State update, final State... expected)</span> |
| <span class="source-line-no">140</span><span id="line-140"> throws UnexpectedStateException {</span> |
| <span class="source-line-no">141</span><span id="line-141"> if (!setState(update, expected)) {</span> |
| <span class="source-line-no">142</span><span id="line-142"> throw new UnexpectedStateException("Expected " + Arrays.toString(expected)</span> |
| <span class="source-line-no">143</span><span id="line-143"> + " so could move to " + update + " but current state=" + getState());</span> |
| <span class="source-line-no">144</span><span id="line-144"> }</span> |
| <span class="source-line-no">145</span><span id="line-145"> }</span> |
| <span class="source-line-no">146</span><span id="line-146"></span> |
| <span class="source-line-no">147</span><span id="line-147"> /**</span> |
| <span class="source-line-no">148</span><span id="line-148"> * Notice that, we will return true if {@code expected} is empty.</span> |
| <span class="source-line-no">149</span><span id="line-149"> * <p/></span> |
| <span class="source-line-no">150</span><span id="line-150"> * This is a bit strange but we need this logic, for example, we can change the state to OPENING</span> |
| <span class="source-line-no">151</span><span id="line-151"> * from any state, as in SCP we will not change the state to CLOSED before opening the region.</span> |
| <span class="source-line-no">152</span><span id="line-152"> */</span> |
| <span class="source-line-no">153</span><span id="line-153"> public boolean isInState(State... expected) {</span> |
| <span class="source-line-no">154</span><span id="line-154"> if (expected.length == 0) {</span> |
| <span class="source-line-no">155</span><span id="line-155"> return true;</span> |
| <span class="source-line-no">156</span><span id="line-156"> }</span> |
| <span class="source-line-no">157</span><span id="line-157"> return getState().matches(expected);</span> |
| <span class="source-line-no">158</span><span id="line-158"> }</span> |
| <span class="source-line-no">159</span><span id="line-159"></span> |
| <span class="source-line-no">160</span><span id="line-160"> public boolean isStuck() {</span> |
| <span class="source-line-no">161</span><span id="line-161"> return isInState(State.FAILED_OPEN) && getProcedure() != null;</span> |
| <span class="source-line-no">162</span><span id="line-162"> }</span> |
| <span class="source-line-no">163</span><span id="line-163"></span> |
| <span class="source-line-no">164</span><span id="line-164"> public boolean isInTransition() {</span> |
| <span class="source-line-no">165</span><span id="line-165"> return getProcedure() != null;</span> |
| <span class="source-line-no">166</span><span id="line-166"> }</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"> * Return whether the region has been split and not online.</span> |
| <span class="source-line-no">170</span><span id="line-170"> * <p/></span> |
| <span class="source-line-no">171</span><span id="line-171"> * In this method we will test both region info and state, and will return true if either of the</span> |
| <span class="source-line-no">172</span><span id="line-172"> * test returns true. Please see the comments in</span> |
| <span class="source-line-no">173</span><span id="line-173"> * {@link AssignmentManager#markRegionAsSplit(RegionInfo, ServerName, RegionInfo, RegionInfo)} for</span> |
| <span class="source-line-no">174</span><span id="line-174"> * more details on why we need to test two conditions.</span> |
| <span class="source-line-no">175</span><span id="line-175"> */</span> |
| <span class="source-line-no">176</span><span id="line-176"> public boolean isSplit() {</span> |
| <span class="source-line-no">177</span><span id="line-177"> return regionInfo.isSplit() || isInState(State.SPLIT);</span> |
| <span class="source-line-no">178</span><span id="line-178"> }</span> |
| <span class="source-line-no">179</span><span id="line-179"></span> |
| <span class="source-line-no">180</span><span id="line-180"> public long getLastUpdate() {</span> |
| <span class="source-line-no">181</span><span id="line-181"> TransitRegionStateProcedure proc = this.procedure;</span> |
| <span class="source-line-no">182</span><span id="line-182"> if (proc != null) {</span> |
| <span class="source-line-no">183</span><span id="line-183"> long lastUpdate = proc.getLastUpdate();</span> |
| <span class="source-line-no">184</span><span id="line-184"> return lastUpdate != 0 ? lastUpdate : proc.getSubmittedTime();</span> |
| <span class="source-line-no">185</span><span id="line-185"> }</span> |
| <span class="source-line-no">186</span><span id="line-186"> return lastUpdate;</span> |
| <span class="source-line-no">187</span><span id="line-187"> }</span> |
| <span class="source-line-no">188</span><span id="line-188"></span> |
| <span class="source-line-no">189</span><span id="line-189"> public void setLastHost(final ServerName serverName) {</span> |
| <span class="source-line-no">190</span><span id="line-190"> this.lastHost = serverName;</span> |
| <span class="source-line-no">191</span><span id="line-191"> }</span> |
| <span class="source-line-no">192</span><span id="line-192"></span> |
| <span class="source-line-no">193</span><span id="line-193"> public void setOpenSeqNum(final long seqId) {</span> |
| <span class="source-line-no">194</span><span id="line-194"> this.openSeqNum = seqId;</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"> public ServerName setRegionLocation(final ServerName serverName) {</span> |
| <span class="source-line-no">198</span><span id="line-198"> ServerName lastRegionLocation = this.regionLocation;</span> |
| <span class="source-line-no">199</span><span id="line-199"> if (LOG.isTraceEnabled() && serverName == null) {</span> |
| <span class="source-line-no">200</span><span id="line-200"> LOG.trace("Tracking when we are set to null " + this, new Throwable("TRACE"));</span> |
| <span class="source-line-no">201</span><span id="line-201"> }</span> |
| <span class="source-line-no">202</span><span id="line-202"> this.regionLocation = serverName;</span> |
| <span class="source-line-no">203</span><span id="line-203"> this.lastUpdate = EnvironmentEdgeManager.currentTime();</span> |
| <span class="source-line-no">204</span><span id="line-204"> return lastRegionLocation;</span> |
| <span class="source-line-no">205</span><span id="line-205"> }</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 TransitRegionStateProcedure setProcedure(TransitRegionStateProcedure proc) {</span> |
| <span class="source-line-no">208</span><span id="line-208"> assert this.procedure == null;</span> |
| <span class="source-line-no">209</span><span id="line-209"> this.procedure = proc;</span> |
| <span class="source-line-no">210</span><span id="line-210"> ritMap.put(regionInfo, this);</span> |
| <span class="source-line-no">211</span><span id="line-211"> return proc;</span> |
| <span class="source-line-no">212</span><span id="line-212"> }</span> |
| <span class="source-line-no">213</span><span id="line-213"></span> |
| <span class="source-line-no">214</span><span id="line-214"> public void unsetProcedure(TransitRegionStateProcedure proc) {</span> |
| <span class="source-line-no">215</span><span id="line-215"> assert this.procedure == proc;</span> |
| <span class="source-line-no">216</span><span id="line-216"> this.procedure = null;</span> |
| <span class="source-line-no">217</span><span id="line-217"> ritMap.remove(regionInfo, this);</span> |
| <span class="source-line-no">218</span><span id="line-218"> }</span> |
| <span class="source-line-no">219</span><span id="line-219"></span> |
| <span class="source-line-no">220</span><span id="line-220"> public TransitRegionStateProcedure getProcedure() {</span> |
| <span class="source-line-no">221</span><span id="line-221"> return procedure;</span> |
| <span class="source-line-no">222</span><span id="line-222"> }</span> |
| <span class="source-line-no">223</span><span id="line-223"></span> |
| <span class="source-line-no">224</span><span id="line-224"> public ProcedureEvent<?> getProcedureEvent() {</span> |
| <span class="source-line-no">225</span><span id="line-225"> return event;</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"> public RegionInfo getRegionInfo() {</span> |
| <span class="source-line-no">229</span><span id="line-229"> return regionInfo;</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"> public TableName getTable() {</span> |
| <span class="source-line-no">233</span><span id="line-233"> return getRegionInfo().getTable();</span> |
| <span class="source-line-no">234</span><span id="line-234"> }</span> |
| <span class="source-line-no">235</span><span id="line-235"></span> |
| <span class="source-line-no">236</span><span id="line-236"> public boolean isSystemTable() {</span> |
| <span class="source-line-no">237</span><span id="line-237"> return getTable().isSystemTable();</span> |
| <span class="source-line-no">238</span><span id="line-238"> }</span> |
| <span class="source-line-no">239</span><span id="line-239"></span> |
| <span class="source-line-no">240</span><span id="line-240"> public ServerName getLastHost() {</span> |
| <span class="source-line-no">241</span><span id="line-241"> return lastHost;</span> |
| <span class="source-line-no">242</span><span id="line-242"> }</span> |
| <span class="source-line-no">243</span><span id="line-243"></span> |
| <span class="source-line-no">244</span><span id="line-244"> public ServerName getRegionLocation() {</span> |
| <span class="source-line-no">245</span><span id="line-245"> return regionLocation;</span> |
| <span class="source-line-no">246</span><span id="line-246"> }</span> |
| <span class="source-line-no">247</span><span id="line-247"></span> |
| <span class="source-line-no">248</span><span id="line-248"> public State getState() {</span> |
| <span class="source-line-no">249</span><span id="line-249"> return state;</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"> public long getOpenSeqNum() {</span> |
| <span class="source-line-no">253</span><span id="line-253"> return openSeqNum;</span> |
| <span class="source-line-no">254</span><span id="line-254"> }</span> |
| <span class="source-line-no">255</span><span id="line-255"></span> |
| <span class="source-line-no">256</span><span id="line-256"> public int getFormatVersion() {</span> |
| <span class="source-line-no">257</span><span id="line-257"> // we don't have any format for now</span> |
| <span class="source-line-no">258</span><span id="line-258"> // it should probably be in regionInfo.getFormatVersion()</span> |
| <span class="source-line-no">259</span><span id="line-259"> return 0;</span> |
| <span class="source-line-no">260</span><span id="line-260"> }</span> |
| <span class="source-line-no">261</span><span id="line-261"></span> |
| <span class="source-line-no">262</span><span id="line-262"> public RegionState toRegionState() {</span> |
| <span class="source-line-no">263</span><span id="line-263"> return new RegionState(getRegionInfo(), getState(), getLastUpdate(), getRegionLocation());</span> |
| <span class="source-line-no">264</span><span id="line-264"> }</span> |
| <span class="source-line-no">265</span><span id="line-265"></span> |
| <span class="source-line-no">266</span><span id="line-266"> @Override</span> |
| <span class="source-line-no">267</span><span id="line-267"> public int compareTo(final RegionStateNode other) {</span> |
| <span class="source-line-no">268</span><span id="line-268"> // NOTE: RegionInfo sort by table first, so we are relying on that.</span> |
| <span class="source-line-no">269</span><span id="line-269"> // we have a TestRegionState#testOrderedByTable() that check for that.</span> |
| <span class="source-line-no">270</span><span id="line-270"> return RegionInfo.COMPARATOR.compare(getRegionInfo(), other.getRegionInfo());</span> |
| <span class="source-line-no">271</span><span id="line-271"> }</span> |
| <span class="source-line-no">272</span><span id="line-272"></span> |
| <span class="source-line-no">273</span><span id="line-273"> @Override</span> |
| <span class="source-line-no">274</span><span id="line-274"> public int hashCode() {</span> |
| <span class="source-line-no">275</span><span id="line-275"> return getRegionInfo().hashCode();</span> |
| <span class="source-line-no">276</span><span id="line-276"> }</span> |
| <span class="source-line-no">277</span><span id="line-277"></span> |
| <span class="source-line-no">278</span><span id="line-278"> @Override</span> |
| <span class="source-line-no">279</span><span id="line-279"> public boolean equals(final Object other) {</span> |
| <span class="source-line-no">280</span><span id="line-280"> if (this == other) {</span> |
| <span class="source-line-no">281</span><span id="line-281"> return true;</span> |
| <span class="source-line-no">282</span><span id="line-282"> }</span> |
| <span class="source-line-no">283</span><span id="line-283"> if (!(other instanceof RegionStateNode)) {</span> |
| <span class="source-line-no">284</span><span id="line-284"> return false;</span> |
| <span class="source-line-no">285</span><span id="line-285"> }</span> |
| <span class="source-line-no">286</span><span id="line-286"> return compareTo((RegionStateNode) other) == 0;</span> |
| <span class="source-line-no">287</span><span id="line-287"> }</span> |
| <span class="source-line-no">288</span><span id="line-288"></span> |
| <span class="source-line-no">289</span><span id="line-289"> @Override</span> |
| <span class="source-line-no">290</span><span id="line-290"> public String toString() {</span> |
| <span class="source-line-no">291</span><span id="line-291"> return toDescriptiveString();</span> |
| <span class="source-line-no">292</span><span id="line-292"> }</span> |
| <span class="source-line-no">293</span><span id="line-293"></span> |
| <span class="source-line-no">294</span><span id="line-294"> public String toShortString() {</span> |
| <span class="source-line-no">295</span><span id="line-295"> // rit= is the current Region-In-Transition State -- see State enum.</span> |
| <span class="source-line-no">296</span><span id="line-296"> return String.format("state=%s, location=%s", getState(), getRegionLocation());</span> |
| <span class="source-line-no">297</span><span id="line-297"> }</span> |
| <span class="source-line-no">298</span><span id="line-298"></span> |
| <span class="source-line-no">299</span><span id="line-299"> public String toDescriptiveString() {</span> |
| <span class="source-line-no">300</span><span id="line-300"> return String.format("%s, table=%s, region=%s", toShortString(), getTable(),</span> |
| <span class="source-line-no">301</span><span id="line-301"> getRegionInfo().getEncodedName());</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 void checkOnline() throws DoNotRetryRegionException {</span> |
| <span class="source-line-no">305</span><span id="line-305"> RegionInfo ri = getRegionInfo();</span> |
| <span class="source-line-no">306</span><span id="line-306"> State s = state;</span> |
| <span class="source-line-no">307</span><span id="line-307"> if (s != State.OPEN) {</span> |
| <span class="source-line-no">308</span><span id="line-308"> throw new DoNotRetryRegionException(ri.getEncodedName() + " is not OPEN; state=" + s);</span> |
| <span class="source-line-no">309</span><span id="line-309"> }</span> |
| <span class="source-line-no">310</span><span id="line-310"> if (ri.isSplitParent()) {</span> |
| <span class="source-line-no">311</span><span id="line-311"> throw new DoNotRetryRegionException(</span> |
| <span class="source-line-no">312</span><span id="line-312"> ri.getEncodedName() + " is not online (splitParent=true)");</span> |
| <span class="source-line-no">313</span><span id="line-313"> }</span> |
| <span class="source-line-no">314</span><span id="line-314"> if (ri.isSplit()) {</span> |
| <span class="source-line-no">315</span><span id="line-315"> throw new DoNotRetryRegionException(ri.getEncodedName() + " has split=true");</span> |
| <span class="source-line-no">316</span><span id="line-316"> }</span> |
| <span class="source-line-no">317</span><span id="line-317"> if (ri.isOffline()) {</span> |
| <span class="source-line-no">318</span><span id="line-318"> // RegionOfflineException is not instance of DNRIOE so wrap it.</span> |
| <span class="source-line-no">319</span><span id="line-319"> throw new DoNotRetryRegionException(new RegionOfflineException(ri.getEncodedName()));</span> |
| <span class="source-line-no">320</span><span id="line-320"> }</span> |
| <span class="source-line-no">321</span><span id="line-321"> }</span> |
| <span class="source-line-no">322</span><span id="line-322"></span> |
| <span class="source-line-no">323</span><span id="line-323"> // The below 3 methods are for normal locking operation, where the thread owner is the current</span> |
| <span class="source-line-no">324</span><span id="line-324"> // thread. Typically you just need to use these 3 methods, and use try..finally to release the</span> |
| <span class="source-line-no">325</span><span id="line-325"> // lock in the finally block</span> |
| <span class="source-line-no">326</span><span id="line-326"> /**</span> |
| <span class="source-line-no">327</span><span id="line-327"> * @see RegionStateNodeLock#lock()</span> |
| <span class="source-line-no">328</span><span id="line-328"> */</span> |
| <span class="source-line-no">329</span><span id="line-329"> public void lock() {</span> |
| <span class="source-line-no">330</span><span id="line-330"> lock.lock();</span> |
| <span class="source-line-no">331</span><span id="line-331"> }</span> |
| <span class="source-line-no">332</span><span id="line-332"></span> |
| <span class="source-line-no">333</span><span id="line-333"> /**</span> |
| <span class="source-line-no">334</span><span id="line-334"> * @see RegionStateNodeLock#tryLock()</span> |
| <span class="source-line-no">335</span><span id="line-335"> */</span> |
| <span class="source-line-no">336</span><span id="line-336"> public boolean tryLock() {</span> |
| <span class="source-line-no">337</span><span id="line-337"> return lock.tryLock();</span> |
| <span class="source-line-no">338</span><span id="line-338"> }</span> |
| <span class="source-line-no">339</span><span id="line-339"></span> |
| <span class="source-line-no">340</span><span id="line-340"> /**</span> |
| <span class="source-line-no">341</span><span id="line-341"> * @see RegionStateNodeLock#unlock()</span> |
| <span class="source-line-no">342</span><span id="line-342"> */</span> |
| <span class="source-line-no">343</span><span id="line-343"> public void unlock() {</span> |
| <span class="source-line-no">344</span><span id="line-344"> lock.unlock();</span> |
| <span class="source-line-no">345</span><span id="line-345"> }</span> |
| <span class="source-line-no">346</span><span id="line-346"></span> |
| <span class="source-line-no">347</span><span id="line-347"> // The below 3 methods are for locking region state node when executing procedures, where we may</span> |
| <span class="source-line-no">348</span><span id="line-348"> // do some time consuming work under the lock, for example, updating meta. As we may suspend the</span> |
| <span class="source-line-no">349</span><span id="line-349"> // procedure while holding the lock and then release it when the procedure is back, in another</span> |
| <span class="source-line-no">350</span><span id="line-350"> // thread, so we need to use the procedure itself as owner, instead of the current thread. You can</span> |
| <span class="source-line-no">351</span><span id="line-351"> // see the usage in TRSP, SCP, and RegionRemoteProcedureBase for more details.</span> |
| <span class="source-line-no">352</span><span id="line-352"> // Notice that, this does not mean you must use these 3 methods when locking region state node in</span> |
| <span class="source-line-no">353</span><span id="line-353"> // procedure, you are free to use the above 3 methods if you do not want to hold the lock when</span> |
| <span class="source-line-no">354</span><span id="line-354"> // suspending the procedure.</span> |
| <span class="source-line-no">355</span><span id="line-355"> /**</span> |
| <span class="source-line-no">356</span><span id="line-356"> * @see RegionStateNodeLock#lock(Procedure, Runnable)</span> |
| <span class="source-line-no">357</span><span id="line-357"> */</span> |
| <span class="source-line-no">358</span><span id="line-358"> public void lock(Procedure<?> proc, Runnable wakeUp) throws ProcedureSuspendedException {</span> |
| <span class="source-line-no">359</span><span id="line-359"> lock.lock(proc, wakeUp);</span> |
| <span class="source-line-no">360</span><span id="line-360"> }</span> |
| <span class="source-line-no">361</span><span id="line-361"></span> |
| <span class="source-line-no">362</span><span id="line-362"> /**</span> |
| <span class="source-line-no">363</span><span id="line-363"> * @see RegionStateNodeLock#tryLock(Procedure)</span> |
| <span class="source-line-no">364</span><span id="line-364"> */</span> |
| <span class="source-line-no">365</span><span id="line-365"> public boolean tryLock(Procedure<?> proc) {</span> |
| <span class="source-line-no">366</span><span id="line-366"> return lock.tryLock(proc);</span> |
| <span class="source-line-no">367</span><span id="line-367"> }</span> |
| <span class="source-line-no">368</span><span id="line-368"></span> |
| <span class="source-line-no">369</span><span id="line-369"> /**</span> |
| <span class="source-line-no">370</span><span id="line-370"> * @see RegionStateNodeLock#unlock(Procedure)</span> |
| <span class="source-line-no">371</span><span id="line-371"> */</span> |
| <span class="source-line-no">372</span><span id="line-372"> public void unlock(Procedure<?> proc) {</span> |
| <span class="source-line-no">373</span><span id="line-373"> lock.unlock(proc);</span> |
| <span class="source-line-no">374</span><span id="line-374"> }</span> |
| <span class="source-line-no">375</span><span id="line-375"></span> |
| <span class="source-line-no">376</span><span id="line-376"> /**</span> |
| <span class="source-line-no">377</span><span id="line-377"> * @see RegionStateNodeLock#isLocked()</span> |
| <span class="source-line-no">378</span><span id="line-378"> */</span> |
| <span class="source-line-no">379</span><span id="line-379"> boolean isLocked() {</span> |
| <span class="source-line-no">380</span><span id="line-380"> return lock.isLocked();</span> |
| <span class="source-line-no">381</span><span id="line-381"> }</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"> * @see RegionStateNodeLock#isLockedBy(Object)</span> |
| <span class="source-line-no">385</span><span id="line-385"> */</span> |
| <span class="source-line-no">386</span><span id="line-386"> public boolean isLockedBy(Procedure<?> proc) {</span> |
| <span class="source-line-no">387</span><span id="line-387"> return lock.isLockedBy(proc);</span> |
| <span class="source-line-no">388</span><span id="line-388"> }</span> |
| <span class="source-line-no">389</span><span id="line-389">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
