| <!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: Procedure"> |
| <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.io.IOException;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.util.Arrays;</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.concurrent.ThreadLocalRandom;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.exceptions.TimeoutIOException;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.metrics.Counter;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.metrics.Histogram;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.procedure2.store.ProcedureStore;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.procedure2.util.StringUtils;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.security.User;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.util.NonceKey;</span> |
| <span class="source-line-no">033</span><span id="line-33">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">034</span><span id="line-34">import org.slf4j.Logger;</span> |
| <span class="source-line-no">035</span><span id="line-35">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">036</span><span id="line-36"></span> |
| <span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos;</span> |
| <span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.ProcedureState;</span> |
| <span class="source-line-no">039</span><span id="line-39"></span> |
| <span class="source-line-no">040</span><span id="line-40">/**</span> |
| <span class="source-line-no">041</span><span id="line-41"> * Base Procedure class responsible for Procedure Metadata; e.g. state, submittedTime, lastUpdate,</span> |
| <span class="source-line-no">042</span><span id="line-42"> * stack-indexes, etc.</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"> * Procedures are run by a {@link ProcedureExecutor} instance. They are submitted and then the</span> |
| <span class="source-line-no">045</span><span id="line-45"> * ProcedureExecutor keeps calling {@link #execute(Object)} until the Procedure is done. Execute may</span> |
| <span class="source-line-no">046</span><span id="line-46"> * be called multiple times in the case of failure or a restart, so code must be idempotent. The</span> |
| <span class="source-line-no">047</span><span id="line-47"> * return from an execute call is either: null to indicate we are done; ourself if there is more to</span> |
| <span class="source-line-no">048</span><span id="line-48"> * do; or, a set of sub-procedures that need to be run to completion before the framework resumes</span> |
| <span class="source-line-no">049</span><span id="line-49"> * our execution.</span> |
| <span class="source-line-no">050</span><span id="line-50"> * <p/></span> |
| <span class="source-line-no">051</span><span id="line-51"> * The ProcedureExecutor keeps its notion of Procedure State in the Procedure itself; e.g. it stamps</span> |
| <span class="source-line-no">052</span><span id="line-52"> * the Procedure as INITIALIZING, RUNNABLE, SUCCESS, etc. Here are some of the States defined in the</span> |
| <span class="source-line-no">053</span><span id="line-53"> * ProcedureState enum from protos:</span> |
| <span class="source-line-no">054</span><span id="line-54"> * <ul></span> |
| <span class="source-line-no">055</span><span id="line-55"> * <li>{@link #isFailed()} A procedure has executed at least once and has failed. The procedure may</span> |
| <span class="source-line-no">056</span><span id="line-56"> * or may not have rolled back yet. Any procedure in FAILED state will be eventually moved to</span> |
| <span class="source-line-no">057</span><span id="line-57"> * ROLLEDBACK state.</li></span> |
| <span class="source-line-no">058</span><span id="line-58"> * <li>{@link #isSuccess()} A procedure is completed successfully without exception.</li></span> |
| <span class="source-line-no">059</span><span id="line-59"> * <li>{@link #isFinished()} As a procedure in FAILED state will be tried forever for rollback, only</span> |
| <span class="source-line-no">060</span><span id="line-60"> * condition when scheduler/ executor will drop procedure from further processing is when procedure</span> |
| <span class="source-line-no">061</span><span id="line-61"> * state is ROLLEDBACK or isSuccess() returns true. This is a terminal state of the procedure.</li></span> |
| <span class="source-line-no">062</span><span id="line-62"> * <li>{@link #isWaiting()} - Procedure is in one of the two waiting states</span> |
| <span class="source-line-no">063</span><span id="line-63"> * ({@link ProcedureState#WAITING}, {@link ProcedureState#WAITING_TIMEOUT}).</li></span> |
| <span class="source-line-no">064</span><span id="line-64"> * </ul></span> |
| <span class="source-line-no">065</span><span id="line-65"> * NOTE: These states are of the ProcedureExecutor. Procedure implementations in turn can keep their</span> |
| <span class="source-line-no">066</span><span id="line-66"> * own state. This can lead to confusion. Try to keep the two distinct.</span> |
| <span class="source-line-no">067</span><span id="line-67"> * <p/></span> |
| <span class="source-line-no">068</span><span id="line-68"> * rollback() is called when the procedure or one of the sub-procedures has failed. The rollback</span> |
| <span class="source-line-no">069</span><span id="line-69"> * step is supposed to cleanup the resources created during the execute() step. In case of failure</span> |
| <span class="source-line-no">070</span><span id="line-70"> * and restart, rollback() may be called multiple times, so again the code must be idempotent.</span> |
| <span class="source-line-no">071</span><span id="line-71"> * <p/></span> |
| <span class="source-line-no">072</span><span id="line-72"> * Procedure can be made respect a locking regime. It has acquire/release methods as well as an</span> |
| <span class="source-line-no">073</span><span id="line-73"> * {@link #hasLock()}. The lock implementation is up to the implementor. If an entity needs to be</span> |
| <span class="source-line-no">074</span><span id="line-74"> * locked for the life of a procedure -- not just the calls to execute -- then implementations</span> |
| <span class="source-line-no">075</span><span id="line-75"> * should say so with the {@link #holdLock(Object)} method.</span> |
| <span class="source-line-no">076</span><span id="line-76"> * <p/></span> |
| <span class="source-line-no">077</span><span id="line-77"> * And since we need to restore the lock when restarting to keep the logic correct(HBASE-20846), the</span> |
| <span class="source-line-no">078</span><span id="line-78"> * implementation is a bit tricky so we add some comments hrre about it.</span> |
| <span class="source-line-no">079</span><span id="line-79"> * <ul></span> |
| <span class="source-line-no">080</span><span id="line-80"> * <li>Make {@link #hasLock()} method final, and add a {@link #locked} field in Procedure to record</span> |
| <span class="source-line-no">081</span><span id="line-81"> * whether we have the lock. We will set it to {@code true} in</span> |
| <span class="source-line-no">082</span><span id="line-82"> * {@link #doAcquireLock(Object, ProcedureStore)} and to {@code false} in</span> |
| <span class="source-line-no">083</span><span id="line-83"> * {@link #doReleaseLock(Object, ProcedureStore)}. The sub classes do not need to manage it any</span> |
| <span class="source-line-no">084</span><span id="line-84"> * more.</li></span> |
| <span class="source-line-no">085</span><span id="line-85"> * <li>Also added a locked field in the proto message. When storing, the field will be set according</span> |
| <span class="source-line-no">086</span><span id="line-86"> * to the return value of {@link #hasLock()}. And when loading, there is a new field in Procedure</span> |
| <span class="source-line-no">087</span><span id="line-87"> * called {@link #lockedWhenLoading}. We will set it to {@code true} if the locked field in proto</span> |
| <span class="source-line-no">088</span><span id="line-88"> * message is {@code true}.</li></span> |
| <span class="source-line-no">089</span><span id="line-89"> * <li>The reason why we can not set the {@link #locked} field directly to {@code true} by calling</span> |
| <span class="source-line-no">090</span><span id="line-90"> * {@link #doAcquireLock(Object, ProcedureStore)} is that, during initialization, most procedures</span> |
| <span class="source-line-no">091</span><span id="line-91"> * need to wait until master is initialized. So the solution here is that, we introduced a new</span> |
| <span class="source-line-no">092</span><span id="line-92"> * method called {@link #waitInitialized(Object)} in Procedure, and move the wait master initialized</span> |
| <span class="source-line-no">093</span><span id="line-93"> * related code from {@link #acquireLock(Object)} to this method. And we added a restoreLock method</span> |
| <span class="source-line-no">094</span><span id="line-94"> * to Procedure, if {@link #lockedWhenLoading} is {@code true}, we will call the</span> |
| <span class="source-line-no">095</span><span id="line-95"> * {@link #acquireLock(Object)} to get the lock, but do not set {@link #locked} to true. And later</span> |
| <span class="source-line-no">096</span><span id="line-96"> * when we call {@link #doAcquireLock(Object, ProcedureStore)} and pass the</span> |
| <span class="source-line-no">097</span><span id="line-97"> * {@link #waitInitialized(Object)} check, we will test {@link #lockedWhenLoading}, if it is</span> |
| <span class="source-line-no">098</span><span id="line-98"> * {@code true}, when we just set the {@link #locked} field to true and return, without actually</span> |
| <span class="source-line-no">099</span><span id="line-99"> * calling the {@link #acquireLock(Object)} method since we have already called it once.</li></span> |
| <span class="source-line-no">100</span><span id="line-100"> * </ul></span> |
| <span class="source-line-no">101</span><span id="line-101"> * <p/></span> |
| <span class="source-line-no">102</span><span id="line-102"> * Procedures can be suspended or put in wait state with a callback that gets executed on</span> |
| <span class="source-line-no">103</span><span id="line-103"> * Procedure-specified timeout. See {@link #setTimeout(int)}}, and</span> |
| <span class="source-line-no">104</span><span id="line-104"> * {@link #setTimeoutFailure(Object)}. See TestProcedureEvents and the TestTimeoutEventProcedure</span> |
| <span class="source-line-no">105</span><span id="line-105"> * class for an example usage.</span> |
| <span class="source-line-no">106</span><span id="line-106"> * </p></span> |
| <span class="source-line-no">107</span><span id="line-107"> * <p/></span> |
| <span class="source-line-no">108</span><span id="line-108"> * There are hooks for collecting metrics on submit of the procedure and on finish. See</span> |
| <span class="source-line-no">109</span><span id="line-109"> * {@link #updateMetricsOnSubmit(Object)} and {@link #updateMetricsOnFinish(Object, long, boolean)}.</span> |
| <span class="source-line-no">110</span><span id="line-110"> */</span> |
| <span class="source-line-no">111</span><span id="line-111">@InterfaceAudience.Private</span> |
| <span class="source-line-no">112</span><span id="line-112">public abstract class Procedure<TEnvironment> implements Comparable<Procedure<TEnvironment>> {</span> |
| <span class="source-line-no">113</span><span id="line-113"> private static final Logger LOG = LoggerFactory.getLogger(Procedure.class);</span> |
| <span class="source-line-no">114</span><span id="line-114"> public static final long NO_PROC_ID = -1;</span> |
| <span class="source-line-no">115</span><span id="line-115"> protected static final int NO_TIMEOUT = -1;</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 enum LockState {</span> |
| <span class="source-line-no">118</span><span id="line-118"> LOCK_ACQUIRED, // Lock acquired and ready to execute</span> |
| <span class="source-line-no">119</span><span id="line-119"> LOCK_YIELD_WAIT, // Lock not acquired, framework needs to yield</span> |
| <span class="source-line-no">120</span><span id="line-120"> LOCK_EVENT_WAIT, // Lock not acquired, an event will yield the procedure</span> |
| <span class="source-line-no">121</span><span id="line-121"> }</span> |
| <span class="source-line-no">122</span><span id="line-122"></span> |
| <span class="source-line-no">123</span><span id="line-123"> // Unchanged after initialization</span> |
| <span class="source-line-no">124</span><span id="line-124"> private NonceKey nonceKey = null;</span> |
| <span class="source-line-no">125</span><span id="line-125"> private String owner = null;</span> |
| <span class="source-line-no">126</span><span id="line-126"> private long parentProcId = NO_PROC_ID;</span> |
| <span class="source-line-no">127</span><span id="line-127"> private long rootProcId = NO_PROC_ID;</span> |
| <span class="source-line-no">128</span><span id="line-128"> private long procId = NO_PROC_ID;</span> |
| <span class="source-line-no">129</span><span id="line-129"> private long submittedTime;</span> |
| <span class="source-line-no">130</span><span id="line-130"></span> |
| <span class="source-line-no">131</span><span id="line-131"> // Runtime state, updated every operation</span> |
| <span class="source-line-no">132</span><span id="line-132"> private ProcedureState state = ProcedureState.INITIALIZING;</span> |
| <span class="source-line-no">133</span><span id="line-133"> private RemoteProcedureException exception = null;</span> |
| <span class="source-line-no">134</span><span id="line-134"> private int[] stackIndexes = null;</span> |
| <span class="source-line-no">135</span><span id="line-135"> private int childrenLatch = 0;</span> |
| <span class="source-line-no">136</span><span id="line-136"> // since we do not always maintain stackIndexes if the root procedure does not support rollback,</span> |
| <span class="source-line-no">137</span><span id="line-137"> // we need a separated flag to indicate whether a procedure was executed</span> |
| <span class="source-line-no">138</span><span id="line-138"> private boolean wasExecuted;</span> |
| <span class="source-line-no">139</span><span id="line-139"></span> |
| <span class="source-line-no">140</span><span id="line-140"> private volatile int timeout = NO_TIMEOUT;</span> |
| <span class="source-line-no">141</span><span id="line-141"> private volatile long lastUpdate;</span> |
| <span class="source-line-no">142</span><span id="line-142"></span> |
| <span class="source-line-no">143</span><span id="line-143"> private volatile byte[] result = null;</span> |
| <span class="source-line-no">144</span><span id="line-144"></span> |
| <span class="source-line-no">145</span><span id="line-145"> private volatile boolean locked = false;</span> |
| <span class="source-line-no">146</span><span id="line-146"></span> |
| <span class="source-line-no">147</span><span id="line-147"> private boolean lockedWhenLoading = false;</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"> * Used for override complete of the procedure without actually doing any logic in the procedure.</span> |
| <span class="source-line-no">151</span><span id="line-151"> * If bypass is set to true, when executing it will return null when {@link #doExecute(Object)} is</span> |
| <span class="source-line-no">152</span><span id="line-152"> * called to finish the procedure and release any locks it may currently hold. The bypass does</span> |
| <span class="source-line-no">153</span><span id="line-153"> * cleanup around the Procedure as far as the Procedure framework is concerned. It does not clean</span> |
| <span class="source-line-no">154</span><span id="line-154"> * any internal state that the Procedure's themselves may have set. That is for the Procedures to</span> |
| <span class="source-line-no">155</span><span id="line-155"> * do themselves when bypass is called. They should override bypass and do their cleanup in the</span> |
| <span class="source-line-no">156</span><span id="line-156"> * overridden bypass method (be sure to call the parent bypass to ensure proper processing).</span> |
| <span class="source-line-no">157</span><span id="line-157"> * <p></span> |
| <span class="source-line-no">158</span><span id="line-158"> * </p></span> |
| <span class="source-line-no">159</span><span id="line-159"> * Bypassing a procedure is not like aborting. Aborting a procedure will trigger a rollback. And</span> |
| <span class="source-line-no">160</span><span id="line-160"> * since the {@link #abort(Object)} method is overrideable Some procedures may have chosen to</span> |
| <span class="source-line-no">161</span><span id="line-161"> * ignore the aborting.</span> |
| <span class="source-line-no">162</span><span id="line-162"> */</span> |
| <span class="source-line-no">163</span><span id="line-163"> private volatile boolean bypass = false;</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"> * Indicate whether we need to persist the procedure to ProcedureStore after execution. Default to</span> |
| <span class="source-line-no">167</span><span id="line-167"> * true, and the implementation can all {@link #skipPersistence()} to let the framework skip the</span> |
| <span class="source-line-no">168</span><span id="line-168"> * persistence of the procedure.</span> |
| <span class="source-line-no">169</span><span id="line-169"> * <p/></span> |
| <span class="source-line-no">170</span><span id="line-170"> * This is useful when the procedure is in error and you want to retry later. The retry interval</span> |
| <span class="source-line-no">171</span><span id="line-171"> * and the number of retries are usually not critical so skip the persistence can save some</span> |
| <span class="source-line-no">172</span><span id="line-172"> * resources, and also speed up the restart processing.</span> |
| <span class="source-line-no">173</span><span id="line-173"> * <p/></span> |
| <span class="source-line-no">174</span><span id="line-174"> * Notice that this value will be reset to true every time before execution. And when rolling back</span> |
| <span class="source-line-no">175</span><span id="line-175"> * we do not test this value.</span> |
| <span class="source-line-no">176</span><span id="line-176"> */</span> |
| <span class="source-line-no">177</span><span id="line-177"> private boolean persist = true;</span> |
| <span class="source-line-no">178</span><span id="line-178"></span> |
| <span class="source-line-no">179</span><span id="line-179"> public boolean isBypass() {</span> |
| <span class="source-line-no">180</span><span id="line-180"> return bypass;</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> |
| <span class="source-line-no">183</span><span id="line-183"> /**</span> |
| <span class="source-line-no">184</span><span id="line-184"> * Set the bypass to true. Only called in</span> |
| <span class="source-line-no">185</span><span id="line-185"> * {@link ProcedureExecutor#bypassProcedure(long, long, boolean, boolean)} for now. DO NOT use</span> |
| <span class="source-line-no">186</span><span id="line-186"> * this method alone, since we can't just bypass one single procedure. We need to bypass its</span> |
| <span class="source-line-no">187</span><span id="line-187"> * ancestor too. If your Procedure has set state, it needs to undo it in here.</span> |
| <span class="source-line-no">188</span><span id="line-188"> * @param env Current environment. May be null because of context; e.g. pretty-printing procedure</span> |
| <span class="source-line-no">189</span><span id="line-189"> * WALs where there is no 'environment' (and where Procedures that require an</span> |
| <span class="source-line-no">190</span><span id="line-190"> * 'environment' won't be run.</span> |
| <span class="source-line-no">191</span><span id="line-191"> */</span> |
| <span class="source-line-no">192</span><span id="line-192"> protected void bypass(TEnvironment env) {</span> |
| <span class="source-line-no">193</span><span id="line-193"> this.bypass = true;</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"> boolean needPersistence() {</span> |
| <span class="source-line-no">197</span><span id="line-197"> return persist;</span> |
| <span class="source-line-no">198</span><span id="line-198"> }</span> |
| <span class="source-line-no">199</span><span id="line-199"></span> |
| <span class="source-line-no">200</span><span id="line-200"> void resetPersistence() {</span> |
| <span class="source-line-no">201</span><span id="line-201"> persist = true;</span> |
| <span class="source-line-no">202</span><span id="line-202"> }</span> |
| <span class="source-line-no">203</span><span id="line-203"></span> |
| <span class="source-line-no">204</span><span id="line-204"> protected final void skipPersistence() {</span> |
| <span class="source-line-no">205</span><span id="line-205"> persist = false;</span> |
| <span class="source-line-no">206</span><span id="line-206"> }</span> |
| <span class="source-line-no">207</span><span id="line-207"></span> |
| <span class="source-line-no">208</span><span id="line-208"> /**</span> |
| <span class="source-line-no">209</span><span id="line-209"> * The main code of the procedure. It must be idempotent since execute() may be called multiple</span> |
| <span class="source-line-no">210</span><span id="line-210"> * times in case of machine failure in the middle of the execution.</span> |
| <span class="source-line-no">211</span><span id="line-211"> * @param env the environment passed to the ProcedureExecutor</span> |
| <span class="source-line-no">212</span><span id="line-212"> * @return a set of sub-procedures to run or ourselves if there is more work to do or null if the</span> |
| <span class="source-line-no">213</span><span id="line-213"> * procedure is done.</span> |
| <span class="source-line-no">214</span><span id="line-214"> * @throws ProcedureYieldException the procedure will be added back to the queue and retried</span> |
| <span class="source-line-no">215</span><span id="line-215"> * later.</span> |
| <span class="source-line-no">216</span><span id="line-216"> * @throws InterruptedException the procedure will be added back to the queue and retried</span> |
| <span class="source-line-no">217</span><span id="line-217"> * later.</span> |
| <span class="source-line-no">218</span><span id="line-218"> * @throws ProcedureSuspendedException Signal to the executor that Procedure has suspended itself</span> |
| <span class="source-line-no">219</span><span id="line-219"> * and has set itself up waiting for an external event to wake</span> |
| <span class="source-line-no">220</span><span id="line-220"> * it back up again.</span> |
| <span class="source-line-no">221</span><span id="line-221"> */</span> |
| <span class="source-line-no">222</span><span id="line-222"> protected abstract Procedure<TEnvironment>[] execute(TEnvironment env)</span> |
| <span class="source-line-no">223</span><span id="line-223"> throws ProcedureYieldException, ProcedureSuspendedException, InterruptedException;</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"> * The code to undo what was done by the execute() code. It is called when the procedure or one of</span> |
| <span class="source-line-no">227</span><span id="line-227"> * the sub-procedures failed or an abort was requested. It should cleanup all the resources</span> |
| <span class="source-line-no">228</span><span id="line-228"> * created by the execute() call. The implementation must be idempotent since rollback() may be</span> |
| <span class="source-line-no">229</span><span id="line-229"> * called multiple time in case of machine failure in the middle of the execution.</span> |
| <span class="source-line-no">230</span><span id="line-230"> * @param env the environment passed to the ProcedureExecutor</span> |
| <span class="source-line-no">231</span><span id="line-231"> * @throws IOException temporary failure, the rollback will retry later</span> |
| <span class="source-line-no">232</span><span id="line-232"> * @throws InterruptedException the procedure will be added back to the queue and retried later</span> |
| <span class="source-line-no">233</span><span id="line-233"> */</span> |
| <span class="source-line-no">234</span><span id="line-234"> protected abstract void rollback(TEnvironment env) throws IOException, InterruptedException;</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"> * The abort() call is asynchronous and each procedure must decide how to deal with it, if they</span> |
| <span class="source-line-no">238</span><span id="line-238"> * want to be abortable. The simplest implementation is to have an AtomicBoolean set in the</span> |
| <span class="source-line-no">239</span><span id="line-239"> * abort() method and then the execute() will check if the abort flag is set or not. abort() may</span> |
| <span class="source-line-no">240</span><span id="line-240"> * be called multiple times from the client, so the implementation must be idempotent.</span> |
| <span class="source-line-no">241</span><span id="line-241"> * <p></span> |
| <span class="source-line-no">242</span><span id="line-242"> * NOTE: abort() is not like Thread.interrupt(). It is just a notification that allows the</span> |
| <span class="source-line-no">243</span><span id="line-243"> * procedure implementor abort.</span> |
| <span class="source-line-no">244</span><span id="line-244"> */</span> |
| <span class="source-line-no">245</span><span id="line-245"> protected abstract boolean abort(TEnvironment env);</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"> * The user-level code of the procedure may have some state to persist (e.g. input arguments or</span> |
| <span class="source-line-no">249</span><span id="line-249"> * current position in the processing state) to be able to resume on failure.</span> |
| <span class="source-line-no">250</span><span id="line-250"> * @param serializer stores the serializable state</span> |
| <span class="source-line-no">251</span><span id="line-251"> */</span> |
| <span class="source-line-no">252</span><span id="line-252"> protected abstract void serializeStateData(ProcedureStateSerializer serializer)</span> |
| <span class="source-line-no">253</span><span id="line-253"> throws IOException;</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"> * Called on store load to allow the user to decode the previously serialized state.</span> |
| <span class="source-line-no">257</span><span id="line-257"> * @param serializer contains the serialized state</span> |
| <span class="source-line-no">258</span><span id="line-258"> */</span> |
| <span class="source-line-no">259</span><span id="line-259"> protected abstract void deserializeStateData(ProcedureStateSerializer serializer)</span> |
| <span class="source-line-no">260</span><span id="line-260"> throws IOException;</span> |
| <span class="source-line-no">261</span><span id="line-261"></span> |
| <span class="source-line-no">262</span><span id="line-262"> /**</span> |
| <span class="source-line-no">263</span><span id="line-263"> * The {@link #doAcquireLock(Object, ProcedureStore)} will be split into two steps, first, it will</span> |
| <span class="source-line-no">264</span><span id="line-264"> * call us to determine whether we need to wait for initialization, second, it will call</span> |
| <span class="source-line-no">265</span><span id="line-265"> * {@link #acquireLock(Object)} to actually handle the lock for this procedure.</span> |
| <span class="source-line-no">266</span><span id="line-266"> * <p/></span> |
| <span class="source-line-no">267</span><span id="line-267"> * This is because that when master restarts, we need to restore the lock state for all the</span> |
| <span class="source-line-no">268</span><span id="line-268"> * procedures to not break the semantic if {@link #holdLock(Object)} is true. But the</span> |
| <span class="source-line-no">269</span><span id="line-269"> * {@link ProcedureExecutor} will be started before the master finish initialization(as it is part</span> |
| <span class="source-line-no">270</span><span id="line-270"> * of the initialization!), so we need to split the code into two steps, and when restore, we just</span> |
| <span class="source-line-no">271</span><span id="line-271"> * restore the lock part and ignore the waitInitialized part. Otherwise there will be dead lock.</span> |
| <span class="source-line-no">272</span><span id="line-272"> * @return true means we need to wait until the environment has been initialized, otherwise true.</span> |
| <span class="source-line-no">273</span><span id="line-273"> */</span> |
| <span class="source-line-no">274</span><span id="line-274"> protected boolean waitInitialized(TEnvironment env) {</span> |
| <span class="source-line-no">275</span><span id="line-275"> return false;</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"> /**</span> |
| <span class="source-line-no">279</span><span id="line-279"> * The user should override this method if they need a lock on an Entity. A lock can be anything,</span> |
| <span class="source-line-no">280</span><span id="line-280"> * and it is up to the implementor. The Procedure Framework will call this method just before it</span> |
| <span class="source-line-no">281</span><span id="line-281"> * invokes {@link #execute(Object)}. It calls {@link #releaseLock(Object)} after the call to</span> |
| <span class="source-line-no">282</span><span id="line-282"> * execute.</span> |
| <span class="source-line-no">283</span><span id="line-283"> * <p/></span> |
| <span class="source-line-no">284</span><span id="line-284"> * If you need to hold the lock for the life of the Procedure -- i.e. you do not want any other</span> |
| <span class="source-line-no">285</span><span id="line-285"> * Procedure interfering while this Procedure is running, see {@link #holdLock(Object)}.</span> |
| <span class="source-line-no">286</span><span id="line-286"> * <p/></span> |
| <span class="source-line-no">287</span><span id="line-287"> * Example: in our Master we can execute request in parallel for different tables. We can create</span> |
| <span class="source-line-no">288</span><span id="line-288"> * t1 and create t2 and these creates can be executed at the same time. Anything else on t1/t2 is</span> |
| <span class="source-line-no">289</span><span id="line-289"> * queued waiting that specific table create to happen.</span> |
| <span class="source-line-no">290</span><span id="line-290"> * <p/></span> |
| <span class="source-line-no">291</span><span id="line-291"> * There are 3 LockState:</span> |
| <span class="source-line-no">292</span><span id="line-292"> * <ul></span> |
| <span class="source-line-no">293</span><span id="line-293"> * <li>LOCK_ACQUIRED should be returned when the proc has the lock and the proc is ready to</span> |
| <span class="source-line-no">294</span><span id="line-294"> * execute.</li></span> |
| <span class="source-line-no">295</span><span id="line-295"> * <li>LOCK_YIELD_WAIT should be returned when the proc has not the lock and the framework should</span> |
| <span class="source-line-no">296</span><span id="line-296"> * take care of readding the procedure back to the runnable set for retry</li></span> |
| <span class="source-line-no">297</span><span id="line-297"> * <li>LOCK_EVENT_WAIT should be returned when the proc has not the lock and someone will take</span> |
| <span class="source-line-no">298</span><span id="line-298"> * care of readding the procedure back to the runnable set when the lock is available.</li></span> |
| <span class="source-line-no">299</span><span id="line-299"> * </ul></span> |
| <span class="source-line-no">300</span><span id="line-300"> * @return the lock state as described above.</span> |
| <span class="source-line-no">301</span><span id="line-301"> */</span> |
| <span class="source-line-no">302</span><span id="line-302"> protected LockState acquireLock(TEnvironment env) {</span> |
| <span class="source-line-no">303</span><span id="line-303"> return LockState.LOCK_ACQUIRED;</span> |
| <span class="source-line-no">304</span><span id="line-304"> }</span> |
| <span class="source-line-no">305</span><span id="line-305"></span> |
| <span class="source-line-no">306</span><span id="line-306"> /**</span> |
| <span class="source-line-no">307</span><span id="line-307"> * The user should override this method, and release lock if necessary.</span> |
| <span class="source-line-no">308</span><span id="line-308"> */</span> |
| <span class="source-line-no">309</span><span id="line-309"> protected void releaseLock(TEnvironment env) {</span> |
| <span class="source-line-no">310</span><span id="line-310"> // no-op</span> |
| <span class="source-line-no">311</span><span id="line-311"> }</span> |
| <span class="source-line-no">312</span><span id="line-312"></span> |
| <span class="source-line-no">313</span><span id="line-313"> /**</span> |
| <span class="source-line-no">314</span><span id="line-314"> * Used to keep the procedure lock even when the procedure is yielding or suspended.</span> |
| <span class="source-line-no">315</span><span id="line-315"> * @return true if the procedure should hold on the lock until completionCleanup()</span> |
| <span class="source-line-no">316</span><span id="line-316"> */</span> |
| <span class="source-line-no">317</span><span id="line-317"> protected boolean holdLock(TEnvironment env) {</span> |
| <span class="source-line-no">318</span><span id="line-318"> return false;</span> |
| <span class="source-line-no">319</span><span id="line-319"> }</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"> * This is used in conjunction with {@link #holdLock(Object)}. If {@link #holdLock(Object)}</span> |
| <span class="source-line-no">323</span><span id="line-323"> * returns true, the procedure executor will call acquireLock() once and thereafter not call</span> |
| <span class="source-line-no">324</span><span id="line-324"> * {@link #releaseLock(Object)} until the Procedure is done (Normally, it calls release/acquire</span> |
| <span class="source-line-no">325</span><span id="line-325"> * around each invocation of {@link #execute(Object)}.</span> |
| <span class="source-line-no">326</span><span id="line-326"> * @see #holdLock(Object)</span> |
| <span class="source-line-no">327</span><span id="line-327"> * @return true if the procedure has the lock, false otherwise.</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 final boolean hasLock() {</span> |
| <span class="source-line-no">330</span><span id="line-330"> return locked;</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"> * Called when the procedure is loaded for replay. The procedure implementor may use this method</span> |
| <span class="source-line-no">335</span><span id="line-335"> * to perform some quick operation before replay. e.g. failing the procedure if the state on</span> |
| <span class="source-line-no">336</span><span id="line-336"> * replay may be unknown.</span> |
| <span class="source-line-no">337</span><span id="line-337"> */</span> |
| <span class="source-line-no">338</span><span id="line-338"> protected void beforeReplay(TEnvironment env) {</span> |
| <span class="source-line-no">339</span><span id="line-339"> // no-op</span> |
| <span class="source-line-no">340</span><span id="line-340"> }</span> |
| <span class="source-line-no">341</span><span id="line-341"></span> |
| <span class="source-line-no">342</span><span id="line-342"> /**</span> |
| <span class="source-line-no">343</span><span id="line-343"> * Called when the procedure is ready to be added to the queue after the loading/replay operation.</span> |
| <span class="source-line-no">344</span><span id="line-344"> */</span> |
| <span class="source-line-no">345</span><span id="line-345"> protected void afterReplay(TEnvironment env) {</span> |
| <span class="source-line-no">346</span><span id="line-346"> // no-op</span> |
| <span class="source-line-no">347</span><span id="line-347"> }</span> |
| <span class="source-line-no">348</span><span id="line-348"></span> |
| <span class="source-line-no">349</span><span id="line-349"> /**</span> |
| <span class="source-line-no">350</span><span id="line-350"> * Called when the procedure is marked as completed (success or rollback). The procedure</span> |
| <span class="source-line-no">351</span><span id="line-351"> * implementor may use this method to cleanup in-memory states. This operation will not be retried</span> |
| <span class="source-line-no">352</span><span id="line-352"> * on failure. If a procedure took a lock, it will have been released when this method runs.</span> |
| <span class="source-line-no">353</span><span id="line-353"> */</span> |
| <span class="source-line-no">354</span><span id="line-354"> protected void completionCleanup(TEnvironment env) {</span> |
| <span class="source-line-no">355</span><span id="line-355"> // no-op</span> |
| <span class="source-line-no">356</span><span id="line-356"> }</span> |
| <span class="source-line-no">357</span><span id="line-357"></span> |
| <span class="source-line-no">358</span><span id="line-358"> /**</span> |
| <span class="source-line-no">359</span><span id="line-359"> * By default, the procedure framework/executor will try to run procedures start to finish. Return</span> |
| <span class="source-line-no">360</span><span id="line-360"> * true to make the executor yield between each execution step to give other procedures a chance</span> |
| <span class="source-line-no">361</span><span id="line-361"> * to run.</span> |
| <span class="source-line-no">362</span><span id="line-362"> * @param env the environment passed to the ProcedureExecutor</span> |
| <span class="source-line-no">363</span><span id="line-363"> * @return Return true if the executor should yield on completion of an execution step. Defaults</span> |
| <span class="source-line-no">364</span><span id="line-364"> * to return false.</span> |
| <span class="source-line-no">365</span><span id="line-365"> */</span> |
| <span class="source-line-no">366</span><span id="line-366"> protected boolean isYieldAfterExecutionStep(TEnvironment env) {</span> |
| <span class="source-line-no">367</span><span id="line-367"> return false;</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"> /**</span> |
| <span class="source-line-no">371</span><span id="line-371"> * By default, the executor will keep the procedure result around util the eviction TTL is</span> |
| <span class="source-line-no">372</span><span id="line-372"> * expired. The client can cut down the waiting time by requesting that the result is removed from</span> |
| <span class="source-line-no">373</span><span id="line-373"> * the executor. In case of system started procedure, we can force the executor to auto-ack.</span> |
| <span class="source-line-no">374</span><span id="line-374"> * @param env the environment passed to the ProcedureExecutor</span> |
| <span class="source-line-no">375</span><span id="line-375"> * @return true if the executor should wait the client ack for the result. Defaults to return</span> |
| <span class="source-line-no">376</span><span id="line-376"> * true.</span> |
| <span class="source-line-no">377</span><span id="line-377"> */</span> |
| <span class="source-line-no">378</span><span id="line-378"> protected boolean shouldWaitClientAck(TEnvironment env) {</span> |
| <span class="source-line-no">379</span><span id="line-379"> return true;</span> |
| <span class="source-line-no">380</span><span id="line-380"> }</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"> * Override this method to provide procedure specific counters for submitted count, failed count</span> |
| <span class="source-line-no">384</span><span id="line-384"> * and time histogram.</span> |
| <span class="source-line-no">385</span><span id="line-385"> * @param env The environment passed to the procedure executor</span> |
| <span class="source-line-no">386</span><span id="line-386"> * @return Container object for procedure related metric</span> |
| <span class="source-line-no">387</span><span id="line-387"> */</span> |
| <span class="source-line-no">388</span><span id="line-388"> protected ProcedureMetrics getProcedureMetrics(TEnvironment env) {</span> |
| <span class="source-line-no">389</span><span id="line-389"> return null;</span> |
| <span class="source-line-no">390</span><span id="line-390"> }</span> |
| <span class="source-line-no">391</span><span id="line-391"></span> |
| <span class="source-line-no">392</span><span id="line-392"> /**</span> |
| <span class="source-line-no">393</span><span id="line-393"> * This function will be called just when procedure is submitted for execution. Override this</span> |
| <span class="source-line-no">394</span><span id="line-394"> * method to update the metrics at the beginning of the procedure. The default implementation</span> |
| <span class="source-line-no">395</span><span id="line-395"> * updates submitted counter if {@link #getProcedureMetrics(Object)} returns non-null</span> |
| <span class="source-line-no">396</span><span id="line-396"> * {@link ProcedureMetrics}.</span> |
| <span class="source-line-no">397</span><span id="line-397"> */</span> |
| <span class="source-line-no">398</span><span id="line-398"> protected void updateMetricsOnSubmit(TEnvironment env) {</span> |
| <span class="source-line-no">399</span><span id="line-399"> ProcedureMetrics metrics = getProcedureMetrics(env);</span> |
| <span class="source-line-no">400</span><span id="line-400"> if (metrics == null) {</span> |
| <span class="source-line-no">401</span><span id="line-401"> return;</span> |
| <span class="source-line-no">402</span><span id="line-402"> }</span> |
| <span class="source-line-no">403</span><span id="line-403"></span> |
| <span class="source-line-no">404</span><span id="line-404"> Counter submittedCounter = metrics.getSubmittedCounter();</span> |
| <span class="source-line-no">405</span><span id="line-405"> if (submittedCounter != null) {</span> |
| <span class="source-line-no">406</span><span id="line-406"> submittedCounter.increment();</span> |
| <span class="source-line-no">407</span><span id="line-407"> }</span> |
| <span class="source-line-no">408</span><span id="line-408"> }</span> |
| <span class="source-line-no">409</span><span id="line-409"></span> |
| <span class="source-line-no">410</span><span id="line-410"> /**</span> |
| <span class="source-line-no">411</span><span id="line-411"> * This function will be called just after procedure execution is finished. Override this method</span> |
| <span class="source-line-no">412</span><span id="line-412"> * to update metrics at the end of the procedure. If {@link #getProcedureMetrics(Object)} returns</span> |
| <span class="source-line-no">413</span><span id="line-413"> * non-null {@link ProcedureMetrics}, the default implementation adds runtime of a procedure to a</span> |
| <span class="source-line-no">414</span><span id="line-414"> * time histogram for successfully completed procedures. Increments failed counter for failed</span> |
| <span class="source-line-no">415</span><span id="line-415"> * procedures.</span> |
| <span class="source-line-no">416</span><span id="line-416"> * <p/></span> |
| <span class="source-line-no">417</span><span id="line-417"> * TODO: As any of the sub-procedures on failure rolls back all procedures in the stack, including</span> |
| <span class="source-line-no">418</span><span id="line-418"> * successfully finished siblings, this function may get called twice in certain cases for certain</span> |
| <span class="source-line-no">419</span><span id="line-419"> * procedures. Explore further if this can be called once.</span> |
| <span class="source-line-no">420</span><span id="line-420"> * @param env The environment passed to the procedure executor</span> |
| <span class="source-line-no">421</span><span id="line-421"> * @param runtime Runtime of the procedure in milliseconds</span> |
| <span class="source-line-no">422</span><span id="line-422"> * @param success true if procedure is completed successfully</span> |
| <span class="source-line-no">423</span><span id="line-423"> */</span> |
| <span class="source-line-no">424</span><span id="line-424"> protected void updateMetricsOnFinish(TEnvironment env, long runtime, boolean success) {</span> |
| <span class="source-line-no">425</span><span id="line-425"> ProcedureMetrics metrics = getProcedureMetrics(env);</span> |
| <span class="source-line-no">426</span><span id="line-426"> if (metrics == null) {</span> |
| <span class="source-line-no">427</span><span id="line-427"> return;</span> |
| <span class="source-line-no">428</span><span id="line-428"> }</span> |
| <span class="source-line-no">429</span><span id="line-429"></span> |
| <span class="source-line-no">430</span><span id="line-430"> if (success) {</span> |
| <span class="source-line-no">431</span><span id="line-431"> Histogram timeHisto = metrics.getTimeHisto();</span> |
| <span class="source-line-no">432</span><span id="line-432"> if (timeHisto != null) {</span> |
| <span class="source-line-no">433</span><span id="line-433"> timeHisto.update(runtime);</span> |
| <span class="source-line-no">434</span><span id="line-434"> }</span> |
| <span class="source-line-no">435</span><span id="line-435"> } else {</span> |
| <span class="source-line-no">436</span><span id="line-436"> Counter failedCounter = metrics.getFailedCounter();</span> |
| <span class="source-line-no">437</span><span id="line-437"> if (failedCounter != null) {</span> |
| <span class="source-line-no">438</span><span id="line-438"> failedCounter.increment();</span> |
| <span class="source-line-no">439</span><span id="line-439"> }</span> |
| <span class="source-line-no">440</span><span id="line-440"> }</span> |
| <span class="source-line-no">441</span><span id="line-441"> }</span> |
| <span class="source-line-no">442</span><span id="line-442"></span> |
| <span class="source-line-no">443</span><span id="line-443"> @Override</span> |
| <span class="source-line-no">444</span><span id="line-444"> public String toString() {</span> |
| <span class="source-line-no">445</span><span id="line-445"> // Return the simple String presentation of the procedure.</span> |
| <span class="source-line-no">446</span><span id="line-446"> return toStringSimpleSB().toString();</span> |
| <span class="source-line-no">447</span><span id="line-447"> }</span> |
| <span class="source-line-no">448</span><span id="line-448"></span> |
| <span class="source-line-no">449</span><span id="line-449"> /**</span> |
| <span class="source-line-no">450</span><span id="line-450"> * Build the StringBuilder for the simple form of procedure string.</span> |
| <span class="source-line-no">451</span><span id="line-451"> * @return the StringBuilder</span> |
| <span class="source-line-no">452</span><span id="line-452"> */</span> |
| <span class="source-line-no">453</span><span id="line-453"> protected StringBuilder toStringSimpleSB() {</span> |
| <span class="source-line-no">454</span><span id="line-454"> final StringBuilder sb = new StringBuilder();</span> |
| <span class="source-line-no">455</span><span id="line-455"></span> |
| <span class="source-line-no">456</span><span id="line-456"> sb.append("pid=");</span> |
| <span class="source-line-no">457</span><span id="line-457"> sb.append(getProcId());</span> |
| <span class="source-line-no">458</span><span id="line-458"></span> |
| <span class="source-line-no">459</span><span id="line-459"> if (hasParent()) {</span> |
| <span class="source-line-no">460</span><span id="line-460"> sb.append(", ppid=");</span> |
| <span class="source-line-no">461</span><span id="line-461"> sb.append(getParentProcId());</span> |
| <span class="source-line-no">462</span><span id="line-462"> }</span> |
| <span class="source-line-no">463</span><span id="line-463"></span> |
| <span class="source-line-no">464</span><span id="line-464"> /*</span> |
| <span class="source-line-no">465</span><span id="line-465"> * TODO Enable later when this is being used. Currently owner not used. if (hasOwner()) {</span> |
| <span class="source-line-no">466</span><span id="line-466"> * sb.append(", owner="); sb.append(getOwner()); }</span> |
| <span class="source-line-no">467</span><span id="line-467"> */</span> |
| <span class="source-line-no">468</span><span id="line-468"></span> |
| <span class="source-line-no">469</span><span id="line-469"> sb.append(", state="); // pState for Procedure State as opposed to any other kind.</span> |
| <span class="source-line-no">470</span><span id="line-470"> toStringState(sb);</span> |
| <span class="source-line-no">471</span><span id="line-471"></span> |
| <span class="source-line-no">472</span><span id="line-472"> sb.append(", hasLock=").append(locked);</span> |
| <span class="source-line-no">473</span><span id="line-473"></span> |
| <span class="source-line-no">474</span><span id="line-474"> if (bypass) {</span> |
| <span class="source-line-no">475</span><span id="line-475"> sb.append(", bypass=").append(bypass);</span> |
| <span class="source-line-no">476</span><span id="line-476"> }</span> |
| <span class="source-line-no">477</span><span id="line-477"></span> |
| <span class="source-line-no">478</span><span id="line-478"> if (hasException()) {</span> |
| <span class="source-line-no">479</span><span id="line-479"> sb.append(", exception=" + getException());</span> |
| <span class="source-line-no">480</span><span id="line-480"> }</span> |
| <span class="source-line-no">481</span><span id="line-481"></span> |
| <span class="source-line-no">482</span><span id="line-482"> sb.append("; ");</span> |
| <span class="source-line-no">483</span><span id="line-483"> toStringClassDetails(sb);</span> |
| <span class="source-line-no">484</span><span id="line-484"></span> |
| <span class="source-line-no">485</span><span id="line-485"> return sb;</span> |
| <span class="source-line-no">486</span><span id="line-486"> }</span> |
| <span class="source-line-no">487</span><span id="line-487"></span> |
| <span class="source-line-no">488</span><span id="line-488"> /**</span> |
| <span class="source-line-no">489</span><span id="line-489"> * Extend the toString() information with more procedure details</span> |
| <span class="source-line-no">490</span><span id="line-490"> */</span> |
| <span class="source-line-no">491</span><span id="line-491"> public String toStringDetails() {</span> |
| <span class="source-line-no">492</span><span id="line-492"> final StringBuilder sb = toStringSimpleSB();</span> |
| <span class="source-line-no">493</span><span id="line-493"></span> |
| <span class="source-line-no">494</span><span id="line-494"> sb.append(" submittedTime=");</span> |
| <span class="source-line-no">495</span><span id="line-495"> sb.append(getSubmittedTime());</span> |
| <span class="source-line-no">496</span><span id="line-496"></span> |
| <span class="source-line-no">497</span><span id="line-497"> sb.append(", lastUpdate=");</span> |
| <span class="source-line-no">498</span><span id="line-498"> sb.append(getLastUpdate());</span> |
| <span class="source-line-no">499</span><span id="line-499"></span> |
| <span class="source-line-no">500</span><span id="line-500"> final int[] stackIndices = getStackIndexes();</span> |
| <span class="source-line-no">501</span><span id="line-501"> if (stackIndices != null) {</span> |
| <span class="source-line-no">502</span><span id="line-502"> sb.append("\n");</span> |
| <span class="source-line-no">503</span><span id="line-503"> sb.append("stackIndexes=");</span> |
| <span class="source-line-no">504</span><span id="line-504"> sb.append(Arrays.toString(stackIndices));</span> |
| <span class="source-line-no">505</span><span id="line-505"> }</span> |
| <span class="source-line-no">506</span><span id="line-506"></span> |
| <span class="source-line-no">507</span><span id="line-507"> return sb.toString();</span> |
| <span class="source-line-no">508</span><span id="line-508"> }</span> |
| <span class="source-line-no">509</span><span id="line-509"></span> |
| <span class="source-line-no">510</span><span id="line-510"> protected String toStringClass() {</span> |
| <span class="source-line-no">511</span><span id="line-511"> StringBuilder sb = new StringBuilder();</span> |
| <span class="source-line-no">512</span><span id="line-512"> toStringClassDetails(sb);</span> |
| <span class="source-line-no">513</span><span id="line-513"> return sb.toString();</span> |
| <span class="source-line-no">514</span><span id="line-514"> }</span> |
| <span class="source-line-no">515</span><span id="line-515"></span> |
| <span class="source-line-no">516</span><span id="line-516"> /**</span> |
| <span class="source-line-no">517</span><span id="line-517"> * Called from {@link #toString()} when interpolating {@link Procedure} State. Allows decorating</span> |
| <span class="source-line-no">518</span><span id="line-518"> * generic Procedure State with Procedure particulars.</span> |
| <span class="source-line-no">519</span><span id="line-519"> * @param builder Append current {@link ProcedureState}</span> |
| <span class="source-line-no">520</span><span id="line-520"> */</span> |
| <span class="source-line-no">521</span><span id="line-521"> protected void toStringState(StringBuilder builder) {</span> |
| <span class="source-line-no">522</span><span id="line-522"> builder.append(getState());</span> |
| <span class="source-line-no">523</span><span id="line-523"> }</span> |
| <span class="source-line-no">524</span><span id="line-524"></span> |
| <span class="source-line-no">525</span><span id="line-525"> /**</span> |
| <span class="source-line-no">526</span><span id="line-526"> * Extend the toString() information with the procedure details e.g. className and parameters</span> |
| <span class="source-line-no">527</span><span id="line-527"> * @param builder the string builder to use to append the proc specific information</span> |
| <span class="source-line-no">528</span><span id="line-528"> */</span> |
| <span class="source-line-no">529</span><span id="line-529"> protected void toStringClassDetails(StringBuilder builder) {</span> |
| <span class="source-line-no">530</span><span id="line-530"> builder.append(getClass().getName());</span> |
| <span class="source-line-no">531</span><span id="line-531"> }</span> |
| <span class="source-line-no">532</span><span id="line-532"></span> |
| <span class="source-line-no">533</span><span id="line-533"> // ==========================================================================</span> |
| <span class="source-line-no">534</span><span id="line-534"> // Those fields are unchanged after initialization.</span> |
| <span class="source-line-no">535</span><span id="line-535"> //</span> |
| <span class="source-line-no">536</span><span id="line-536"> // Each procedure will get created from the user or during</span> |
| <span class="source-line-no">537</span><span id="line-537"> // ProcedureExecutor.start() during the load() phase and then submitted</span> |
| <span class="source-line-no">538</span><span id="line-538"> // to the executor. these fields will never be changed after initialization</span> |
| <span class="source-line-no">539</span><span id="line-539"> // ==========================================================================</span> |
| <span class="source-line-no">540</span><span id="line-540"> public long getProcId() {</span> |
| <span class="source-line-no">541</span><span id="line-541"> return procId;</span> |
| <span class="source-line-no">542</span><span id="line-542"> }</span> |
| <span class="source-line-no">543</span><span id="line-543"></span> |
| <span class="source-line-no">544</span><span id="line-544"> public boolean hasParent() {</span> |
| <span class="source-line-no">545</span><span id="line-545"> return parentProcId != NO_PROC_ID;</span> |
| <span class="source-line-no">546</span><span id="line-546"> }</span> |
| <span class="source-line-no">547</span><span id="line-547"></span> |
| <span class="source-line-no">548</span><span id="line-548"> public long getParentProcId() {</span> |
| <span class="source-line-no">549</span><span id="line-549"> return parentProcId;</span> |
| <span class="source-line-no">550</span><span id="line-550"> }</span> |
| <span class="source-line-no">551</span><span id="line-551"></span> |
| <span class="source-line-no">552</span><span id="line-552"> public long getRootProcId() {</span> |
| <span class="source-line-no">553</span><span id="line-553"> return rootProcId;</span> |
| <span class="source-line-no">554</span><span id="line-554"> }</span> |
| <span class="source-line-no">555</span><span id="line-555"></span> |
| <span class="source-line-no">556</span><span id="line-556"> public String getProcName() {</span> |
| <span class="source-line-no">557</span><span id="line-557"> return toStringClass();</span> |
| <span class="source-line-no">558</span><span id="line-558"> }</span> |
| <span class="source-line-no">559</span><span id="line-559"></span> |
| <span class="source-line-no">560</span><span id="line-560"> public NonceKey getNonceKey() {</span> |
| <span class="source-line-no">561</span><span id="line-561"> return nonceKey;</span> |
| <span class="source-line-no">562</span><span id="line-562"> }</span> |
| <span class="source-line-no">563</span><span id="line-563"></span> |
| <span class="source-line-no">564</span><span id="line-564"> public long getSubmittedTime() {</span> |
| <span class="source-line-no">565</span><span id="line-565"> return submittedTime;</span> |
| <span class="source-line-no">566</span><span id="line-566"> }</span> |
| <span class="source-line-no">567</span><span id="line-567"></span> |
| <span class="source-line-no">568</span><span id="line-568"> public String getOwner() {</span> |
| <span class="source-line-no">569</span><span id="line-569"> return owner;</span> |
| <span class="source-line-no">570</span><span id="line-570"> }</span> |
| <span class="source-line-no">571</span><span id="line-571"></span> |
| <span class="source-line-no">572</span><span id="line-572"> public boolean hasOwner() {</span> |
| <span class="source-line-no">573</span><span id="line-573"> return owner != null;</span> |
| <span class="source-line-no">574</span><span id="line-574"> }</span> |
| <span class="source-line-no">575</span><span id="line-575"></span> |
| <span class="source-line-no">576</span><span id="line-576"> /**</span> |
| <span class="source-line-no">577</span><span id="line-577"> * Called by the ProcedureExecutor to assign the ID to the newly created procedure.</span> |
| <span class="source-line-no">578</span><span id="line-578"> */</span> |
| <span class="source-line-no">579</span><span id="line-579"> protected void setProcId(long procId) {</span> |
| <span class="source-line-no">580</span><span id="line-580"> this.procId = procId;</span> |
| <span class="source-line-no">581</span><span id="line-581"> this.submittedTime = EnvironmentEdgeManager.currentTime();</span> |
| <span class="source-line-no">582</span><span id="line-582"> setState(ProcedureState.RUNNABLE);</span> |
| <span class="source-line-no">583</span><span id="line-583"> }</span> |
| <span class="source-line-no">584</span><span id="line-584"></span> |
| <span class="source-line-no">585</span><span id="line-585"> /**</span> |
| <span class="source-line-no">586</span><span id="line-586"> * Called by the ProcedureExecutor to assign the parent to the newly created procedure.</span> |
| <span class="source-line-no">587</span><span id="line-587"> */</span> |
| <span class="source-line-no">588</span><span id="line-588"> protected void setParentProcId(long parentProcId) {</span> |
| <span class="source-line-no">589</span><span id="line-589"> this.parentProcId = parentProcId;</span> |
| <span class="source-line-no">590</span><span id="line-590"> }</span> |
| <span class="source-line-no">591</span><span id="line-591"></span> |
| <span class="source-line-no">592</span><span id="line-592"> protected void setRootProcId(long rootProcId) {</span> |
| <span class="source-line-no">593</span><span id="line-593"> this.rootProcId = rootProcId;</span> |
| <span class="source-line-no">594</span><span id="line-594"> }</span> |
| <span class="source-line-no">595</span><span id="line-595"></span> |
| <span class="source-line-no">596</span><span id="line-596"> /**</span> |
| <span class="source-line-no">597</span><span id="line-597"> * Called by the ProcedureExecutor to set the value to the newly created procedure.</span> |
| <span class="source-line-no">598</span><span id="line-598"> */</span> |
| <span class="source-line-no">599</span><span id="line-599"> protected void setNonceKey(NonceKey nonceKey) {</span> |
| <span class="source-line-no">600</span><span id="line-600"> this.nonceKey = nonceKey;</span> |
| <span class="source-line-no">601</span><span id="line-601"> }</span> |
| <span class="source-line-no">602</span><span id="line-602"></span> |
| <span class="source-line-no">603</span><span id="line-603"> public void setOwner(String owner) {</span> |
| <span class="source-line-no">604</span><span id="line-604"> this.owner = StringUtils.isEmpty(owner) ? null : owner;</span> |
| <span class="source-line-no">605</span><span id="line-605"> }</span> |
| <span class="source-line-no">606</span><span id="line-606"></span> |
| <span class="source-line-no">607</span><span id="line-607"> public void setOwner(User owner) {</span> |
| <span class="source-line-no">608</span><span id="line-608"> assert owner != null : "expected owner to be not null";</span> |
| <span class="source-line-no">609</span><span id="line-609"> setOwner(owner.getShortName());</span> |
| <span class="source-line-no">610</span><span id="line-610"> }</span> |
| <span class="source-line-no">611</span><span id="line-611"></span> |
| <span class="source-line-no">612</span><span id="line-612"> /**</span> |
| <span class="source-line-no">613</span><span id="line-613"> * Called on store load to initialize the Procedure internals after the creation/deserialization.</span> |
| <span class="source-line-no">614</span><span id="line-614"> */</span> |
| <span class="source-line-no">615</span><span id="line-615"> protected void setSubmittedTime(long submittedTime) {</span> |
| <span class="source-line-no">616</span><span id="line-616"> this.submittedTime = submittedTime;</span> |
| <span class="source-line-no">617</span><span id="line-617"> }</span> |
| <span class="source-line-no">618</span><span id="line-618"></span> |
| <span class="source-line-no">619</span><span id="line-619"> // ==========================================================================</span> |
| <span class="source-line-no">620</span><span id="line-620"> // runtime state - timeout related</span> |
| <span class="source-line-no">621</span><span id="line-621"> // ==========================================================================</span> |
| <span class="source-line-no">622</span><span id="line-622"> /**</span> |
| <span class="source-line-no">623</span><span id="line-623"> * @param timeout timeout interval in msec</span> |
| <span class="source-line-no">624</span><span id="line-624"> */</span> |
| <span class="source-line-no">625</span><span id="line-625"> protected void setTimeout(int timeout) {</span> |
| <span class="source-line-no">626</span><span id="line-626"> this.timeout = timeout;</span> |
| <span class="source-line-no">627</span><span id="line-627"> }</span> |
| <span class="source-line-no">628</span><span id="line-628"></span> |
| <span class="source-line-no">629</span><span id="line-629"> public boolean hasTimeout() {</span> |
| <span class="source-line-no">630</span><span id="line-630"> return timeout != NO_TIMEOUT;</span> |
| <span class="source-line-no">631</span><span id="line-631"> }</span> |
| <span class="source-line-no">632</span><span id="line-632"></span> |
| <span class="source-line-no">633</span><span id="line-633"> /** Returns the timeout in msec */</span> |
| <span class="source-line-no">634</span><span id="line-634"> public int getTimeout() {</span> |
| <span class="source-line-no">635</span><span id="line-635"> return timeout;</span> |
| <span class="source-line-no">636</span><span id="line-636"> }</span> |
| <span class="source-line-no">637</span><span id="line-637"></span> |
| <span class="source-line-no">638</span><span id="line-638"> /**</span> |
| <span class="source-line-no">639</span><span id="line-639"> * Called on store load to initialize the Procedure internals after the creation/deserialization.</span> |
| <span class="source-line-no">640</span><span id="line-640"> */</span> |
| <span class="source-line-no">641</span><span id="line-641"> protected void setLastUpdate(long lastUpdate) {</span> |
| <span class="source-line-no">642</span><span id="line-642"> this.lastUpdate = lastUpdate;</span> |
| <span class="source-line-no">643</span><span id="line-643"> }</span> |
| <span class="source-line-no">644</span><span id="line-644"></span> |
| <span class="source-line-no">645</span><span id="line-645"> /**</span> |
| <span class="source-line-no">646</span><span id="line-646"> * Called by ProcedureExecutor after each time a procedure step is executed.</span> |
| <span class="source-line-no">647</span><span id="line-647"> */</span> |
| <span class="source-line-no">648</span><span id="line-648"> protected void updateTimestamp() {</span> |
| <span class="source-line-no">649</span><span id="line-649"> this.lastUpdate = EnvironmentEdgeManager.currentTime();</span> |
| <span class="source-line-no">650</span><span id="line-650"> }</span> |
| <span class="source-line-no">651</span><span id="line-651"></span> |
| <span class="source-line-no">652</span><span id="line-652"> public long getLastUpdate() {</span> |
| <span class="source-line-no">653</span><span id="line-653"> return lastUpdate;</span> |
| <span class="source-line-no">654</span><span id="line-654"> }</span> |
| <span class="source-line-no">655</span><span id="line-655"></span> |
| <span class="source-line-no">656</span><span id="line-656"> /**</span> |
| <span class="source-line-no">657</span><span id="line-657"> * Timeout of the next timeout. Called by the ProcedureExecutor if the procedure has timeout set</span> |
| <span class="source-line-no">658</span><span id="line-658"> * and the procedure is in the waiting queue.</span> |
| <span class="source-line-no">659</span><span id="line-659"> * @return the timestamp of the next timeout.</span> |
| <span class="source-line-no">660</span><span id="line-660"> */</span> |
| <span class="source-line-no">661</span><span id="line-661"> protected long getTimeoutTimestamp() {</span> |
| <span class="source-line-no">662</span><span id="line-662"> return getLastUpdate() + getTimeout();</span> |
| <span class="source-line-no">663</span><span id="line-663"> }</span> |
| <span class="source-line-no">664</span><span id="line-664"></span> |
| <span class="source-line-no">665</span><span id="line-665"> // ==========================================================================</span> |
| <span class="source-line-no">666</span><span id="line-666"> // runtime state</span> |
| <span class="source-line-no">667</span><span id="line-667"> // ==========================================================================</span> |
| <span class="source-line-no">668</span><span id="line-668"> /** Returns the time elapsed between the last update and the start time of the procedure. */</span> |
| <span class="source-line-no">669</span><span id="line-669"> public long elapsedTime() {</span> |
| <span class="source-line-no">670</span><span id="line-670"> return getLastUpdate() - getSubmittedTime();</span> |
| <span class="source-line-no">671</span><span id="line-671"> }</span> |
| <span class="source-line-no">672</span><span id="line-672"></span> |
| <span class="source-line-no">673</span><span id="line-673"> /** Returns the serialized result if any, otherwise null */</span> |
| <span class="source-line-no">674</span><span id="line-674"> public byte[] getResult() {</span> |
| <span class="source-line-no">675</span><span id="line-675"> return result;</span> |
| <span class="source-line-no">676</span><span id="line-676"> }</span> |
| <span class="source-line-no">677</span><span id="line-677"></span> |
| <span class="source-line-no">678</span><span id="line-678"> /**</span> |
| <span class="source-line-no">679</span><span id="line-679"> * The procedure may leave a "result" on completion.</span> |
| <span class="source-line-no">680</span><span id="line-680"> * @param result the serialized result that will be passed to the client</span> |
| <span class="source-line-no">681</span><span id="line-681"> */</span> |
| <span class="source-line-no">682</span><span id="line-682"> protected void setResult(byte[] result) {</span> |
| <span class="source-line-no">683</span><span id="line-683"> this.result = result;</span> |
| <span class="source-line-no">684</span><span id="line-684"> }</span> |
| <span class="source-line-no">685</span><span id="line-685"></span> |
| <span class="source-line-no">686</span><span id="line-686"> /**</span> |
| <span class="source-line-no">687</span><span id="line-687"> * Will only be called when loading procedures from procedure store, where we need to record</span> |
| <span class="source-line-no">688</span><span id="line-688"> * whether the procedure has already held a lock. Later we will call {@link #restoreLock(Object)}</span> |
| <span class="source-line-no">689</span><span id="line-689"> * to actually acquire the lock.</span> |
| <span class="source-line-no">690</span><span id="line-690"> */</span> |
| <span class="source-line-no">691</span><span id="line-691"> final void lockedWhenLoading() {</span> |
| <span class="source-line-no">692</span><span id="line-692"> this.lockedWhenLoading = true;</span> |
| <span class="source-line-no">693</span><span id="line-693"> }</span> |
| <span class="source-line-no">694</span><span id="line-694"></span> |
| <span class="source-line-no">695</span><span id="line-695"> /**</span> |
| <span class="source-line-no">696</span><span id="line-696"> * Can only be called when restarting, before the procedure actually being executed, as after we</span> |
| <span class="source-line-no">697</span><span id="line-697"> * actually call the {@link #doAcquireLock(Object, ProcedureStore)} method, we will reset</span> |
| <span class="source-line-no">698</span><span id="line-698"> * {@link #lockedWhenLoading} to false.</span> |
| <span class="source-line-no">699</span><span id="line-699"> * <p/></span> |
| <span class="source-line-no">700</span><span id="line-700"> * Now it is only used in the ProcedureScheduler to determine whether we should put a Procedure in</span> |
| <span class="source-line-no">701</span><span id="line-701"> * front of a queue.</span> |
| <span class="source-line-no">702</span><span id="line-702"> */</span> |
| <span class="source-line-no">703</span><span id="line-703"> public boolean isLockedWhenLoading() {</span> |
| <span class="source-line-no">704</span><span id="line-704"> return lockedWhenLoading;</span> |
| <span class="source-line-no">705</span><span id="line-705"> }</span> |
| <span class="source-line-no">706</span><span id="line-706"></span> |
| <span class="source-line-no">707</span><span id="line-707"> // ==============================================================================================</span> |
| <span class="source-line-no">708</span><span id="line-708"> // Runtime state, updated every operation by the ProcedureExecutor</span> |
| <span class="source-line-no">709</span><span id="line-709"> //</span> |
| <span class="source-line-no">710</span><span id="line-710"> // There is always 1 thread at the time operating on the state of the procedure.</span> |
| <span class="source-line-no">711</span><span id="line-711"> // The ProcedureExecutor may check and set states, or some Procecedure may</span> |
| <span class="source-line-no">712</span><span id="line-712"> // update its own state. but no concurrent updates. we use synchronized here</span> |
| <span class="source-line-no">713</span><span id="line-713"> // just because the procedure can get scheduled on different executor threads on each step.</span> |
| <span class="source-line-no">714</span><span id="line-714"> // ==============================================================================================</span> |
| <span class="source-line-no">715</span><span id="line-715"></span> |
| <span class="source-line-no">716</span><span id="line-716"> /** Returns true if the procedure is in a RUNNABLE state. */</span> |
| <span class="source-line-no">717</span><span id="line-717"> public synchronized boolean isRunnable() {</span> |
| <span class="source-line-no">718</span><span id="line-718"> return state == ProcedureState.RUNNABLE;</span> |
| <span class="source-line-no">719</span><span id="line-719"> }</span> |
| <span class="source-line-no">720</span><span id="line-720"></span> |
| <span class="source-line-no">721</span><span id="line-721"> public synchronized boolean isInitializing() {</span> |
| <span class="source-line-no">722</span><span id="line-722"> return state == ProcedureState.INITIALIZING;</span> |
| <span class="source-line-no">723</span><span id="line-723"> }</span> |
| <span class="source-line-no">724</span><span id="line-724"></span> |
| <span class="source-line-no">725</span><span id="line-725"> /** Returns true if the procedure has failed. It may or may not have rolled back. */</span> |
| <span class="source-line-no">726</span><span id="line-726"> public synchronized boolean isFailed() {</span> |
| <span class="source-line-no">727</span><span id="line-727"> return state == ProcedureState.FAILED || state == ProcedureState.ROLLEDBACK;</span> |
| <span class="source-line-no">728</span><span id="line-728"> }</span> |
| <span class="source-line-no">729</span><span id="line-729"></span> |
| <span class="source-line-no">730</span><span id="line-730"> /** Returns true if the procedure is finished successfully. */</span> |
| <span class="source-line-no">731</span><span id="line-731"> public synchronized boolean isSuccess() {</span> |
| <span class="source-line-no">732</span><span id="line-732"> return state == ProcedureState.SUCCESS && !hasException();</span> |
| <span class="source-line-no">733</span><span id="line-733"> }</span> |
| <span class="source-line-no">734</span><span id="line-734"></span> |
| <span class="source-line-no">735</span><span id="line-735"> /**</span> |
| <span class="source-line-no">736</span><span id="line-736"> * @return true if the procedure is finished. The Procedure may be completed successfully or</span> |
| <span class="source-line-no">737</span><span id="line-737"> * rolledback.</span> |
| <span class="source-line-no">738</span><span id="line-738"> */</span> |
| <span class="source-line-no">739</span><span id="line-739"> public synchronized boolean isFinished() {</span> |
| <span class="source-line-no">740</span><span id="line-740"> return isSuccess() || state == ProcedureState.ROLLEDBACK;</span> |
| <span class="source-line-no">741</span><span id="line-741"> }</span> |
| <span class="source-line-no">742</span><span id="line-742"></span> |
| <span class="source-line-no">743</span><span id="line-743"> /** Returns true if the procedure is waiting for a child to finish or for an external event. */</span> |
| <span class="source-line-no">744</span><span id="line-744"> public synchronized boolean isWaiting() {</span> |
| <span class="source-line-no">745</span><span id="line-745"> switch (state) {</span> |
| <span class="source-line-no">746</span><span id="line-746"> case WAITING:</span> |
| <span class="source-line-no">747</span><span id="line-747"> case WAITING_TIMEOUT:</span> |
| <span class="source-line-no">748</span><span id="line-748"> return true;</span> |
| <span class="source-line-no">749</span><span id="line-749"> default:</span> |
| <span class="source-line-no">750</span><span id="line-750"> break;</span> |
| <span class="source-line-no">751</span><span id="line-751"> }</span> |
| <span class="source-line-no">752</span><span id="line-752"> return false;</span> |
| <span class="source-line-no">753</span><span id="line-753"> }</span> |
| <span class="source-line-no">754</span><span id="line-754"></span> |
| <span class="source-line-no">755</span><span id="line-755"> protected synchronized void setState(final ProcedureState state) {</span> |
| <span class="source-line-no">756</span><span id="line-756"> this.state = state;</span> |
| <span class="source-line-no">757</span><span id="line-757"> updateTimestamp();</span> |
| <span class="source-line-no">758</span><span id="line-758"> }</span> |
| <span class="source-line-no">759</span><span id="line-759"></span> |
| <span class="source-line-no">760</span><span id="line-760"> public synchronized ProcedureState getState() {</span> |
| <span class="source-line-no">761</span><span id="line-761"> return state;</span> |
| <span class="source-line-no">762</span><span id="line-762"> }</span> |
| <span class="source-line-no">763</span><span id="line-763"></span> |
| <span class="source-line-no">764</span><span id="line-764"> protected void setFailure(final String source, final Throwable cause) {</span> |
| <span class="source-line-no">765</span><span id="line-765"> setFailure(new RemoteProcedureException(source, cause));</span> |
| <span class="source-line-no">766</span><span id="line-766"> }</span> |
| <span class="source-line-no">767</span><span id="line-767"></span> |
| <span class="source-line-no">768</span><span id="line-768"> protected synchronized void setFailure(final RemoteProcedureException exception) {</span> |
| <span class="source-line-no">769</span><span id="line-769"> this.exception = exception;</span> |
| <span class="source-line-no">770</span><span id="line-770"> if (!isFinished()) {</span> |
| <span class="source-line-no">771</span><span id="line-771"> setState(ProcedureState.FAILED);</span> |
| <span class="source-line-no">772</span><span id="line-772"> }</span> |
| <span class="source-line-no">773</span><span id="line-773"> }</span> |
| <span class="source-line-no">774</span><span id="line-774"></span> |
| <span class="source-line-no">775</span><span id="line-775"> protected void setAbortFailure(final String source, final String msg) {</span> |
| <span class="source-line-no">776</span><span id="line-776"> setFailure(source, new ProcedureAbortedException(msg));</span> |
| <span class="source-line-no">777</span><span id="line-777"> }</span> |
| <span class="source-line-no">778</span><span id="line-778"></span> |
| <span class="source-line-no">779</span><span id="line-779"> /**</span> |
| <span class="source-line-no">780</span><span id="line-780"> * Called by the ProcedureExecutor when the timeout set by setTimeout() is expired.</span> |
| <span class="source-line-no">781</span><span id="line-781"> * <p/></span> |
| <span class="source-line-no">782</span><span id="line-782"> * Another usage for this method is to implement retrying. A procedure can set the state to</span> |
| <span class="source-line-no">783</span><span id="line-783"> * {@code WAITING_TIMEOUT} by calling {@code setState} method, and throw a</span> |
| <span class="source-line-no">784</span><span id="line-784"> * {@link ProcedureSuspendedException} to halt the execution of the procedure, and do not forget a</span> |
| <span class="source-line-no">785</span><span id="line-785"> * call {@link #setTimeout(int)} method to set the timeout. And you should also override this</span> |
| <span class="source-line-no">786</span><span id="line-786"> * method to wake up the procedure, and also return false to tell the ProcedureExecutor that the</span> |
| <span class="source-line-no">787</span><span id="line-787"> * timeout event has been handled.</span> |
| <span class="source-line-no">788</span><span id="line-788"> * @return true to let the framework handle the timeout as abort, false in case the procedure</span> |
| <span class="source-line-no">789</span><span id="line-789"> * handled the timeout itself.</span> |
| <span class="source-line-no">790</span><span id="line-790"> */</span> |
| <span class="source-line-no">791</span><span id="line-791"> protected synchronized boolean setTimeoutFailure(TEnvironment env) {</span> |
| <span class="source-line-no">792</span><span id="line-792"> if (state == ProcedureState.WAITING_TIMEOUT) {</span> |
| <span class="source-line-no">793</span><span id="line-793"> long timeDiff = EnvironmentEdgeManager.currentTime() - lastUpdate;</span> |
| <span class="source-line-no">794</span><span id="line-794"> setFailure("ProcedureExecutor",</span> |
| <span class="source-line-no">795</span><span id="line-795"> new TimeoutIOException("Operation timed out after " + StringUtils.humanTimeDiff(timeDiff)));</span> |
| <span class="source-line-no">796</span><span id="line-796"> return true;</span> |
| <span class="source-line-no">797</span><span id="line-797"> }</span> |
| <span class="source-line-no">798</span><span id="line-798"> return false;</span> |
| <span class="source-line-no">799</span><span id="line-799"> }</span> |
| <span class="source-line-no">800</span><span id="line-800"></span> |
| <span class="source-line-no">801</span><span id="line-801"> public synchronized boolean hasException() {</span> |
| <span class="source-line-no">802</span><span id="line-802"> return exception != null;</span> |
| <span class="source-line-no">803</span><span id="line-803"> }</span> |
| <span class="source-line-no">804</span><span id="line-804"></span> |
| <span class="source-line-no">805</span><span id="line-805"> public synchronized RemoteProcedureException getException() {</span> |
| <span class="source-line-no">806</span><span id="line-806"> return exception;</span> |
| <span class="source-line-no">807</span><span id="line-807"> }</span> |
| <span class="source-line-no">808</span><span id="line-808"></span> |
| <span class="source-line-no">809</span><span id="line-809"> /**</span> |
| <span class="source-line-no">810</span><span id="line-810"> * Called by the ProcedureExecutor on procedure-load to restore the latch state</span> |
| <span class="source-line-no">811</span><span id="line-811"> */</span> |
| <span class="source-line-no">812</span><span id="line-812"> protected synchronized void setChildrenLatch(int numChildren) {</span> |
| <span class="source-line-no">813</span><span id="line-813"> this.childrenLatch = numChildren;</span> |
| <span class="source-line-no">814</span><span id="line-814"> if (LOG.isTraceEnabled()) {</span> |
| <span class="source-line-no">815</span><span id="line-815"> LOG.trace("CHILD LATCH INCREMENT SET " + this.childrenLatch, new Throwable(this.toString()));</span> |
| <span class="source-line-no">816</span><span id="line-816"> }</span> |
| <span class="source-line-no">817</span><span id="line-817"> }</span> |
| <span class="source-line-no">818</span><span id="line-818"></span> |
| <span class="source-line-no">819</span><span id="line-819"> /**</span> |
| <span class="source-line-no">820</span><span id="line-820"> * Called by the ProcedureExecutor on procedure-load to restore the latch state</span> |
| <span class="source-line-no">821</span><span id="line-821"> */</span> |
| <span class="source-line-no">822</span><span id="line-822"> protected synchronized void incChildrenLatch() {</span> |
| <span class="source-line-no">823</span><span id="line-823"> // TODO: can this be inferred from the stack? I think so...</span> |
| <span class="source-line-no">824</span><span id="line-824"> this.childrenLatch++;</span> |
| <span class="source-line-no">825</span><span id="line-825"> if (LOG.isTraceEnabled()) {</span> |
| <span class="source-line-no">826</span><span id="line-826"> LOG.trace("CHILD LATCH INCREMENT " + this.childrenLatch, new Throwable(this.toString()));</span> |
| <span class="source-line-no">827</span><span id="line-827"> }</span> |
| <span class="source-line-no">828</span><span id="line-828"> }</span> |
| <span class="source-line-no">829</span><span id="line-829"></span> |
| <span class="source-line-no">830</span><span id="line-830"> /**</span> |
| <span class="source-line-no">831</span><span id="line-831"> * Called by the ProcedureExecutor to notify that one of the sub-procedures has completed.</span> |
| <span class="source-line-no">832</span><span id="line-832"> */</span> |
| <span class="source-line-no">833</span><span id="line-833"> private synchronized boolean childrenCountDown() {</span> |
| <span class="source-line-no">834</span><span id="line-834"> assert childrenLatch > 0 : this;</span> |
| <span class="source-line-no">835</span><span id="line-835"> boolean b = --childrenLatch == 0;</span> |
| <span class="source-line-no">836</span><span id="line-836"> if (LOG.isTraceEnabled()) {</span> |
| <span class="source-line-no">837</span><span id="line-837"> LOG.trace("CHILD LATCH DECREMENT " + childrenLatch, new Throwable(this.toString()));</span> |
| <span class="source-line-no">838</span><span id="line-838"> }</span> |
| <span class="source-line-no">839</span><span id="line-839"> return b;</span> |
| <span class="source-line-no">840</span><span id="line-840"> }</span> |
| <span class="source-line-no">841</span><span id="line-841"></span> |
| <span class="source-line-no">842</span><span id="line-842"> /**</span> |
| <span class="source-line-no">843</span><span id="line-843"> * Try to set this procedure into RUNNABLE state. Succeeds if all subprocedures/children are done.</span> |
| <span class="source-line-no">844</span><span id="line-844"> * @return True if we were able to move procedure to RUNNABLE state.</span> |
| <span class="source-line-no">845</span><span id="line-845"> */</span> |
| <span class="source-line-no">846</span><span id="line-846"> synchronized boolean tryRunnable() {</span> |
| <span class="source-line-no">847</span><span id="line-847"> // Don't use isWaiting in the below; it returns true for WAITING and WAITING_TIMEOUT</span> |
| <span class="source-line-no">848</span><span id="line-848"> if (getState() == ProcedureState.WAITING && childrenCountDown()) {</span> |
| <span class="source-line-no">849</span><span id="line-849"> setState(ProcedureState.RUNNABLE);</span> |
| <span class="source-line-no">850</span><span id="line-850"> return true;</span> |
| <span class="source-line-no">851</span><span id="line-851"> } else {</span> |
| <span class="source-line-no">852</span><span id="line-852"> return false;</span> |
| <span class="source-line-no">853</span><span id="line-853"> }</span> |
| <span class="source-line-no">854</span><span id="line-854"> }</span> |
| <span class="source-line-no">855</span><span id="line-855"></span> |
| <span class="source-line-no">856</span><span id="line-856"> protected synchronized boolean hasChildren() {</span> |
| <span class="source-line-no">857</span><span id="line-857"> return childrenLatch > 0;</span> |
| <span class="source-line-no">858</span><span id="line-858"> }</span> |
| <span class="source-line-no">859</span><span id="line-859"></span> |
| <span class="source-line-no">860</span><span id="line-860"> protected synchronized int getChildrenLatch() {</span> |
| <span class="source-line-no">861</span><span id="line-861"> return childrenLatch;</span> |
| <span class="source-line-no">862</span><span id="line-862"> }</span> |
| <span class="source-line-no">863</span><span id="line-863"></span> |
| <span class="source-line-no">864</span><span id="line-864"> /**</span> |
| <span class="source-line-no">865</span><span id="line-865"> * Called by the RootProcedureState on procedure execution. Each procedure store its stack-index</span> |
| <span class="source-line-no">866</span><span id="line-866"> * positions.</span> |
| <span class="source-line-no">867</span><span id="line-867"> */</span> |
| <span class="source-line-no">868</span><span id="line-868"> protected synchronized void addStackIndex(final int index) {</span> |
| <span class="source-line-no">869</span><span id="line-869"> if (stackIndexes == null) {</span> |
| <span class="source-line-no">870</span><span id="line-870"> stackIndexes = new int[] { index };</span> |
| <span class="source-line-no">871</span><span id="line-871"> } else {</span> |
| <span class="source-line-no">872</span><span id="line-872"> int count = stackIndexes.length;</span> |
| <span class="source-line-no">873</span><span id="line-873"> stackIndexes = Arrays.copyOf(stackIndexes, count + 1);</span> |
| <span class="source-line-no">874</span><span id="line-874"> stackIndexes[count] = index;</span> |
| <span class="source-line-no">875</span><span id="line-875"> }</span> |
| <span class="source-line-no">876</span><span id="line-876"> wasExecuted = true;</span> |
| <span class="source-line-no">877</span><span id="line-877"> }</span> |
| <span class="source-line-no">878</span><span id="line-878"></span> |
| <span class="source-line-no">879</span><span id="line-879"> protected synchronized boolean removeStackIndex() {</span> |
| <span class="source-line-no">880</span><span id="line-880"> if (stackIndexes != null && stackIndexes.length > 1) {</span> |
| <span class="source-line-no">881</span><span id="line-881"> stackIndexes = Arrays.copyOf(stackIndexes, stackIndexes.length - 1);</span> |
| <span class="source-line-no">882</span><span id="line-882"> return false;</span> |
| <span class="source-line-no">883</span><span id="line-883"> } else {</span> |
| <span class="source-line-no">884</span><span id="line-884"> stackIndexes = null;</span> |
| <span class="source-line-no">885</span><span id="line-885"> return true;</span> |
| <span class="source-line-no">886</span><span id="line-886"> }</span> |
| <span class="source-line-no">887</span><span id="line-887"> }</span> |
| <span class="source-line-no">888</span><span id="line-888"></span> |
| <span class="source-line-no">889</span><span id="line-889"> /**</span> |
| <span class="source-line-no">890</span><span id="line-890"> * Called on store load to initialize the Procedure internals after the creation/deserialization.</span> |
| <span class="source-line-no">891</span><span id="line-891"> */</span> |
| <span class="source-line-no">892</span><span id="line-892"> protected synchronized void setStackIndexes(final List<Integer> stackIndexes) {</span> |
| <span class="source-line-no">893</span><span id="line-893"> this.stackIndexes = new int[stackIndexes.size()];</span> |
| <span class="source-line-no">894</span><span id="line-894"> for (int i = 0; i < this.stackIndexes.length; ++i) {</span> |
| <span class="source-line-no">895</span><span id="line-895"> this.stackIndexes[i] = stackIndexes.get(i);</span> |
| <span class="source-line-no">896</span><span id="line-896"> }</span> |
| <span class="source-line-no">897</span><span id="line-897"> // for backward compatible, where a procedure is serialized before we added the executed flag,</span> |
| <span class="source-line-no">898</span><span id="line-898"> // the flag will be false so we need to set the wasExecuted flag here</span> |
| <span class="source-line-no">899</span><span id="line-899"> this.wasExecuted = true;</span> |
| <span class="source-line-no">900</span><span id="line-900"> }</span> |
| <span class="source-line-no">901</span><span id="line-901"></span> |
| <span class="source-line-no">902</span><span id="line-902"> protected synchronized void setExecuted() {</span> |
| <span class="source-line-no">903</span><span id="line-903"> this.wasExecuted = true;</span> |
| <span class="source-line-no">904</span><span id="line-904"> }</span> |
| <span class="source-line-no">905</span><span id="line-905"></span> |
| <span class="source-line-no">906</span><span id="line-906"> public synchronized boolean wasExecuted() {</span> |
| <span class="source-line-no">907</span><span id="line-907"> return wasExecuted;</span> |
| <span class="source-line-no">908</span><span id="line-908"> }</span> |
| <span class="source-line-no">909</span><span id="line-909"></span> |
| <span class="source-line-no">910</span><span id="line-910"> protected synchronized int[] getStackIndexes() {</span> |
| <span class="source-line-no">911</span><span id="line-911"> return stackIndexes;</span> |
| <span class="source-line-no">912</span><span id="line-912"> }</span> |
| <span class="source-line-no">913</span><span id="line-913"></span> |
| <span class="source-line-no">914</span><span id="line-914"> /**</span> |
| <span class="source-line-no">915</span><span id="line-915"> * Return whether the procedure supports rollback. If the procedure does not support rollback, we</span> |
| <span class="source-line-no">916</span><span id="line-916"> * can skip the rollback state management which could increase the performance. See HBASE-28210</span> |
| <span class="source-line-no">917</span><span id="line-917"> * and HBASE-28212.</span> |
| <span class="source-line-no">918</span><span id="line-918"> */</span> |
| <span class="source-line-no">919</span><span id="line-919"> protected boolean isRollbackSupported() {</span> |
| <span class="source-line-no">920</span><span id="line-920"> return true;</span> |
| <span class="source-line-no">921</span><span id="line-921"> }</span> |
| <span class="source-line-no">922</span><span id="line-922"></span> |
| <span class="source-line-no">923</span><span id="line-923"> // ==========================================================================</span> |
| <span class="source-line-no">924</span><span id="line-924"> // Internal methods - called by the ProcedureExecutor</span> |
| <span class="source-line-no">925</span><span id="line-925"> // ==========================================================================</span> |
| <span class="source-line-no">926</span><span id="line-926"></span> |
| <span class="source-line-no">927</span><span id="line-927"> /**</span> |
| <span class="source-line-no">928</span><span id="line-928"> * Internal method called by the ProcedureExecutor that starts the user-level code execute().</span> |
| <span class="source-line-no">929</span><span id="line-929"> * @throws ProcedureSuspendedException This is used when procedure wants to halt processing and</span> |
| <span class="source-line-no">930</span><span id="line-930"> * skip out without changing states or releasing any locks</span> |
| <span class="source-line-no">931</span><span id="line-931"> * held.</span> |
| <span class="source-line-no">932</span><span id="line-932"> */</span> |
| <span class="source-line-no">933</span><span id="line-933"> protected Procedure<TEnvironment>[] doExecute(TEnvironment env)</span> |
| <span class="source-line-no">934</span><span id="line-934"> throws ProcedureYieldException, ProcedureSuspendedException, InterruptedException {</span> |
| <span class="source-line-no">935</span><span id="line-935"> try {</span> |
| <span class="source-line-no">936</span><span id="line-936"> updateTimestamp();</span> |
| <span class="source-line-no">937</span><span id="line-937"> if (bypass) {</span> |
| <span class="source-line-no">938</span><span id="line-938"> LOG.info("{} bypassed, returning null to finish it", this);</span> |
| <span class="source-line-no">939</span><span id="line-939"> return null;</span> |
| <span class="source-line-no">940</span><span id="line-940"> }</span> |
| <span class="source-line-no">941</span><span id="line-941"> return execute(env);</span> |
| <span class="source-line-no">942</span><span id="line-942"> } finally {</span> |
| <span class="source-line-no">943</span><span id="line-943"> updateTimestamp();</span> |
| <span class="source-line-no">944</span><span id="line-944"> }</span> |
| <span class="source-line-no">945</span><span id="line-945"> }</span> |
| <span class="source-line-no">946</span><span id="line-946"></span> |
| <span class="source-line-no">947</span><span id="line-947"> /**</span> |
| <span class="source-line-no">948</span><span id="line-948"> * Internal method called by the ProcedureExecutor that starts the user-level code rollback().</span> |
| <span class="source-line-no">949</span><span id="line-949"> */</span> |
| <span class="source-line-no">950</span><span id="line-950"> protected void doRollback(TEnvironment env) throws IOException, InterruptedException {</span> |
| <span class="source-line-no">951</span><span id="line-951"> try {</span> |
| <span class="source-line-no">952</span><span id="line-952"> updateTimestamp();</span> |
| <span class="source-line-no">953</span><span id="line-953"> if (bypass) {</span> |
| <span class="source-line-no">954</span><span id="line-954"> LOG.info("{} bypassed, skipping rollback", this);</span> |
| <span class="source-line-no">955</span><span id="line-955"> return;</span> |
| <span class="source-line-no">956</span><span id="line-956"> }</span> |
| <span class="source-line-no">957</span><span id="line-957"> rollback(env);</span> |
| <span class="source-line-no">958</span><span id="line-958"> } finally {</span> |
| <span class="source-line-no">959</span><span id="line-959"> updateTimestamp();</span> |
| <span class="source-line-no">960</span><span id="line-960"> }</span> |
| <span class="source-line-no">961</span><span id="line-961"> }</span> |
| <span class="source-line-no">962</span><span id="line-962"></span> |
| <span class="source-line-no">963</span><span id="line-963"> final void restoreLock(TEnvironment env) {</span> |
| <span class="source-line-no">964</span><span id="line-964"> if (!lockedWhenLoading) {</span> |
| <span class="source-line-no">965</span><span id="line-965"> LOG.debug("{} didn't hold the lock before restarting, skip acquiring lock.", this);</span> |
| <span class="source-line-no">966</span><span id="line-966"> return;</span> |
| <span class="source-line-no">967</span><span id="line-967"> }</span> |
| <span class="source-line-no">968</span><span id="line-968"></span> |
| <span class="source-line-no">969</span><span id="line-969"> if (isFinished()) {</span> |
| <span class="source-line-no">970</span><span id="line-970"> LOG.debug("{} is already finished, skip acquiring lock.", this);</span> |
| <span class="source-line-no">971</span><span id="line-971"> return;</span> |
| <span class="source-line-no">972</span><span id="line-972"> }</span> |
| <span class="source-line-no">973</span><span id="line-973"></span> |
| <span class="source-line-no">974</span><span id="line-974"> if (isBypass()) {</span> |
| <span class="source-line-no">975</span><span id="line-975"> LOG.debug("{} is already bypassed, skip acquiring lock.", this);</span> |
| <span class="source-line-no">976</span><span id="line-976"> return;</span> |
| <span class="source-line-no">977</span><span id="line-977"> }</span> |
| <span class="source-line-no">978</span><span id="line-978"> // this can happen if the parent stores the sub procedures but before it can</span> |
| <span class="source-line-no">979</span><span id="line-979"> // release its lock, the master restarts</span> |
| <span class="source-line-no">980</span><span id="line-980"> if (getState() == ProcedureState.WAITING && !holdLock(env)) {</span> |
| <span class="source-line-no">981</span><span id="line-981"> LOG.debug("{} is in WAITING STATE, and holdLock=false, skip acquiring lock.", this);</span> |
| <span class="source-line-no">982</span><span id="line-982"> lockedWhenLoading = false;</span> |
| <span class="source-line-no">983</span><span id="line-983"> return;</span> |
| <span class="source-line-no">984</span><span id="line-984"> }</span> |
| <span class="source-line-no">985</span><span id="line-985"> LOG.debug("{} held the lock before restarting, call acquireLock to restore it.", this);</span> |
| <span class="source-line-no">986</span><span id="line-986"> LockState state = acquireLock(env);</span> |
| <span class="source-line-no">987</span><span id="line-987"> assert state == LockState.LOCK_ACQUIRED;</span> |
| <span class="source-line-no">988</span><span id="line-988"> }</span> |
| <span class="source-line-no">989</span><span id="line-989"></span> |
| <span class="source-line-no">990</span><span id="line-990"> /**</span> |
| <span class="source-line-no">991</span><span id="line-991"> * Internal method called by the ProcedureExecutor that starts the user-level code acquireLock().</span> |
| <span class="source-line-no">992</span><span id="line-992"> */</span> |
| <span class="source-line-no">993</span><span id="line-993"> final LockState doAcquireLock(TEnvironment env, ProcedureStore store) {</span> |
| <span class="source-line-no">994</span><span id="line-994"> if (waitInitialized(env)) {</span> |
| <span class="source-line-no">995</span><span id="line-995"> return LockState.LOCK_EVENT_WAIT;</span> |
| <span class="source-line-no">996</span><span id="line-996"> }</span> |
| <span class="source-line-no">997</span><span id="line-997"> if (lockedWhenLoading) {</span> |
| <span class="source-line-no">998</span><span id="line-998"> // reset it so we will not consider it anymore</span> |
| <span class="source-line-no">999</span><span id="line-999"> lockedWhenLoading = false;</span> |
| <span class="source-line-no">1000</span><span id="line-1000"> locked = true;</span> |
| <span class="source-line-no">1001</span><span id="line-1001"> // Here we return without persist the locked state, as lockedWhenLoading is true means</span> |
| <span class="source-line-no">1002</span><span id="line-1002"> // that the locked field of the procedure stored in procedure store is true, so we do not need</span> |
| <span class="source-line-no">1003</span><span id="line-1003"> // to store it again.</span> |
| <span class="source-line-no">1004</span><span id="line-1004"> return LockState.LOCK_ACQUIRED;</span> |
| <span class="source-line-no">1005</span><span id="line-1005"> }</span> |
| <span class="source-line-no">1006</span><span id="line-1006"> LockState state = acquireLock(env);</span> |
| <span class="source-line-no">1007</span><span id="line-1007"> if (state == LockState.LOCK_ACQUIRED) {</span> |
| <span class="source-line-no">1008</span><span id="line-1008"> locked = true;</span> |
| <span class="source-line-no">1009</span><span id="line-1009"> // persist that we have held the lock. This must be done before we actually execute the</span> |
| <span class="source-line-no">1010</span><span id="line-1010"> // procedure, otherwise when restarting, we may consider the procedure does not have a lock,</span> |
| <span class="source-line-no">1011</span><span id="line-1011"> // but it may have already done some changes as we have already executed it, and if another</span> |
| <span class="source-line-no">1012</span><span id="line-1012"> // procedure gets the lock, then the semantic will be broken if the holdLock is true, as we do</span> |
| <span class="source-line-no">1013</span><span id="line-1013"> // not expect that another procedure can be executed in the middle.</span> |
| <span class="source-line-no">1014</span><span id="line-1014"> store.update(this);</span> |
| <span class="source-line-no">1015</span><span id="line-1015"> }</span> |
| <span class="source-line-no">1016</span><span id="line-1016"> return state;</span> |
| <span class="source-line-no">1017</span><span id="line-1017"> }</span> |
| <span class="source-line-no">1018</span><span id="line-1018"></span> |
| <span class="source-line-no">1019</span><span id="line-1019"> /**</span> |
| <span class="source-line-no">1020</span><span id="line-1020"> * Internal method called by the ProcedureExecutor that starts the user-level code releaseLock().</span> |
| <span class="source-line-no">1021</span><span id="line-1021"> */</span> |
| <span class="source-line-no">1022</span><span id="line-1022"> final void doReleaseLock(TEnvironment env, ProcedureStore store) {</span> |
| <span class="source-line-no">1023</span><span id="line-1023"> locked = false;</span> |
| <span class="source-line-no">1024</span><span id="line-1024"> // persist that we have released the lock. This must be done before we actually release the</span> |
| <span class="source-line-no">1025</span><span id="line-1025"> // lock. Another procedure may take this lock immediately after we release the lock, and if we</span> |
| <span class="source-line-no">1026</span><span id="line-1026"> // crash before persist the information that we have already released the lock, then when</span> |
| <span class="source-line-no">1027</span><span id="line-1027"> // restarting there will be two procedures which both have the lock and cause problems.</span> |
| <span class="source-line-no">1028</span><span id="line-1028"> if (getState() != ProcedureState.ROLLEDBACK) {</span> |
| <span class="source-line-no">1029</span><span id="line-1029"> // If the state is ROLLEDBACK, it means that we have already deleted the procedure from</span> |
| <span class="source-line-no">1030</span><span id="line-1030"> // procedure store, so do not need to log the release operation any more.</span> |
| <span class="source-line-no">1031</span><span id="line-1031"> store.update(this);</span> |
| <span class="source-line-no">1032</span><span id="line-1032"> }</span> |
| <span class="source-line-no">1033</span><span id="line-1033"> releaseLock(env);</span> |
| <span class="source-line-no">1034</span><span id="line-1034"> }</span> |
| <span class="source-line-no">1035</span><span id="line-1035"></span> |
| <span class="source-line-no">1036</span><span id="line-1036"> protected final ProcedureSuspendedException suspend(int timeoutMillis, boolean jitter)</span> |
| <span class="source-line-no">1037</span><span id="line-1037"> throws ProcedureSuspendedException {</span> |
| <span class="source-line-no">1038</span><span id="line-1038"> if (jitter) {</span> |
| <span class="source-line-no">1039</span><span id="line-1039"> // 10% possible jitter</span> |
| <span class="source-line-no">1040</span><span id="line-1040"> double add = (double) timeoutMillis * ThreadLocalRandom.current().nextDouble(0.1);</span> |
| <span class="source-line-no">1041</span><span id="line-1041"> timeoutMillis += add;</span> |
| <span class="source-line-no">1042</span><span id="line-1042"> }</span> |
| <span class="source-line-no">1043</span><span id="line-1043"> setTimeout(timeoutMillis);</span> |
| <span class="source-line-no">1044</span><span id="line-1044"> setState(ProcedureProtos.ProcedureState.WAITING_TIMEOUT);</span> |
| <span class="source-line-no">1045</span><span id="line-1045"> skipPersistence();</span> |
| <span class="source-line-no">1046</span><span id="line-1046"> throw new ProcedureSuspendedException();</span> |
| <span class="source-line-no">1047</span><span id="line-1047"> }</span> |
| <span class="source-line-no">1048</span><span id="line-1048"></span> |
| <span class="source-line-no">1049</span><span id="line-1049"> @Override</span> |
| <span class="source-line-no">1050</span><span id="line-1050"> public int compareTo(final Procedure<TEnvironment> other) {</span> |
| <span class="source-line-no">1051</span><span id="line-1051"> return Long.compare(getProcId(), other.getProcId());</span> |
| <span class="source-line-no">1052</span><span id="line-1052"> }</span> |
| <span class="source-line-no">1053</span><span id="line-1053"></span> |
| <span class="source-line-no">1054</span><span id="line-1054"> // ==========================================================================</span> |
| <span class="source-line-no">1055</span><span id="line-1055"> // misc utils</span> |
| <span class="source-line-no">1056</span><span id="line-1056"> // ==========================================================================</span> |
| <span class="source-line-no">1057</span><span id="line-1057"></span> |
| <span class="source-line-no">1058</span><span id="line-1058"> /**</span> |
| <span class="source-line-no">1059</span><span id="line-1059"> * Get an hashcode for the specified Procedure ID</span> |
| <span class="source-line-no">1060</span><span id="line-1060"> * @return the hashcode for the specified procId</span> |
| <span class="source-line-no">1061</span><span id="line-1061"> */</span> |
| <span class="source-line-no">1062</span><span id="line-1062"> public static long getProcIdHashCode(long procId) {</span> |
| <span class="source-line-no">1063</span><span id="line-1063"> long h = procId;</span> |
| <span class="source-line-no">1064</span><span id="line-1064"> h ^= h >> 16;</span> |
| <span class="source-line-no">1065</span><span id="line-1065"> h *= 0x85ebca6b;</span> |
| <span class="source-line-no">1066</span><span id="line-1066"> h ^= h >> 13;</span> |
| <span class="source-line-no">1067</span><span id="line-1067"> h *= 0xc2b2ae35;</span> |
| <span class="source-line-no">1068</span><span id="line-1068"> h ^= h >> 16;</span> |
| <span class="source-line-no">1069</span><span id="line-1069"> return h;</span> |
| <span class="source-line-no">1070</span><span id="line-1070"> }</span> |
| <span class="source-line-no">1071</span><span id="line-1071"></span> |
| <span class="source-line-no">1072</span><span id="line-1072"> /**</span> |
| <span class="source-line-no">1073</span><span id="line-1073"> * Helper to lookup the root Procedure ID given a specified procedure.</span> |
| <span class="source-line-no">1074</span><span id="line-1074"> */</span> |
| <span class="source-line-no">1075</span><span id="line-1075"> protected static <T> Long getRootProcedureId(Map<Long, Procedure<T>> procedures,</span> |
| <span class="source-line-no">1076</span><span id="line-1076"> Procedure<T> proc) {</span> |
| <span class="source-line-no">1077</span><span id="line-1077"> while (proc.hasParent()) {</span> |
| <span class="source-line-no">1078</span><span id="line-1078"> proc = procedures.get(proc.getParentProcId());</span> |
| <span class="source-line-no">1079</span><span id="line-1079"> if (proc == null) {</span> |
| <span class="source-line-no">1080</span><span id="line-1080"> return null;</span> |
| <span class="source-line-no">1081</span><span id="line-1081"> }</span> |
| <span class="source-line-no">1082</span><span id="line-1082"> }</span> |
| <span class="source-line-no">1083</span><span id="line-1083"> return proc.getProcId();</span> |
| <span class="source-line-no">1084</span><span id="line-1084"> }</span> |
| <span class="source-line-no">1085</span><span id="line-1085"></span> |
| <span class="source-line-no">1086</span><span id="line-1086"> /**</span> |
| <span class="source-line-no">1087</span><span id="line-1087"> * @param a the first procedure to be compared.</span> |
| <span class="source-line-no">1088</span><span id="line-1088"> * @param b the second procedure to be compared.</span> |
| <span class="source-line-no">1089</span><span id="line-1089"> * @return true if the two procedures have the same parent</span> |
| <span class="source-line-no">1090</span><span id="line-1090"> */</span> |
| <span class="source-line-no">1091</span><span id="line-1091"> public static boolean haveSameParent(Procedure<?> a, Procedure<?> b) {</span> |
| <span class="source-line-no">1092</span><span id="line-1092"> return a.hasParent() && b.hasParent() && (a.getParentProcId() == b.getParentProcId());</span> |
| <span class="source-line-no">1093</span><span id="line-1093"> }</span> |
| <span class="source-line-no">1094</span><span id="line-1094">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
