| <!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.procedure2, class: RootProcedureState, enum: State"> |
| <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.procedure2;</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.HashSet;</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 java.util.Set;</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">import org.apache.yetus.audience.InterfaceStability;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.slf4j.Logger;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">029</span><span id="line-29"></span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.ProcedureState;</span> |
| <span class="source-line-no">031</span><span id="line-31"></span> |
| <span class="source-line-no">032</span><span id="line-32">/**</span> |
| <span class="source-line-no">033</span><span id="line-33"> * Internal state of the ProcedureExecutor that describes the state of a "Root Procedure". A "Root</span> |
| <span class="source-line-no">034</span><span id="line-34"> * Procedure" is a Procedure without parent, each subprocedure will be added to the "Root Procedure"</span> |
| <span class="source-line-no">035</span><span id="line-35"> * stack (or rollback-stack). RootProcedureState is used and managed only by the ProcedureExecutor.</span> |
| <span class="source-line-no">036</span><span id="line-36"> *</span> |
| <span class="source-line-no">037</span><span id="line-37"> * <pre></span> |
| <span class="source-line-no">038</span><span id="line-38"> * Long rootProcId = getRootProcedureId(proc);</span> |
| <span class="source-line-no">039</span><span id="line-39"> * rollbackStack.get(rootProcId).acquire(proc)</span> |
| <span class="source-line-no">040</span><span id="line-40"> * rollbackStack.get(rootProcId).release(proc)</span> |
| <span class="source-line-no">041</span><span id="line-41"> * ...</span> |
| <span class="source-line-no">042</span><span id="line-42"> * </pre></span> |
| <span class="source-line-no">043</span><span id="line-43"> */</span> |
| <span class="source-line-no">044</span><span id="line-44">@InterfaceAudience.Private</span> |
| <span class="source-line-no">045</span><span id="line-45">@InterfaceStability.Evolving</span> |
| <span class="source-line-no">046</span><span id="line-46">class RootProcedureState<TEnvironment> {</span> |
| <span class="source-line-no">047</span><span id="line-47"> private static final Logger LOG = LoggerFactory.getLogger(RootProcedureState.class);</span> |
| <span class="source-line-no">048</span><span id="line-48"></span> |
| <span class="source-line-no">049</span><span id="line-49"> private enum State {</span> |
| <span class="source-line-no">050</span><span id="line-50"> RUNNING, // The Procedure is running or ready to run</span> |
| <span class="source-line-no">051</span><span id="line-51"> FAILED, // The Procedure failed, waiting for the rollback executing</span> |
| <span class="source-line-no">052</span><span id="line-52"> ROLLINGBACK, // The Procedure failed and the execution was rolledback</span> |
| <span class="source-line-no">053</span><span id="line-53"> }</span> |
| <span class="source-line-no">054</span><span id="line-54"></span> |
| <span class="source-line-no">055</span><span id="line-55"> private Set<Procedure<TEnvironment>> subprocs = null;</span> |
| <span class="source-line-no">056</span><span id="line-56"> private ArrayList<Procedure<TEnvironment>> subprocStack = null;</span> |
| <span class="source-line-no">057</span><span id="line-57"> private State state = State.RUNNING;</span> |
| <span class="source-line-no">058</span><span id="line-58"> private int running = 0;</span> |
| <span class="source-line-no">059</span><span id="line-59"> // for some procedures such as SCP and TRSP, there is no way to rollback, so we do not need to</span> |
| <span class="source-line-no">060</span><span id="line-60"> // maintain the rollback steps</span> |
| <span class="source-line-no">061</span><span id="line-61"> // TODO: the rollback logic is a bit complicated, so here we will only test whether the root</span> |
| <span class="source-line-no">062</span><span id="line-62"> // procedure supports rollback at the very beginning, actually, lots of procedure can only</span> |
| <span class="source-line-no">063</span><span id="line-63"> // rollback at the pre check step, after that there is no rollback too, we should try to support</span> |
| <span class="source-line-no">064</span><span id="line-64"> // this too.</span> |
| <span class="source-line-no">065</span><span id="line-65"> private boolean rollbackSupported;</span> |
| <span class="source-line-no">066</span><span id="line-66"></span> |
| <span class="source-line-no">067</span><span id="line-67"> protected synchronized boolean isFailed() {</span> |
| <span class="source-line-no">068</span><span id="line-68"> switch (state) {</span> |
| <span class="source-line-no">069</span><span id="line-69"> case ROLLINGBACK:</span> |
| <span class="source-line-no">070</span><span id="line-70"> case FAILED:</span> |
| <span class="source-line-no">071</span><span id="line-71"> return true;</span> |
| <span class="source-line-no">072</span><span id="line-72"> default:</span> |
| <span class="source-line-no">073</span><span id="line-73"> break;</span> |
| <span class="source-line-no">074</span><span id="line-74"> }</span> |
| <span class="source-line-no">075</span><span id="line-75"> return false;</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"> protected synchronized boolean isRollingback() {</span> |
| <span class="source-line-no">079</span><span id="line-79"> return state == State.ROLLINGBACK;</span> |
| <span class="source-line-no">080</span><span id="line-80"> }</span> |
| <span class="source-line-no">081</span><span id="line-81"></span> |
| <span class="source-line-no">082</span><span id="line-82"> /**</span> |
| <span class="source-line-no">083</span><span id="line-83"> * Called by the ProcedureExecutor to mark rollback execution</span> |
| <span class="source-line-no">084</span><span id="line-84"> */</span> |
| <span class="source-line-no">085</span><span id="line-85"> protected synchronized boolean setRollback() {</span> |
| <span class="source-line-no">086</span><span id="line-86"> if (running == 0 && state == State.FAILED) {</span> |
| <span class="source-line-no">087</span><span id="line-87"> state = State.ROLLINGBACK;</span> |
| <span class="source-line-no">088</span><span id="line-88"> return true;</span> |
| <span class="source-line-no">089</span><span id="line-89"> }</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"></span> |
| <span class="source-line-no">093</span><span id="line-93"> /**</span> |
| <span class="source-line-no">094</span><span id="line-94"> * Called by the ProcedureExecutor to mark rollback execution</span> |
| <span class="source-line-no">095</span><span id="line-95"> */</span> |
| <span class="source-line-no">096</span><span id="line-96"> protected synchronized void unsetRollback() {</span> |
| <span class="source-line-no">097</span><span id="line-97"> assert state == State.ROLLINGBACK;</span> |
| <span class="source-line-no">098</span><span id="line-98"> state = State.FAILED;</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"> protected synchronized void setRollbackSupported(boolean rollbackSupported) {</span> |
| <span class="source-line-no">102</span><span id="line-102"> this.rollbackSupported = rollbackSupported;</span> |
| <span class="source-line-no">103</span><span id="line-103"> }</span> |
| <span class="source-line-no">104</span><span id="line-104"></span> |
| <span class="source-line-no">105</span><span id="line-105"> protected synchronized boolean isRollbackSupported() {</span> |
| <span class="source-line-no">106</span><span id="line-106"> return rollbackSupported;</span> |
| <span class="source-line-no">107</span><span id="line-107"> }</span> |
| <span class="source-line-no">108</span><span id="line-108"></span> |
| <span class="source-line-no">109</span><span id="line-109"> protected synchronized long[] getSubprocedureIds() {</span> |
| <span class="source-line-no">110</span><span id="line-110"> if (subprocs == null) {</span> |
| <span class="source-line-no">111</span><span id="line-111"> return null;</span> |
| <span class="source-line-no">112</span><span id="line-112"> }</span> |
| <span class="source-line-no">113</span><span id="line-113"> return subprocs.stream().mapToLong(Procedure::getProcId).toArray();</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"> protected synchronized Collection<Procedure<TEnvironment>> getSubprocs() {</span> |
| <span class="source-line-no">117</span><span id="line-117"> return subprocs;</span> |
| <span class="source-line-no">118</span><span id="line-118"> }</span> |
| <span class="source-line-no">119</span><span id="line-119"></span> |
| <span class="source-line-no">120</span><span id="line-120"> protected synchronized List<Procedure<TEnvironment>> getSubproceduresStack() {</span> |
| <span class="source-line-no">121</span><span id="line-121"> return subprocStack;</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"> protected synchronized RemoteProcedureException getException() {</span> |
| <span class="source-line-no">125</span><span id="line-125"> if (subprocs != null) {</span> |
| <span class="source-line-no">126</span><span id="line-126"> for (Procedure<TEnvironment> proc : subprocs) {</span> |
| <span class="source-line-no">127</span><span id="line-127"> if (proc.hasException()) {</span> |
| <span class="source-line-no">128</span><span id="line-128"> return proc.getException();</span> |
| <span class="source-line-no">129</span><span id="line-129"> }</span> |
| <span class="source-line-no">130</span><span id="line-130"> }</span> |
| <span class="source-line-no">131</span><span id="line-131"> }</span> |
| <span class="source-line-no">132</span><span id="line-132"> return 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"> * Called by the ProcedureExecutor to mark the procedure step as running.</span> |
| <span class="source-line-no">137</span><span id="line-137"> */</span> |
| <span class="source-line-no">138</span><span id="line-138"> protected synchronized boolean acquire(Procedure<TEnvironment> proc) {</span> |
| <span class="source-line-no">139</span><span id="line-139"> if (state != State.RUNNING) {</span> |
| <span class="source-line-no">140</span><span id="line-140"> return false;</span> |
| <span class="source-line-no">141</span><span id="line-141"> }</span> |
| <span class="source-line-no">142</span><span id="line-142"></span> |
| <span class="source-line-no">143</span><span id="line-143"> running++;</span> |
| <span class="source-line-no">144</span><span id="line-144"> return true;</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"> * Called by the ProcedureExecutor to mark the procedure step as finished.</span> |
| <span class="source-line-no">149</span><span id="line-149"> */</span> |
| <span class="source-line-no">150</span><span id="line-150"> protected synchronized void release(Procedure<TEnvironment> proc) {</span> |
| <span class="source-line-no">151</span><span id="line-151"> running--;</span> |
| <span class="source-line-no">152</span><span id="line-152"> }</span> |
| <span class="source-line-no">153</span><span id="line-153"></span> |
| <span class="source-line-no">154</span><span id="line-154"> protected synchronized void abort() {</span> |
| <span class="source-line-no">155</span><span id="line-155"> if (state == State.RUNNING) {</span> |
| <span class="source-line-no">156</span><span id="line-156"> state = State.FAILED;</span> |
| <span class="source-line-no">157</span><span id="line-157"> }</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"> /**</span> |
| <span class="source-line-no">161</span><span id="line-161"> * Called by the ProcedureExecutor after the procedure step is completed, to add the step to the</span> |
| <span class="source-line-no">162</span><span id="line-162"> * rollback list (or procedure stack).</span> |
| <span class="source-line-no">163</span><span id="line-163"> * <p></span> |
| <span class="source-line-no">164</span><span id="line-164"> * Return whether we successfully added the rollback step. If the root procedure has already</span> |
| <span class="source-line-no">165</span><span id="line-165"> * crossed the PONR, we do not need to maintain the rollback step,</span> |
| <span class="source-line-no">166</span><span id="line-166"> */</span> |
| <span class="source-line-no">167</span><span id="line-167"> protected synchronized boolean addRollbackStep(Procedure<TEnvironment> proc) {</span> |
| <span class="source-line-no">168</span><span id="line-168"> if (proc.isFailed()) {</span> |
| <span class="source-line-no">169</span><span id="line-169"> state = State.FAILED;</span> |
| <span class="source-line-no">170</span><span id="line-170"> }</span> |
| <span class="source-line-no">171</span><span id="line-171"> if (!rollbackSupported) {</span> |
| <span class="source-line-no">172</span><span id="line-172"> // just record executed, skip adding rollback step</span> |
| <span class="source-line-no">173</span><span id="line-173"> proc.setExecuted();</span> |
| <span class="source-line-no">174</span><span id="line-174"> return false;</span> |
| <span class="source-line-no">175</span><span id="line-175"> }</span> |
| <span class="source-line-no">176</span><span id="line-176"> if (subprocStack == null) {</span> |
| <span class="source-line-no">177</span><span id="line-177"> subprocStack = new ArrayList<>();</span> |
| <span class="source-line-no">178</span><span id="line-178"> }</span> |
| <span class="source-line-no">179</span><span id="line-179"> proc.addStackIndex(subprocStack.size());</span> |
| <span class="source-line-no">180</span><span id="line-180"> LOG.trace("Add procedure {} as the {}th rollback step", proc, subprocStack.size());</span> |
| <span class="source-line-no">181</span><span id="line-181"> subprocStack.add(proc);</span> |
| <span class="source-line-no">182</span><span id="line-182"> return true;</span> |
| <span class="source-line-no">183</span><span id="line-183"> }</span> |
| <span class="source-line-no">184</span><span id="line-184"></span> |
| <span class="source-line-no">185</span><span id="line-185"> protected synchronized void addSubProcedure(Procedure<TEnvironment> proc) {</span> |
| <span class="source-line-no">186</span><span id="line-186"> if (!proc.hasParent()) {</span> |
| <span class="source-line-no">187</span><span id="line-187"> return;</span> |
| <span class="source-line-no">188</span><span id="line-188"> }</span> |
| <span class="source-line-no">189</span><span id="line-189"> if (subprocs == null) {</span> |
| <span class="source-line-no">190</span><span id="line-190"> subprocs = new HashSet<>();</span> |
| <span class="source-line-no">191</span><span id="line-191"> }</span> |
| <span class="source-line-no">192</span><span id="line-192"> subprocs.add(proc);</span> |
| <span class="source-line-no">193</span><span id="line-193"> }</span> |
| <span class="source-line-no">194</span><span id="line-194"></span> |
| <span class="source-line-no">195</span><span id="line-195"> /**</span> |
| <span class="source-line-no">196</span><span id="line-196"> * Called on store load by the ProcedureExecutor to load part of the stack. Each procedure has its</span> |
| <span class="source-line-no">197</span><span id="line-197"> * own stack-positions. Which means we have to write to the store only the Procedure we executed,</span> |
| <span class="source-line-no">198</span><span id="line-198"> * and nothing else. on load we recreate the full stack by aggregating each procedure</span> |
| <span class="source-line-no">199</span><span id="line-199"> * stack-positions.</span> |
| <span class="source-line-no">200</span><span id="line-200"> */</span> |
| <span class="source-line-no">201</span><span id="line-201"> protected synchronized void loadStack(Procedure<TEnvironment> proc) {</span> |
| <span class="source-line-no">202</span><span id="line-202"> addSubProcedure(proc);</span> |
| <span class="source-line-no">203</span><span id="line-203"> int[] stackIndexes = proc.getStackIndexes();</span> |
| <span class="source-line-no">204</span><span id="line-204"> if (stackIndexes != null) {</span> |
| <span class="source-line-no">205</span><span id="line-205"> if (subprocStack == null) {</span> |
| <span class="source-line-no">206</span><span id="line-206"> subprocStack = new ArrayList<>();</span> |
| <span class="source-line-no">207</span><span id="line-207"> }</span> |
| <span class="source-line-no">208</span><span id="line-208"> int diff = (1 + stackIndexes[stackIndexes.length - 1]) - subprocStack.size();</span> |
| <span class="source-line-no">209</span><span id="line-209"> if (diff > 0) {</span> |
| <span class="source-line-no">210</span><span id="line-210"> subprocStack.ensureCapacity(1 + stackIndexes[stackIndexes.length - 1]);</span> |
| <span class="source-line-no">211</span><span id="line-211"> while (diff-- > 0) {</span> |
| <span class="source-line-no">212</span><span id="line-212"> subprocStack.add(null);</span> |
| <span class="source-line-no">213</span><span id="line-213"> }</span> |
| <span class="source-line-no">214</span><span id="line-214"> }</span> |
| <span class="source-line-no">215</span><span id="line-215"> for (int i = 0; i < stackIndexes.length; ++i) {</span> |
| <span class="source-line-no">216</span><span id="line-216"> subprocStack.set(stackIndexes[i], proc);</span> |
| <span class="source-line-no">217</span><span id="line-217"> }</span> |
| <span class="source-line-no">218</span><span id="line-218"> }</span> |
| <span class="source-line-no">219</span><span id="line-219"> if (proc.getState() == ProcedureState.ROLLEDBACK) {</span> |
| <span class="source-line-no">220</span><span id="line-220"> state = State.ROLLINGBACK;</span> |
| <span class="source-line-no">221</span><span id="line-221"> } else if (proc.isFailed()) {</span> |
| <span class="source-line-no">222</span><span id="line-222"> state = State.FAILED;</span> |
| <span class="source-line-no">223</span><span id="line-223"> }</span> |
| <span class="source-line-no">224</span><span id="line-224"> }</span> |
| <span class="source-line-no">225</span><span id="line-225"></span> |
| <span class="source-line-no">226</span><span id="line-226"> /**</span> |
| <span class="source-line-no">227</span><span id="line-227"> * Called on store load by the ProcedureExecutor to validate the procedure stack.</span> |
| <span class="source-line-no">228</span><span id="line-228"> */</span> |
| <span class="source-line-no">229</span><span id="line-229"> protected synchronized boolean isValid() {</span> |
| <span class="source-line-no">230</span><span id="line-230"> if (subprocStack != null) {</span> |
| <span class="source-line-no">231</span><span id="line-231"> for (Procedure<TEnvironment> proc : subprocStack) {</span> |
| <span class="source-line-no">232</span><span id="line-232"> if (proc == null) {</span> |
| <span class="source-line-no">233</span><span id="line-233"> return false;</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"> }</span> |
| <span class="source-line-no">237</span><span id="line-237"> return true;</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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
