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