You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hbase.apache.org by gi...@apache.org on 2018/08/31 14:47:44 UTC
[14/51] [partial] hbase-site git commit: Published site at
7c1fad4992a169a35b4457e6f4afcb30d04406e9.
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/74f60271/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/Procedure.html
----------------------------------------------------------------------
diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/Procedure.html b/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/Procedure.html
index 3cfacfc..c081310 100644
--- a/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/Procedure.html
+++ b/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/Procedure.html
@@ -153,858 +153,901 @@
<span class="sourceLineNo">145</span> private boolean lockedWhenLoading = false;<a name="line.145"></a>
<span class="sourceLineNo">146</span><a name="line.146"></a>
<span class="sourceLineNo">147</span> /**<a name="line.147"></a>
-<span class="sourceLineNo">148</span> * The main code of the procedure. It must be idempotent since execute()<a name="line.148"></a>
-<span class="sourceLineNo">149</span> * may be called multiple times in case of machine failure in the middle<a name="line.149"></a>
-<span class="sourceLineNo">150</span> * of the execution.<a name="line.150"></a>
-<span class="sourceLineNo">151</span> * @param env the environment passed to the ProcedureExecutor<a name="line.151"></a>
-<span class="sourceLineNo">152</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.152"></a>
-<span class="sourceLineNo">153</span> * procedure is done.<a name="line.153"></a>
-<span class="sourceLineNo">154</span> * @throws ProcedureYieldException the procedure will be added back to the queue and retried later.<a name="line.154"></a>
-<span class="sourceLineNo">155</span> * @throws InterruptedException the procedure will be added back to the queue and retried later.<a name="line.155"></a>
-<span class="sourceLineNo">156</span> * @throws ProcedureSuspendedException Signal to the executor that Procedure has suspended itself and<a name="line.156"></a>
-<span class="sourceLineNo">157</span> * has set itself up waiting for an external event to wake it back up again.<a name="line.157"></a>
-<span class="sourceLineNo">158</span> */<a name="line.158"></a>
-<span class="sourceLineNo">159</span> protected abstract Procedure<TEnvironment>[] execute(TEnvironment env)<a name="line.159"></a>
-<span class="sourceLineNo">160</span> throws ProcedureYieldException, ProcedureSuspendedException, InterruptedException;<a name="line.160"></a>
-<span class="sourceLineNo">161</span><a name="line.161"></a>
-<span class="sourceLineNo">162</span> /**<a name="line.162"></a>
-<span class="sourceLineNo">163</span> * The code to undo what was done by the execute() code.<a name="line.163"></a>
-<span class="sourceLineNo">164</span> * It is called when the procedure or one of the sub-procedures failed or an<a name="line.164"></a>
-<span class="sourceLineNo">165</span> * abort was requested. It should cleanup all the resources created by<a name="line.165"></a>
-<span class="sourceLineNo">166</span> * the execute() call. The implementation must be idempotent since rollback()<a name="line.166"></a>
-<span class="sourceLineNo">167</span> * may be called multiple time in case of machine failure in the middle<a name="line.167"></a>
-<span class="sourceLineNo">168</span> * of the execution.<a name="line.168"></a>
-<span class="sourceLineNo">169</span> * @param env the environment passed to the ProcedureExecutor<a name="line.169"></a>
-<span class="sourceLineNo">170</span> * @throws IOException temporary failure, the rollback will retry later<a name="line.170"></a>
-<span class="sourceLineNo">171</span> * @throws InterruptedException the procedure will be added back to the queue and retried later<a name="line.171"></a>
-<span class="sourceLineNo">172</span> */<a name="line.172"></a>
-<span class="sourceLineNo">173</span> protected abstract void rollback(TEnvironment env)<a name="line.173"></a>
-<span class="sourceLineNo">174</span> throws IOException, InterruptedException;<a name="line.174"></a>
-<span class="sourceLineNo">175</span><a name="line.175"></a>
-<span class="sourceLineNo">176</span> /**<a name="line.176"></a>
-<span class="sourceLineNo">177</span> * The abort() call is asynchronous and each procedure must decide how to deal<a name="line.177"></a>
-<span class="sourceLineNo">178</span> * with it, if they want to be abortable. The simplest implementation<a name="line.178"></a>
-<span class="sourceLineNo">179</span> * is to have an AtomicBoolean set in the abort() method and then the execute()<a name="line.179"></a>
-<span class="sourceLineNo">180</span> * will check if the abort flag is set or not.<a name="line.180"></a>
-<span class="sourceLineNo">181</span> * abort() may be called multiple times from the client, so the implementation<a name="line.181"></a>
-<span class="sourceLineNo">182</span> * must be idempotent.<a name="line.182"></a>
-<span class="sourceLineNo">183</span> *<a name="line.183"></a>
-<span class="sourceLineNo">184</span> * <p>NOTE: abort() is not like Thread.interrupt(). It is just a notification<a name="line.184"></a>
-<span class="sourceLineNo">185</span> * that allows the procedure implementor abort.<a name="line.185"></a>
-<span class="sourceLineNo">186</span> */<a name="line.186"></a>
-<span class="sourceLineNo">187</span> protected abstract boolean abort(TEnvironment env);<a name="line.187"></a>
-<span class="sourceLineNo">188</span><a name="line.188"></a>
-<span class="sourceLineNo">189</span> /**<a name="line.189"></a>
-<span class="sourceLineNo">190</span> * The user-level code of the procedure may have some state to<a name="line.190"></a>
-<span class="sourceLineNo">191</span> * persist (e.g. input arguments or current position in the processing state) to<a name="line.191"></a>
-<span class="sourceLineNo">192</span> * be able to resume on failure.<a name="line.192"></a>
-<span class="sourceLineNo">193</span> * @param serializer stores the serializable state<a name="line.193"></a>
-<span class="sourceLineNo">194</span> */<a name="line.194"></a>
-<span class="sourceLineNo">195</span> protected abstract void serializeStateData(ProcedureStateSerializer serializer)<a name="line.195"></a>
-<span class="sourceLineNo">196</span> throws IOException;<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> * Called on store load to allow the user to decode the previously serialized<a name="line.199"></a>
-<span class="sourceLineNo">200</span> * state.<a name="line.200"></a>
-<span class="sourceLineNo">201</span> * @param serializer contains the serialized state<a name="line.201"></a>
-<span class="sourceLineNo">202</span> */<a name="line.202"></a>
-<span class="sourceLineNo">203</span> protected abstract void deserializeStateData(ProcedureStateSerializer serializer)<a name="line.203"></a>
-<span class="sourceLineNo">204</span> throws IOException;<a name="line.204"></a>
-<span class="sourceLineNo">205</span><a name="line.205"></a>
-<span class="sourceLineNo">206</span> /**<a name="line.206"></a>
-<span class="sourceLineNo">207</span> * The {@link #doAcquireLock(Object, ProcedureStore)} will be split into two steps, first, it will<a name="line.207"></a>
-<span class="sourceLineNo">208</span> * call us to determine whether we need to wait for initialization, second, it will call<a name="line.208"></a>
-<span class="sourceLineNo">209</span> * {@link #acquireLock(Object)} to actually handle the lock for this procedure.<a name="line.209"></a>
-<span class="sourceLineNo">210</span> * <p/><a name="line.210"></a>
-<span class="sourceLineNo">211</span> * This is because that when master restarts, we need to restore the lock state for all the<a name="line.211"></a>
-<span class="sourceLineNo">212</span> * procedures to not break the semantic if {@link #holdLock(Object)} is true. But the<a name="line.212"></a>
-<span class="sourceLineNo">213</span> * {@link ProcedureExecutor} will be started before the master finish initialization(as it is part<a name="line.213"></a>
-<span class="sourceLineNo">214</span> * of the initialization!), so we need to split the code into two steps, and when restore, we just<a name="line.214"></a>
-<span class="sourceLineNo">215</span> * restore the lock part and ignore the waitInitialized part. Otherwise there will be dead lock.<a name="line.215"></a>
-<span class="sourceLineNo">216</span> * @return true means we need to wait until the environment has been initialized, otherwise true.<a name="line.216"></a>
-<span class="sourceLineNo">217</span> */<a name="line.217"></a>
-<span class="sourceLineNo">218</span> protected boolean waitInitialized(TEnvironment env) {<a name="line.218"></a>
-<span class="sourceLineNo">219</span> return false;<a name="line.219"></a>
-<span class="sourceLineNo">220</span> }<a name="line.220"></a>
-<span class="sourceLineNo">221</span><a name="line.221"></a>
-<span class="sourceLineNo">222</span> /**<a name="line.222"></a>
-<span class="sourceLineNo">223</span> * The user should override this method if they need a lock on an Entity. A lock can be anything,<a name="line.223"></a>
-<span class="sourceLineNo">224</span> * and it is up to the implementor. The Procedure Framework will call this method just before it<a name="line.224"></a>
-<span class="sourceLineNo">225</span> * invokes {@link #execute(Object)}. It calls {@link #releaseLock(Object)} after the call to<a name="line.225"></a>
-<span class="sourceLineNo">226</span> * execute.<a name="line.226"></a>
-<span class="sourceLineNo">227</span> * <p/><a name="line.227"></a>
-<span class="sourceLineNo">228</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.228"></a>
-<span class="sourceLineNo">229</span> * Procedure interfering while this Procedure is running, see {@link #holdLock(Object)}.<a name="line.229"></a>
-<span class="sourceLineNo">230</span> * <p/><a name="line.230"></a>
-<span class="sourceLineNo">231</span> * Example: in our Master we can execute request in parallel for different tables. We can create<a name="line.231"></a>
-<span class="sourceLineNo">232</span> * t1 and create t2 and these creates can be executed at the same time. Anything else on t1/t2 is<a name="line.232"></a>
-<span class="sourceLineNo">233</span> * queued waiting that specific table create to happen.<a name="line.233"></a>
-<span class="sourceLineNo">234</span> * <p/><a name="line.234"></a>
-<span class="sourceLineNo">235</span> * There are 3 LockState:<a name="line.235"></a>
-<span class="sourceLineNo">236</span> * <ul><a name="line.236"></a>
-<span class="sourceLineNo">237</span> * <li>LOCK_ACQUIRED should be returned when the proc has the lock and the proc is ready to<a name="line.237"></a>
-<span class="sourceLineNo">238</span> * execute.</li><a name="line.238"></a>
-<span class="sourceLineNo">239</span> * <li>LOCK_YIELD_WAIT should be returned when the proc has not the lock and the framework should<a name="line.239"></a>
-<span class="sourceLineNo">240</span> * take care of readding the procedure back to the runnable set for retry</li><a name="line.240"></a>
-<span class="sourceLineNo">241</span> * <li>LOCK_EVENT_WAIT should be returned when the proc has not the lock and someone will take<a name="line.241"></a>
-<span class="sourceLineNo">242</span> * care of readding the procedure back to the runnable set when the lock is available.</li><a name="line.242"></a>
-<span class="sourceLineNo">243</span> * </ul><a name="line.243"></a>
-<span class="sourceLineNo">244</span> * @return the lock state as described above.<a name="line.244"></a>
-<span class="sourceLineNo">245</span> */<a name="line.245"></a>
-<span class="sourceLineNo">246</span> protected LockState acquireLock(TEnvironment env) {<a name="line.246"></a>
-<span class="sourceLineNo">247</span> return LockState.LOCK_ACQUIRED;<a name="line.247"></a>
-<span class="sourceLineNo">248</span> }<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> * The user should override this method, and release lock if necessary.<a name="line.251"></a>
-<span class="sourceLineNo">252</span> */<a name="line.252"></a>
-<span class="sourceLineNo">253</span> protected void releaseLock(TEnvironment env) {<a name="line.253"></a>
-<span class="sourceLineNo">254</span> // no-op<a name="line.254"></a>
-<span class="sourceLineNo">255</span> }<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> * Used to keep the procedure lock even when the procedure is yielding or suspended.<a name="line.258"></a>
-<span class="sourceLineNo">259</span> * @return true if the procedure should hold on the lock until completionCleanup()<a name="line.259"></a>
-<span class="sourceLineNo">260</span> */<a name="line.260"></a>
-<span class="sourceLineNo">261</span> protected boolean holdLock(TEnvironment env) {<a name="line.261"></a>
-<span class="sourceLineNo">262</span> return false;<a name="line.262"></a>
-<span class="sourceLineNo">263</span> }<a name="line.263"></a>
-<span class="sourceLineNo">264</span><a name="line.264"></a>
-<span class="sourceLineNo">265</span> /**<a name="line.265"></a>
-<span class="sourceLineNo">266</span> * This is used in conjunction with {@link #holdLock(Object)}. If {@link #holdLock(Object)}<a name="line.266"></a>
-<span class="sourceLineNo">267</span> * returns true, the procedure executor will call acquireLock() once and thereafter<a name="line.267"></a>
-<span class="sourceLineNo">268</span> * not call {@link #releaseLock(Object)} until the Procedure is done (Normally, it calls<a name="line.268"></a>
-<span class="sourceLineNo">269</span> * release/acquire around each invocation of {@link #execute(Object)}.<a name="line.269"></a>
-<span class="sourceLineNo">270</span> * @see #holdLock(Object)<a name="line.270"></a>
-<span class="sourceLineNo">271</span> * @return true if the procedure has the lock, false otherwise.<a name="line.271"></a>
-<span class="sourceLineNo">272</span> */<a name="line.272"></a>
-<span class="sourceLineNo">273</span> protected final boolean hasLock() {<a name="line.273"></a>
-<span class="sourceLineNo">274</span> return locked;<a name="line.274"></a>
-<span class="sourceLineNo">275</span> }<a name="line.275"></a>
-<span class="sourceLineNo">276</span><a name="line.276"></a>
-<span class="sourceLineNo">277</span> /**<a name="line.277"></a>
-<span class="sourceLineNo">278</span> * Called when the procedure is loaded for replay.<a name="line.278"></a>
-<span class="sourceLineNo">279</span> * The procedure implementor may use this method to perform some quick<a name="line.279"></a>
-<span class="sourceLineNo">280</span> * operation before replay.<a name="line.280"></a>
-<span class="sourceLineNo">281</span> * e.g. failing the procedure if the state on replay may be unknown.<a name="line.281"></a>
-<span class="sourceLineNo">282</span> */<a name="line.282"></a>
-<span class="sourceLineNo">283</span> protected void beforeReplay(TEnvironment env) {<a name="line.283"></a>
-<span class="sourceLineNo">284</span> // no-op<a name="line.284"></a>
-<span class="sourceLineNo">285</span> }<a name="line.285"></a>
-<span class="sourceLineNo">286</span><a name="line.286"></a>
-<span class="sourceLineNo">287</span> /**<a name="line.287"></a>
-<span class="sourceLineNo">288</span> * Called when the procedure is ready to be added to the queue after<a name="line.288"></a>
-<span class="sourceLineNo">289</span> * the loading/replay operation.<a name="line.289"></a>
-<span class="sourceLineNo">290</span> */<a name="line.290"></a>
-<span class="sourceLineNo">291</span> protected void afterReplay(TEnvironment env) {<a name="line.291"></a>
-<span class="sourceLineNo">292</span> // no-op<a name="line.292"></a>
-<span class="sourceLineNo">293</span> }<a name="line.293"></a>
-<span class="sourceLineNo">294</span><a name="line.294"></a>
-<span class="sourceLineNo">295</span> /**<a name="line.295"></a>
-<span class="sourceLineNo">296</span> * Called when the procedure is marked as completed (success or rollback).<a name="line.296"></a>
-<span class="sourceLineNo">297</span> * The procedure implementor may use this method to cleanup in-memory states.<a name="line.297"></a>
-<span class="sourceLineNo">298</span> * This operation will not be retried on failure. If a procedure took a lock,<a name="line.298"></a>
-<span class="sourceLineNo">299</span> * it will have been released when this method runs.<a name="line.299"></a>
-<span class="sourceLineNo">300</span> */<a name="line.300"></a>
-<span class="sourceLineNo">301</span> protected void completionCleanup(TEnvironment env) {<a name="line.301"></a>
-<span class="sourceLineNo">302</span> // no-op<a name="line.302"></a>
-<span class="sourceLineNo">303</span> }<a name="line.303"></a>
-<span class="sourceLineNo">304</span><a name="line.304"></a>
-<span class="sourceLineNo">305</span> /**<a name="line.305"></a>
-<span class="sourceLineNo">306</span> * By default, the procedure framework/executor will try to run procedures start to finish.<a name="line.306"></a>
-<span class="sourceLineNo">307</span> * Return true to make the executor yield between each execution step to<a name="line.307"></a>
-<span class="sourceLineNo">308</span> * give other procedures a chance to run.<a name="line.308"></a>
-<span class="sourceLineNo">309</span> * @param env the environment passed to the ProcedureExecutor<a name="line.309"></a>
-<span class="sourceLineNo">310</span> * @return Return true if the executor should yield on completion of an execution step.<a name="line.310"></a>
-<span class="sourceLineNo">311</span> * Defaults to return false.<a name="line.311"></a>
-<span class="sourceLineNo">312</span> */<a name="line.312"></a>
-<span class="sourceLineNo">313</span> protected boolean isYieldAfterExecutionStep(TEnvironment env) {<a name="line.313"></a>
-<span class="sourceLineNo">314</span> return false;<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> /**<a name="line.317"></a>
-<span class="sourceLineNo">318</span> * By default, the executor will keep the procedure result around util<a name="line.318"></a>
-<span class="sourceLineNo">319</span> * the eviction TTL is expired. The client can cut down the waiting time<a name="line.319"></a>
-<span class="sourceLineNo">320</span> * by requesting that the result is removed from the executor.<a name="line.320"></a>
-<span class="sourceLineNo">321</span> * In case of system started procedure, we can force the executor to auto-ack.<a name="line.321"></a>
-<span class="sourceLineNo">322</span> * @param env the environment passed to the ProcedureExecutor<a name="line.322"></a>
-<span class="sourceLineNo">323</span> * @return true if the executor should wait the client ack for the result.<a name="line.323"></a>
-<span class="sourceLineNo">324</span> * Defaults to return true.<a name="line.324"></a>
-<span class="sourceLineNo">325</span> */<a name="line.325"></a>
-<span class="sourceLineNo">326</span> protected boolean shouldWaitClientAck(TEnvironment env) {<a name="line.326"></a>
-<span class="sourceLineNo">327</span> return true;<a name="line.327"></a>
-<span class="sourceLineNo">328</span> }<a name="line.328"></a>
-<span class="sourceLineNo">329</span><a name="line.329"></a>
-<span class="sourceLineNo">330</span> /**<a name="line.330"></a>
-<span class="sourceLineNo">331</span> * Override this method to provide procedure specific counters for submitted count, failed<a name="line.331"></a>
-<span class="sourceLineNo">332</span> * count and time histogram.<a name="line.332"></a>
-<span class="sourceLineNo">333</span> * @param env The environment passed to the procedure executor<a name="line.333"></a>
-<span class="sourceLineNo">334</span> * @return Container object for procedure related metric<a name="line.334"></a>
-<span class="sourceLineNo">335</span> */<a name="line.335"></a>
-<span class="sourceLineNo">336</span> protected ProcedureMetrics getProcedureMetrics(TEnvironment env) {<a name="line.336"></a>
-<span class="sourceLineNo">337</span> return null;<a name="line.337"></a>
-<span class="sourceLineNo">338</span> }<a name="line.338"></a>
-<span class="sourceLineNo">339</span><a name="line.339"></a>
-<span class="sourceLineNo">340</span> /**<a name="line.340"></a>
-<span class="sourceLineNo">341</span> * This function will be called just when procedure is submitted for execution. Override this<a name="line.341"></a>
-<span class="sourceLineNo">342</span> * method to update the metrics at the beginning of the procedure. The default implementation<a name="line.342"></a>
-<span class="sourceLineNo">343</span> * updates submitted counter if {@link #getProcedureMetrics(Object)} returns non-null<a name="line.343"></a>
-<span class="sourceLineNo">344</span> * {@link ProcedureMetrics}.<a name="line.344"></a>
-<span class="sourceLineNo">345</span> */<a name="line.345"></a>
-<span class="sourceLineNo">346</span> protected void updateMetricsOnSubmit(TEnvironment env) {<a name="line.346"></a>
-<span class="sourceLineNo">347</span> ProcedureMetrics metrics = getProcedureMetrics(env);<a name="line.347"></a>
-<span class="sourceLineNo">348</span> if (metrics == null) {<a name="line.348"></a>
-<span class="sourceLineNo">349</span> return;<a name="line.349"></a>
-<span class="sourceLineNo">350</span> }<a name="line.350"></a>
-<span class="sourceLineNo">351</span><a name="line.351"></a>
-<span class="sourceLineNo">352</span> Counter submittedCounter = metrics.getSubmittedCounter();<a name="line.352"></a>
-<span class="sourceLineNo">353</span> if (submittedCounter != null) {<a name="line.353"></a>
-<span class="sourceLineNo">354</span> submittedCounter.increment();<a name="line.354"></a>
-<span class="sourceLineNo">355</span> }<a name="line.355"></a>
-<span class="sourceLineNo">356</span> }<a name="line.356"></a>
-<span class="sourceLineNo">357</span><a name="line.357"></a>
-<span class="sourceLineNo">358</span> /**<a name="line.358"></a>
-<span class="sourceLineNo">359</span> * This function will be called just after procedure execution is finished. Override this method<a name="line.359"></a>
-<span class="sourceLineNo">360</span> * to update metrics at the end of the procedure. If {@link #getProcedureMetrics(Object)} returns<a name="line.360"></a>
-<span class="sourceLineNo">361</span> * non-null {@link ProcedureMetrics}, the default implementation adds runtime of a procedure to a<a name="line.361"></a>
-<span class="sourceLineNo">362</span> * time histogram for successfully completed procedures. Increments failed counter for failed<a name="line.362"></a>
-<span class="sourceLineNo">363</span> * procedures.<a name="line.363"></a>
-<span class="sourceLineNo">364</span> * <p/><a name="line.364"></a>
-<span class="sourceLineNo">365</span> * TODO: As any of the sub-procedures on failure rolls back all procedures in the stack, including<a name="line.365"></a>
-<span class="sourceLineNo">366</span> * successfully finished siblings, this function may get called twice in certain cases for certain<a name="line.366"></a>
-<span class="sourceLineNo">367</span> * procedures. Explore further if this can be called once.<a name="line.367"></a>
-<span class="sourceLineNo">368</span> * @param env The environment passed to the procedure executor<a name="line.368"></a>
-<span class="sourceLineNo">369</span> * @param runtime Runtime of the procedure in milliseconds<a name="line.369"></a>
-<span class="sourceLineNo">370</span> * @param success true if procedure is completed successfully<a name="line.370"></a>
+<span class="sourceLineNo">148</span> * Used for force complete of the procedure without<a name="line.148"></a>
+<span class="sourceLineNo">149</span> * actually doing any logic in the procedure.<a name="line.149"></a>
+<span class="sourceLineNo">150</span> * If bypass is set to true, when executing it will return null when<a name="line.150"></a>
+<span class="sourceLineNo">151</span> * {@link #doExecute(Object)} to finish the procedure and releasing any locks<a name="line.151"></a>
+<span class="sourceLineNo">152</span> * it may currently hold.<a name="line.152"></a>
+<span class="sourceLineNo">153</span> * Bypassing a procedure is not like aborting. Aborting a procedure will trigger<a name="line.153"></a>
+<span class="sourceLineNo">154</span> * a rollback. And since the {@link #abort(Object)} method is overrideable<a name="line.154"></a>
+<span class="sourceLineNo">155</span> * Some procedures may have chosen to ignore the aborting.<a name="line.155"></a>
+<span class="sourceLineNo">156</span> */<a name="line.156"></a>
+<span class="sourceLineNo">157</span> private volatile boolean bypass = false;<a name="line.157"></a>
+<span class="sourceLineNo">158</span><a name="line.158"></a>
+<span class="sourceLineNo">159</span> public boolean isBypass() {<a name="line.159"></a>
+<span class="sourceLineNo">160</span> return bypass;<a name="line.160"></a>
+<span class="sourceLineNo">161</span> }<a name="line.161"></a>
+<span class="sourceLineNo">162</span><a name="line.162"></a>
+<span class="sourceLineNo">163</span> /**<a name="line.163"></a>
+<span class="sourceLineNo">164</span> * set the bypass to true<a name="line.164"></a>
+<span class="sourceLineNo">165</span> * Only called in {@link ProcedureExecutor#bypassProcedure(long, long, boolean)} for now,<a name="line.165"></a>
+<span class="sourceLineNo">166</span> * DO NOT use this method alone, since we can't just bypass<a name="line.166"></a>
+<span class="sourceLineNo">167</span> * one single procedure. We need to bypass its ancestor too. So making it package private<a name="line.167"></a>
+<span class="sourceLineNo">168</span> */<a name="line.168"></a>
+<span class="sourceLineNo">169</span> void bypass() {<a name="line.169"></a>
+<span class="sourceLineNo">170</span> this.bypass = true;<a name="line.170"></a>
+<span class="sourceLineNo">171</span> }<a name="line.171"></a>
+<span class="sourceLineNo">172</span><a name="line.172"></a>
+<span class="sourceLineNo">173</span> /**<a name="line.173"></a>
+<span class="sourceLineNo">174</span> * The main code of the procedure. It must be idempotent since execute()<a name="line.174"></a>
+<span class="sourceLineNo">175</span> * may be called multiple times in case of machine failure in the middle<a name="line.175"></a>
+<span class="sourceLineNo">176</span> * of the execution.<a name="line.176"></a>
+<span class="sourceLineNo">177</span> * @param env the environment passed to the ProcedureExecutor<a name="line.177"></a>
+<span class="sourceLineNo">178</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.178"></a>
+<span class="sourceLineNo">179</span> * procedure is done.<a name="line.179"></a>
+<span class="sourceLineNo">180</span> * @throws ProcedureYieldException the procedure will be added back to the queue and retried later.<a name="line.180"></a>
+<span class="sourceLineNo">181</span> * @throws InterruptedException the procedure will be added back to the queue and retried later.<a name="line.181"></a>
+<span class="sourceLineNo">182</span> * @throws ProcedureSuspendedException Signal to the executor that Procedure has suspended itself and<a name="line.182"></a>
+<span class="sourceLineNo">183</span> * has set itself up waiting for an external event to wake it back up again.<a name="line.183"></a>
+<span class="sourceLineNo">184</span> */<a name="line.184"></a>
+<span class="sourceLineNo">185</span> protected abstract Procedure<TEnvironment>[] execute(TEnvironment env)<a name="line.185"></a>
+<span class="sourceLineNo">186</span> throws ProcedureYieldException, ProcedureSuspendedException, InterruptedException;<a name="line.186"></a>
+<span class="sourceLineNo">187</span><a name="line.187"></a>
+<span class="sourceLineNo">188</span> /**<a name="line.188"></a>
+<span class="sourceLineNo">189</span> * The code to undo what was done by the execute() code.<a name="line.189"></a>
+<span class="sourceLineNo">190</span> * It is called when the procedure or one of the sub-procedures failed or an<a name="line.190"></a>
+<span class="sourceLineNo">191</span> * abort was requested. It should cleanup all the resources created by<a name="line.191"></a>
+<span class="sourceLineNo">192</span> * the execute() call. The implementation must be idempotent since rollback()<a name="line.192"></a>
+<span class="sourceLineNo">193</span> * may be called multiple time in case of machine failure in the middle<a name="line.193"></a>
+<span class="sourceLineNo">194</span> * of the execution.<a name="line.194"></a>
+<span class="sourceLineNo">195</span> * @param env the environment passed to the ProcedureExecutor<a name="line.195"></a>
+<span class="sourceLineNo">196</span> * @throws IOException temporary failure, the rollback will retry later<a name="line.196"></a>
+<span class="sourceLineNo">197</span> * @throws InterruptedException the procedure will be added back to the queue and retried later<a name="line.197"></a>
+<span class="sourceLineNo">198</span> */<a name="line.198"></a>
+<span class="sourceLineNo">199</span> protected abstract void rollback(TEnvironment env)<a name="line.199"></a>
+<span class="sourceLineNo">200</span> throws IOException, InterruptedException;<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> * The abort() call is asynchronous and each procedure must decide how to deal<a name="line.203"></a>
+<span class="sourceLineNo">204</span> * with it, if they want to be abortable. The simplest implementation<a name="line.204"></a>
+<span class="sourceLineNo">205</span> * is to have an AtomicBoolean set in the abort() method and then the execute()<a name="line.205"></a>
+<span class="sourceLineNo">206</span> * will check if the abort flag is set or not.<a name="line.206"></a>
+<span class="sourceLineNo">207</span> * abort() may be called multiple times from the client, so the implementation<a name="line.207"></a>
+<span class="sourceLineNo">208</span> * must be idempotent.<a name="line.208"></a>
+<span class="sourceLineNo">209</span> *<a name="line.209"></a>
+<span class="sourceLineNo">210</span> * <p>NOTE: abort() is not like Thread.interrupt(). It is just a notification<a name="line.210"></a>
+<span class="sourceLineNo">211</span> * that allows the procedure implementor abort.<a name="line.211"></a>
+<span class="sourceLineNo">212</span> */<a name="line.212"></a>
+<span class="sourceLineNo">213</span> protected abstract boolean abort(TEnvironment env);<a name="line.213"></a>
+<span class="sourceLineNo">214</span><a name="line.214"></a>
+<span class="sourceLineNo">215</span> /**<a name="line.215"></a>
+<span class="sourceLineNo">216</span> * The user-level code of the procedure may have some state to<a name="line.216"></a>
+<span class="sourceLineNo">217</span> * persist (e.g. input arguments or current position in the processing state) to<a name="line.217"></a>
+<span class="sourceLineNo">218</span> * be able to resume on failure.<a name="line.218"></a>
+<span class="sourceLineNo">219</span> * @param serializer stores the serializable state<a name="line.219"></a>
+<span class="sourceLineNo">220</span> */<a name="line.220"></a>
+<span class="sourceLineNo">221</span> protected abstract void serializeStateData(ProcedureStateSerializer serializer)<a name="line.221"></a>
+<span class="sourceLineNo">222</span> throws IOException;<a name="line.222"></a>
+<span class="sourceLineNo">223</span><a name="line.223"></a>
+<span class="sourceLineNo">224</span> /**<a name="line.224"></a>
+<span class="sourceLineNo">225</span> * Called on store load to allow the user to decode the previously serialized<a name="line.225"></a>
+<span class="sourceLineNo">226</span> * state.<a name="line.226"></a>
+<span class="sourceLineNo">227</span> * @param serializer contains the serialized state<a name="line.227"></a>
+<span class="sourceLineNo">228</span> */<a name="line.228"></a>
+<span class="sourceLineNo">229</span> protected abstract void deserializeStateData(ProcedureStateSerializer serializer)<a name="line.229"></a>
+<span class="sourceLineNo">230</span> throws IOException;<a name="line.230"></a>
+<span class="sourceLineNo">231</span><a name="line.231"></a>
+<span class="sourceLineNo">232</span> /**<a name="line.232"></a>
+<span class="sourceLineNo">233</span> * The {@link #doAcquireLock(Object, ProcedureStore)} will be split into two steps, first, it will<a name="line.233"></a>
+<span class="sourceLineNo">234</span> * call us to determine whether we need to wait for initialization, second, it will call<a name="line.234"></a>
+<span class="sourceLineNo">235</span> * {@link #acquireLock(Object)} to actually handle the lock for this procedure.<a name="line.235"></a>
+<span class="sourceLineNo">236</span> * <p/><a name="line.236"></a>
+<span class="sourceLineNo">237</span> * This is because that when master restarts, we need to restore the lock state for all the<a name="line.237"></a>
+<span class="sourceLineNo">238</span> * procedures to not break the semantic if {@link #holdLock(Object)} is true. But the<a name="line.238"></a>
+<span class="sourceLineNo">239</span> * {@link ProcedureExecutor} will be started before the master finish initialization(as it is part<a name="line.239"></a>
+<span class="sourceLineNo">240</span> * of the initialization!), so we need to split the code into two steps, and when restore, we just<a name="line.240"></a>
+<span class="sourceLineNo">241</span> * restore the lock part and ignore the waitInitialized part. Otherwise there will be dead lock.<a name="line.241"></a>
+<span class="sourceLineNo">242</span> * @return true means we need to wait until the environment has been initialized, otherwise true.<a name="line.242"></a>
+<span class="sourceLineNo">243</span> */<a name="line.243"></a>
+<span class="sourceLineNo">244</span> protected boolean waitInitialized(TEnvironment env) {<a name="line.244"></a>
+<span class="sourceLineNo">245</span> return false;<a name="line.245"></a>
+<span class="sourceLineNo">246</span> }<a name="line.246"></a>
+<span class="sourceLineNo">247</span><a name="line.247"></a>
+<span class="sourceLineNo">248</span> /**<a name="line.248"></a>
+<span class="sourceLineNo">249</span> * The user should override this method if they need a lock on an Entity. A lock can be anything,<a name="line.249"></a>
+<span class="sourceLineNo">250</span> * and it is up to the implementor. The Procedure Framework will call this method just before it<a name="line.250"></a>
+<span class="sourceLineNo">251</span> * invokes {@link #execute(Object)}. It calls {@link #releaseLock(Object)} after the call to<a name="line.251"></a>
+<span class="sourceLineNo">252</span> * execute.<a name="line.252"></a>
+<span class="sourceLineNo">253</span> * <p/><a name="line.253"></a>
+<span class="sourceLineNo">254</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.254"></a>
+<span class="sourceLineNo">255</span> * Procedure interfering while this Procedure is running, see {@link #holdLock(Object)}.<a name="line.255"></a>
+<span class="sourceLineNo">256</span> * <p/><a name="line.256"></a>
+<span class="sourceLineNo">257</span> * Example: in our Master we can execute request in parallel for different tables. We can create<a name="line.257"></a>
+<span class="sourceLineNo">258</span> * t1 and create t2 and these creates can be executed at the same time. Anything else on t1/t2 is<a name="line.258"></a>
+<span class="sourceLineNo">259</span> * queued waiting that specific table create to happen.<a name="line.259"></a>
+<span class="sourceLineNo">260</span> * <p/><a name="line.260"></a>
+<span class="sourceLineNo">261</span> * There are 3 LockState:<a name="line.261"></a>
+<span class="sourceLineNo">262</span> * <ul><a name="line.262"></a>
+<span class="sourceLineNo">263</span> * <li>LOCK_ACQUIRED should be returned when the proc has the lock and the proc is ready to<a name="line.263"></a>
+<span class="sourceLineNo">264</span> * execute.</li><a name="line.264"></a>
+<span class="sourceLineNo">265</span> * <li>LOCK_YIELD_WAIT should be returned when the proc has not the lock and the framework should<a name="line.265"></a>
+<span class="sourceLineNo">266</span> * take care of readding the procedure back to the runnable set for retry</li><a name="line.266"></a>
+<span class="sourceLineNo">267</span> * <li>LOCK_EVENT_WAIT should be returned when the proc has not the lock and someone will take<a name="line.267"></a>
+<span class="sourceLineNo">268</span> * care of readding the procedure back to the runnable set when the lock is available.</li><a name="line.268"></a>
+<span class="sourceLineNo">269</span> * </ul><a name="line.269"></a>
+<span class="sourceLineNo">270</span> * @return the lock state as described above.<a name="line.270"></a>
+<span class="sourceLineNo">271</span> */<a name="line.271"></a>
+<span class="sourceLineNo">272</span> protected LockState acquireLock(TEnvironment env) {<a name="line.272"></a>
+<span class="sourceLineNo">273</span> return LockState.LOCK_ACQUIRED;<a name="line.273"></a>
+<span class="sourceLineNo">274</span> }<a name="line.274"></a>
+<span class="sourceLineNo">275</span><a name="line.275"></a>
+<span class="sourceLineNo">276</span> /**<a name="line.276"></a>
+<span class="sourceLineNo">277</span> * The user should override this method, and release lock if necessary.<a name="line.277"></a>
+<span class="sourceLineNo">278</span> */<a name="line.278"></a>
+<span class="sourceLineNo">279</span> protected void releaseLock(TEnvironment env) {<a name="line.279"></a>
+<span class="sourceLineNo">280</span> // no-op<a name="line.280"></a>
+<span class="sourceLineNo">281</span> }<a name="line.281"></a>
+<span class="sourceLineNo">282</span><a name="line.282"></a>
+<span class="sourceLineNo">283</span> /**<a name="line.283"></a>
+<span class="sourceLineNo">284</span> * Used to keep the procedure lock even when the procedure is yielding or suspended.<a name="line.284"></a>
+<span class="sourceLineNo">285</span> * @return true if the procedure should hold on the lock until completionCleanup()<a name="line.285"></a>
+<span class="sourceLineNo">286</span> */<a name="line.286"></a>
+<span class="sourceLineNo">287</span> protected boolean holdLock(TEnvironment env) {<a name="line.287"></a>
+<span class="sourceLineNo">288</span> return false;<a name="line.288"></a>
+<span class="sourceLineNo">289</span> }<a name="line.289"></a>
+<span class="sourceLineNo">290</span><a name="line.290"></a>
+<span class="sourceLineNo">291</span> /**<a name="line.291"></a>
+<span class="sourceLineNo">292</span> * This is used in conjunction with {@link #holdLock(Object)}. If {@link #holdLock(Object)}<a name="line.292"></a>
+<span class="sourceLineNo">293</span> * returns true, the procedure executor will call acquireLock() once and thereafter<a name="line.293"></a>
+<span class="sourceLineNo">294</span> * not call {@link #releaseLock(Object)} until the Procedure is done (Normally, it calls<a name="line.294"></a>
+<span class="sourceLineNo">295</span> * release/acquire around each invocation of {@link #execute(Object)}.<a name="line.295"></a>
+<span class="sourceLineNo">296</span> * @see #holdLock(Object)<a name="line.296"></a>
+<span class="sourceLineNo">297</span> * @return true if the procedure has the lock, false otherwise.<a name="line.297"></a>
+<span class="sourceLineNo">298</span> */<a name="line.298"></a>
+<span class="sourceLineNo">299</span> protected final boolean hasLock() {<a name="line.299"></a>
+<span class="sourceLineNo">300</span> return locked;<a name="line.300"></a>
+<span class="sourceLineNo">301</span> }<a name="line.301"></a>
+<span class="sourceLineNo">302</span><a name="line.302"></a>
+<span class="sourceLineNo">303</span> /**<a name="line.303"></a>
+<span class="sourceLineNo">304</span> * Called when the procedure is loaded for replay.<a name="line.304"></a>
+<span class="sourceLineNo">305</span> * The procedure implementor may use this method to perform some quick<a name="line.305"></a>
+<span class="sourceLineNo">306</span> * operation before replay.<a name="line.306"></a>
+<span class="sourceLineNo">307</span> * e.g. failing the procedure if the state on replay may be unknown.<a name="line.307"></a>
+<span class="sourceLineNo">308</span> */<a name="line.308"></a>
+<span class="sourceLineNo">309</span> protected void beforeReplay(TEnvironment env) {<a name="line.309"></a>
+<span class="sourceLineNo">310</span> // no-op<a name="line.310"></a>
+<span class="sourceLineNo">311</span> }<a name="line.311"></a>
+<span class="sourceLineNo">312</span><a name="line.312"></a>
+<span class="sourceLineNo">313</span> /**<a name="line.313"></a>
+<span class="sourceLineNo">314</span> * Called when the procedure is ready to be added to the queue after<a name="line.314"></a>
+<span class="sourceLineNo">315</span> * the loading/replay operation.<a name="line.315"></a>
+<span class="sourceLineNo">316</span> */<a name="line.316"></a>
+<span class="sourceLineNo">317</span> protected void afterReplay(TEnvironment env) {<a name="line.317"></a>
+<span class="sourceLineNo">318</span> // no-op<a name="line.318"></a>
+<span class="sourceLineNo">319</span> }<a name="line.319"></a>
+<span class="sourceLineNo">320</span><a name="line.320"></a>
+<span class="sourceLineNo">321</span> /**<a name="line.321"></a>
+<span class="sourceLineNo">322</span> * Called when the procedure is marked as completed (success or rollback).<a name="line.322"></a>
+<span class="sourceLineNo">323</span> * The procedure implementor may use this method to cleanup in-memory states.<a name="line.323"></a>
+<span class="sourceLineNo">324</span> * This operation will not be retried on failure. If a procedure took a lock,<a name="line.324"></a>
+<span class="sourceLineNo">325</span> * it will have been released when this method runs.<a name="line.325"></a>
+<span class="sourceLineNo">326</span> */<a name="line.326"></a>
+<span class="sourceLineNo">327</span> protected void completionCleanup(TEnvironment env) {<a name="line.327"></a>
+<span class="sourceLineNo">328</span> // no-op<a name="line.328"></a>
+<span class="sourceLineNo">329</span> }<a name="line.329"></a>
+<span class="sourceLineNo">330</span><a name="line.330"></a>
+<span class="sourceLineNo">331</span> /**<a name="line.331"></a>
+<span class="sourceLineNo">332</span> * By default, the procedure framework/executor will try to run procedures start to finish.<a name="line.332"></a>
+<span class="sourceLineNo">333</span> * Return true to make the executor yield between each execution step to<a name="line.333"></a>
+<span class="sourceLineNo">334</span> * give other procedures a chance to run.<a name="line.334"></a>
+<span class="sourceLineNo">335</span> * @param env the environment passed to the ProcedureExecutor<a name="line.335"></a>
+<span class="sourceLineNo">336</span> * @return Return true if the executor should yield on completion of an execution step.<a name="line.336"></a>
+<span class="sourceLineNo">337</span> * Defaults to return false.<a name="line.337"></a>
+<span class="sourceLineNo">338</span> */<a name="line.338"></a>
+<span class="sourceLineNo">339</span> protected boolean isYieldAfterExecutionStep(TEnvironment env) {<a name="line.339"></a>
+<span class="sourceLineNo">340</span> return false;<a name="line.340"></a>
+<span class="sourceLineNo">341</span> }<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> * By default, the executor will keep the procedure result around util<a name="line.344"></a>
+<span class="sourceLineNo">345</span> * the eviction TTL is expired. The client can cut down the waiting time<a name="line.345"></a>
+<span class="sourceLineNo">346</span> * by requesting that the result is removed from the executor.<a name="line.346"></a>
+<span class="sourceLineNo">347</span> * In case of system started procedure, we can force the executor to auto-ack.<a name="line.347"></a>
+<span class="sourceLineNo">348</span> * @param env the environment passed to the ProcedureExecutor<a name="line.348"></a>
+<span class="sourceLineNo">349</span> * @return true if the executor should wait the client ack for the result.<a name="line.349"></a>
+<span class="sourceLineNo">350</span> * Defaults to return true.<a name="line.350"></a>
+<span class="sourceLineNo">351</span> */<a name="line.351"></a>
+<span class="sourceLineNo">352</span> protected boolean shouldWaitClientAck(TEnvironment env) {<a name="line.352"></a>
+<span class="sourceLineNo">353</span> return true;<a name="line.353"></a>
+<span class="sourceLineNo">354</span> }<a name="line.354"></a>
+<span class="sourceLineNo">355</span><a name="line.355"></a>
+<span class="sourceLineNo">356</span> /**<a name="line.356"></a>
+<span class="sourceLineNo">357</span> * Override this method to provide procedure specific counters for submitted count, failed<a name="line.357"></a>
+<span class="sourceLineNo">358</span> * count and time histogram.<a name="line.358"></a>
+<span class="sourceLineNo">359</span> * @param env The environment passed to the procedure executor<a name="line.359"></a>
+<span class="sourceLineNo">360</span> * @return Container object for procedure related metric<a name="line.360"></a>
+<span class="sourceLineNo">361</span> */<a name="line.361"></a>
+<span class="sourceLineNo">362</span> protected ProcedureMetrics getProcedureMetrics(TEnvironment env) {<a name="line.362"></a>
+<span class="sourceLineNo">363</span> return null;<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> /**<a name="line.366"></a>
+<span class="sourceLineNo">367</span> * This function will be called just when procedure is submitted for execution. Override this<a name="line.367"></a>
+<span class="sourceLineNo">368</span> * method to update the metrics at the beginning of the procedure. The default implementation<a name="line.368"></a>
+<span class="sourceLineNo">369</span> * updates submitted counter if {@link #getProcedureMetrics(Object)} returns non-null<a name="line.369"></a>
+<span class="sourceLineNo">370</span> * {@link ProcedureMetrics}.<a name="line.370"></a>
<span class="sourceLineNo">371</span> */<a name="line.371"></a>
-<span class="sourceLineNo">372</span> protected void updateMetricsOnFinish(TEnvironment env, long runtime, boolean success) {<a name="line.372"></a>
+<span class="sourceLineNo">372</span> protected void updateMetricsOnSubmit(TEnvironment env) {<a name="line.372"></a>
<span class="sourceLineNo">373</span> ProcedureMetrics metrics = getProcedureMetrics(env);<a name="line.373"></a>
<span class="sourceLineNo">374</span> if (metrics == null) {<a name="line.374"></a>
<span class="sourceLineNo">375</span> return;<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> if (success) {<a name="line.378"></a>
-<span class="sourceLineNo">379</span> Histogram timeHisto = metrics.getTimeHisto();<a name="line.379"></a>
-<span class="sourceLineNo">380</span> if (timeHisto != null) {<a name="line.380"></a>
-<span class="sourceLineNo">381</span> timeHisto.update(runtime);<a name="line.381"></a>
-<span class="sourceLineNo">382</span> }<a name="line.382"></a>
-<span class="sourceLineNo">383</span> } else {<a name="line.383"></a>
-<span class="sourceLineNo">384</span> Counter failedCounter = metrics.getFailedCounter();<a name="line.384"></a>
-<span class="sourceLineNo">385</span> if (failedCounter != null) {<a name="line.385"></a>
-<span class="sourceLineNo">386</span> failedCounter.increment();<a name="line.386"></a>
-<span class="sourceLineNo">387</span> }<a name="line.387"></a>
-<span class="sourceLineNo">388</span> }<a name="line.388"></a>
-<span class="sourceLineNo">389</span> }<a name="line.389"></a>
-<span class="sourceLineNo">390</span><a name="line.390"></a>
-<span class="sourceLineNo">391</span> @Override<a name="line.391"></a>
-<span class="sourceLineNo">392</span> public String toString() {<a name="line.392"></a>
-<span class="sourceLineNo">393</span> // Return the simple String presentation of the procedure.<a name="line.393"></a>
-<span class="sourceLineNo">394</span> return toStringSimpleSB().toString();<a name="line.394"></a>
-<span class="sourceLineNo">395</span> }<a name="line.395"></a>
-<span class="sourceLineNo">396</span><a name="line.396"></a>
-<span class="sourceLineNo">397</span> /**<a name="line.397"></a>
-<span class="sourceLineNo">398</span> * Build the StringBuilder for the simple form of procedure string.<a name="line.398"></a>
-<span class="sourceLineNo">399</span> * @return the StringBuilder<a name="line.399"></a>
-<span class="sourceLineNo">400</span> */<a name="line.400"></a>
-<span class="sourceLineNo">401</span> protected StringBuilder toStringSimpleSB() {<a name="line.401"></a>
-<span class="sourceLineNo">402</span> final StringBuilder sb = new StringBuilder();<a name="line.402"></a>
+<span class="sourceLineNo">378</span> Counter submittedCounter = metrics.getSubmittedCounter();<a name="line.378"></a>
+<span class="sourceLineNo">379</span> if (submittedCounter != null) {<a name="line.379"></a>
+<span class="sourceLineNo">380</span> submittedCounter.increment();<a name="line.380"></a>
+<span class="sourceLineNo">381</span> }<a name="line.381"></a>
+<span class="sourceLineNo">382</span> }<a name="line.382"></a>
+<span class="sourceLineNo">383</span><a name="line.383"></a>
+<span class="sourceLineNo">384</span> /**<a name="line.384"></a>
+<span class="sourceLineNo">385</span> * This function will be called just after procedure execution is finished. Override this method<a name="line.385"></a>
+<span class="sourceLineNo">386</span> * to update metrics at the end of the procedure. If {@link #getProcedureMetrics(Object)} returns<a name="line.386"></a>
+<span class="sourceLineNo">387</span> * non-null {@link ProcedureMetrics}, the default implementation adds runtime of a procedure to a<a name="line.387"></a>
+<span class="sourceLineNo">388</span> * time histogram for successfully completed procedures. Increments failed counter for failed<a name="line.388"></a>
+<span class="sourceLineNo">389</span> * procedures.<a name="line.389"></a>
+<span class="sourceLineNo">390</span> * <p/><a name="line.390"></a>
+<span class="sourceLineNo">391</span> * TODO: As any of the sub-procedures on failure rolls back all procedures in the stack, including<a name="line.391"></a>
+<span class="sourceLineNo">392</span> * successfully finished siblings, this function may get called twice in certain cases for certain<a name="line.392"></a>
+<span class="sourceLineNo">393</span> * procedures. Explore further if this can be called once.<a name="line.393"></a>
+<span class="sourceLineNo">394</span> * @param env The environment passed to the procedure executor<a name="line.394"></a>
+<span class="sourceLineNo">395</span> * @param runtime Runtime of the procedure in milliseconds<a name="line.395"></a>
+<span class="sourceLineNo">396</span> * @param success true if procedure is completed successfully<a name="line.396"></a>
+<span class="sourceLineNo">397</span> */<a name="line.397"></a>
+<span class="sourceLineNo">398</span> protected void updateMetricsOnFinish(TEnvironment env, long runtime, boolean success) {<a name="line.398"></a>
+<span class="sourceLineNo">399</span> ProcedureMetrics metrics = getProcedureMetrics(env);<a name="line.399"></a>
+<span class="sourceLineNo">400</span> if (metrics == null) {<a name="line.400"></a>
+<span class="sourceLineNo">401</span> return;<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> sb.append("pid=");<a name="line.404"></a>
-<span class="sourceLineNo">405</span> sb.append(getProcId());<a name="line.405"></a>
-<span class="sourceLineNo">406</span><a name="line.406"></a>
-<span class="sourceLineNo">407</span> if (hasParent()) {<a name="line.407"></a>
-<span class="sourceLineNo">408</span> sb.append(", ppid=");<a name="line.408"></a>
-<span class="sourceLineNo">409</span> sb.append(getParentProcId());<a name="line.409"></a>
-<span class="sourceLineNo">410</span> }<a name="line.410"></a>
-<span class="sourceLineNo">411</span><a name="line.411"></a>
-<span class="sourceLineNo">412</span> /**<a name="line.412"></a>
-<span class="sourceLineNo">413</span> * TODO<a name="line.413"></a>
-<span class="sourceLineNo">414</span> * Enable later when this is being used.<a name="line.414"></a>
-<span class="sourceLineNo">415</span> * Currently owner not used.<a name="line.415"></a>
-<span class="sourceLineNo">416</span> if (hasOwner()) {<a name="line.416"></a>
-<span class="sourceLineNo">417</span> sb.append(", owner=");<a name="line.417"></a>
-<span class="sourceLineNo">418</span> sb.append(getOwner());<a name="line.418"></a>
-<span class="sourceLineNo">419</span> }*/<a name="line.419"></a>
-<span class="sourceLineNo">420</span><a name="line.420"></a>
-<span class="sourceLineNo">421</span> sb.append(", state="); // pState for Procedure State as opposed to any other kind.<a name="line.421"></a>
-<span class="sourceLineNo">422</span> toStringState(sb);<a name="line.422"></a>
-<span class="sourceLineNo">423</span><a name="line.423"></a>
-<span class="sourceLineNo">424</span> sb.append(", hasLock=").append(locked);<a name="line.424"></a>
-<span class="sourceLineNo">425</span><a name="line.425"></a>
-<span class="sourceLineNo">426</span> if (hasException()) {<a name="line.426"></a>
-<span class="sourceLineNo">427</span> sb.append(", exception=" + getException());<a name="line.427"></a>
-<span class="sourceLineNo">428</span> }<a name="line.428"></a>
+<span class="sourceLineNo">404</span> if (success) {<a name="line.404"></a>
+<span class="sourceLineNo">405</span> Histogram timeHisto = metrics.getTimeHisto();<a name="line.405"></a>
+<span class="sourceLineNo">406</span> if (timeHisto != null) {<a name="line.406"></a>
+<span class="sourceLineNo">407</span> timeHisto.update(runtime);<a name="line.407"></a>
+<span class="sourceLineNo">408</span> }<a name="line.408"></a>
+<span class="sourceLineNo">409</span> } else {<a name="line.409"></a>
+<span class="sourceLineNo">410</span> Counter failedCounter = metrics.getFailedCounter();<a name="line.410"></a>
+<span class="sourceLineNo">411</span> if (failedCounter != null) {<a name="line.411"></a>
+<span class="sourceLineNo">412</span> failedCounter.increment();<a name="line.412"></a>
+<span class="sourceLineNo">413</span> }<a name="line.413"></a>
+<span class="sourceLineNo">414</span> }<a name="line.414"></a>
+<span class="sourceLineNo">415</span> }<a name="line.415"></a>
+<span class="sourceLineNo">416</span><a name="line.416"></a>
+<span class="sourceLineNo">417</span> @Override<a name="line.417"></a>
+<span class="sourceLineNo">418</span> public String toString() {<a name="line.418"></a>
+<span class="sourceLineNo">419</span> // Return the simple String presentation of the procedure.<a name="line.419"></a>
+<span class="sourceLineNo">420</span> return toStringSimpleSB().toString();<a name="line.420"></a>
+<span class="sourceLineNo">421</span> }<a name="line.421"></a>
+<span class="sourceLineNo">422</span><a name="line.422"></a>
+<span class="sourceLineNo">423</span> /**<a name="line.423"></a>
+<span class="sourceLineNo">424</span> * Build the StringBuilder for the simple form of procedure string.<a name="line.424"></a>
+<span class="sourceLineNo">425</span> * @return the StringBuilder<a name="line.425"></a>
+<span class="sourceLineNo">426</span> */<a name="line.426"></a>
+<span class="sourceLineNo">427</span> protected StringBuilder toStringSimpleSB() {<a name="line.427"></a>
+<span class="sourceLineNo">428</span> final StringBuilder sb = new StringBuilder();<a name="line.428"></a>
<span class="sourceLineNo">429</span><a name="line.429"></a>
-<span class="sourceLineNo">430</span> sb.append("; ");<a name="line.430"></a>
-<span class="sourceLineNo">431</span> toStringClassDetails(sb);<a name="line.431"></a>
+<span class="sourceLineNo">430</span> sb.append("pid=");<a name="line.430"></a>
+<span class="sourceLineNo">431</span> sb.append(getProcId());<a name="line.431"></a>
<span class="sourceLineNo">432</span><a name="line.432"></a>
-<span class="sourceLineNo">433</span> return sb;<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> * Extend the toString() information with more procedure details<a name="line.437"></a>
-<span class="sourceLineNo">438</span> */<a name="line.438"></a>
-<span class="sourceLineNo">439</span> public String toStringDetails() {<a name="line.439"></a>
-<span class="sourceLineNo">440</span> final StringBuilder sb = toStringSimpleSB();<a name="line.440"></a>
-<span class="sourceLineNo">441</span><a name="line.441"></a>
-<span class="sourceLineNo">442</span> sb.append(" submittedTime=");<a name="line.442"></a>
-<span class="sourceLineNo">443</span> sb.append(getSubmittedTime());<a name="line.443"></a>
-<span class="sourceLineNo">444</span><a name="line.444"></a>
-<span class="sourceLineNo">445</span> sb.append(", lastUpdate=");<a name="line.445"></a>
-<span class="sourceLineNo">446</span> sb.append(getLastUpdate());<a name="line.446"></a>
-<span class="sourceLineNo">447</span><a name="line.447"></a>
-<span class="sourceLineNo">448</span> final int[] stackIndices = getStackIndexes();<a name="line.448"></a>
-<span class="sourceLineNo">449</span> if (stackIndices != null) {<a name="line.449"></a>
-<span class="sourceLineNo">450</span> sb.append("\n");<a name="line.450"></a>
-<span class="sourceLineNo">451</span> sb.append("stackIndexes=");<a name="line.451"></a>
-<span class="sourceLineNo">452</span> sb.append(Arrays.toString(stackIndices));<a name="line.452"></a>
-<span class="sourceLineNo">453</span> }<a name="line.453"></a>
-<span class="sourceLineNo">454</span><a name="line.454"></a>
-<span class="sourceLineNo">455</span> return sb.toString();<a name="line.455"></a>
-<span class="sourceLineNo">456</span> }<a name="line.456"></a>
-<span class="sourceLineNo">457</span><a name="line.457"></a>
-<span class="sourceLineNo">458</span> protected String toStringClass() {<a name="line.458"></a>
-<span class="sourceLineNo">459</span> StringBuilder sb = new StringBuilder();<a name="line.459"></a>
-<span class="sourceLineNo">460</span> toStringClassDetails(sb);<a name="line.460"></a>
-<span class="sourceLineNo">461</span> return sb.toString();<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> /**<a name="line.464"></a>
-<span class="sourceLineNo">465</span> * Called from {@link #toString()} when interpolating {@link Procedure} State. Allows decorating<a name="line.465"></a>
-<span class="sourceLineNo">466</span> * generic Procedure State with Procedure particulars.<a name="line.466"></a>
-<span class="sourceLineNo">467</span> * @param builder Append current {@link ProcedureState}<a name="line.467"></a>
+<span class="sourceLineNo">433</span> if (hasParent()) {<a name="line.433"></a>
+<span class="sourceLineNo">434</span> sb.append(", ppid=");<a name="line.434"></a>
+<span class="sourceLineNo">435</span> sb.append(getParentProcId());<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> /**<a name="line.438"></a>
+<span class="sourceLineNo">439</span> * TODO<a name="line.439"></a>
+<span class="sourceLineNo">440</span> * Enable later when this is being used.<a name="line.440"></a>
+<span class="sourceLineNo">441</span> * Currently owner not used.<a name="line.441"></a>
+<span class="sourceLineNo">442</span> if (hasOwner()) {<a name="line.442"></a>
+<span class="sourceLineNo">443</span> sb.append(", owner=");<a name="line.443"></a>
+<span class="sourceLineNo">444</span> sb.append(getOwner());<a name="line.444"></a>
+<span class="sourceLineNo">445</span> }*/<a name="line.445"></a>
+<span class="sourceLineNo">446</span><a name="line.446"></a>
+<span class="sourceLineNo">447</span> sb.append(", state="); // pState for Procedure State as opposed to any other kind.<a name="line.447"></a>
+<span class="sourceLineNo">448</span> toStringState(sb);<a name="line.448"></a>
+<span class="sourceLineNo">449</span><a name="line.449"></a>
+<span class="sourceLineNo">450</span> sb.append(", hasLock=").append(locked);<a name="line.450"></a>
+<span class="sourceLineNo">451</span><a name="line.451"></a>
+<span class="sourceLineNo">452</span> if (bypass) {<a name="line.452"></a>
+<span class="sourceLineNo">453</span> sb.append(", bypass=").append(bypass);<a name="line.453"></a>
+<span class="sourceLineNo">454</span> }<a name="line.454"></a>
+<span class="sourceLineNo">455</span><a name="line.455"></a>
+<span class="sourceLineNo">456</span> if (hasException()) {<a name="line.456"></a>
+<span class="sourceLineNo">457</span> sb.append(", exception=" + getException());<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> sb.append("; ");<a name="line.460"></a>
+<span class="sourceLineNo">461</span> toStringClassDetails(sb);<a name="line.461"></a>
+<span class="sourceLineNo">462</span><a name="line.462"></a>
+<span class="sourceLineNo">463</span> return sb;<a name="line.463"></a>
+<span class="sourceLineNo">464</span> }<a name="line.464"></a>
+<span class="sourceLineNo">465</span><a name="line.465"></a>
+<span class="sourceLineNo">466</span> /**<a name="line.466"></a>
+<span class="sourceLineNo">467</span> * Extend the toString() information with more procedure details<a name="line.467"></a>
<span class="sourceLineNo">468</span> */<a name="line.468"></a>
-<span class="sourceLineNo">469</span> protected void toStringState(StringBuilder builder) {<a name="line.469"></a>
-<span class="sourceLineNo">470</span> builder.append(getState());<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> /**<a name="line.473"></a>
-<span class="sourceLineNo">474</span> * Extend the toString() information with the procedure details<a name="line.474"></a>
-<span class="sourceLineNo">475</span> * e.g. className and parameters<a name="line.475"></a>
-<span class="sourceLineNo">476</span> * @param builder the string builder to use to append the proc specific information<a name="line.476"></a>
-<span class="sourceLineNo">477</span> */<a name="line.477"></a>
-<span class="sourceLineNo">478</span> protected void toStringClassDetails(StringBuilder builder) {<a name="line.478"></a>
-<span class="sourceLineNo">479</span> builder.append(getClass().getName());<a name="line.479"></a>
-<span class="sourceLineNo">480</span> }<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> // Those fields are unchanged after initialization.<a name="line.483"></a>
-<span class="sourceLineNo">484</span> //<a name="line.484"></a>
-<span class="sourceLineNo">485</span> // Each procedure will get created from the user or during<a name="line.485"></a>
-<span class="sourceLineNo">486</span> // ProcedureExecutor.start() during the load() phase and then submitted<a name="line.486"></a>
-<span class="sourceLineNo">487</span> // to the executor. these fields will never be changed after initialization<a name="line.487"></a>
-<span class="sourceLineNo">488</span> // ==========================================================================<a name="line.488"></a>
-<span class="sourceLineNo">489</span> public long getProcId() {<a name="line.489"></a>
-<span class="sourceLineNo">490</span> return procId;<a name="line.490"></a>
-<span class="sourceLineNo">491</span> }<a name="line.491"></a>
-<span class="sourceLineNo">492</span><a name="line.492"></a>
-<span class="sourceLineNo">493</span> public boolean hasParent() {<a name="line.493"></a>
-<span class="sourceLineNo">494</span> return parentProcId != NO_PROC_ID;<a name="line.494"></a>
-<span class="sourceLineNo">495</span> }<a name="line.495"></a>
-<span class="sourceLineNo">496</span><a name="line.496"></a>
-<span class="sourceLineNo">497</span> public long getParentProcId() {<a name="line.497"></a>
-<span class="sourceLineNo">498</span> return parentProcId;<a name="line.498"></a>
-<span class="sourceLineNo">499</span> }<a name="line.499"></a>
-<span class="sourceLineNo">500</span><a name="line.500"></a>
-<span class="sourceLineNo">501</span> public long getRootProcId() {<a name="line.501"></a>
-<span class="sourceLineNo">502</span> return rootProcId;<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> public String getProcName() {<a name="line.505"></a>
-<span class="sourceLineNo">506</span> return toStringClass();<a name="line.506"></a>
-<span class="sourceLineNo">507</span> }<a name="line.507"></a>
-<span class="sourceLineNo">508</span><a name="line.508"></a>
-<span class="sourceLineNo">509</span> public NonceKey getNonceKey() {<a name="line.509"></a>
-<span class="sourceLineNo">510</span> return nonceKey;<a name="line.510"></a>
-<span class="sourceLineNo">511</span> }<a name="line.511"></a>
-<span class="sourceLineNo">512</span><a name="line.512"></a>
-<span class="sourceLineNo">513</span> public long getSubmittedTime() {<a name="line.513"></a>
-<span class="sourceLineNo">514</span> return submittedTime;<a name="line.514"></a>
-<span class="sourceLineNo">515</span> }<a name="line.515"></a>
-<span class="sourceLineNo">516</span><a name="line.516"></a>
-<span class="sourceLineNo">517</span> public String getOwner() {<a name="line.517"></a>
-<span class="sourceLineNo">518</span> return owner;<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> public boolean hasOwner() {<a name="line.521"></a>
-<span class="sourceLineNo">522</span> return owner != null;<a name="line.522"></a>
-<span class="sourceLineNo">523</span> }<a name="line.523"></a>
-<span class="sourceLineNo">524</span><a name="line.524"></a>
-<span class="sourceLineNo">525</span> /**<a name="line.525"></a>
-<span class="sourceLineNo">526</span> * Called by the ProcedureExecutor to assign the ID to the newly created procedure.<a name="line.526"></a>
-<span class="sourceLineNo">527</span> */<a name="line.527"></a>
-<span class="sourceLineNo">528</span> @VisibleForTesting<a name="line.528"></a>
-<span class="sourceLineNo">529</span> protected void setProcId(long procId) {<a name="line.529"></a>
-<span class="sourceLineNo">530</span> this.procId = procId;<a name="line.530"></a>
-<span class="sourceLineNo">531</span> this.submittedTime = EnvironmentEdgeManager.currentTime();<a name="line.531"></a>
-<span class="sourceLineNo">532</span> setState(ProcedureState.RUNNABLE);<a name="line.532"></a>
+<span class="sourceLineNo">469</span> public String toStringDetails() {<a name="line.469"></a>
+<span class="sourceLineNo">470</span> final StringBuilder sb = toStringSimpleSB();<a name="line.470"></a>
+<span class="sourceLineNo">471</span><a name="line.471"></a>
+<span class="sourceLineNo">472</span> sb.append(" submittedTime=");<a name="line.472"></a>
+<span class="sourceLineNo">473</span> sb.append(getSubmittedTime());<a name="line.473"></a>
+<span class="sourceLineNo">474</span><a name="line.474"></a>
+<span class="sourceLineNo">475</span> sb.append(", lastUpdate=");<a name="line.475"></a>
+<span class="sourceLineNo">476</span> sb.append(getLastUpdate());<a name="line.476"></a>
+<span class="sourceLineNo">477</span><a name="line.477"></a>
+<span class="sourceLineNo">478</span> final int[] stackIndices = getStackIndexes();<a name="line.478"></a>
+<span class="sourceLineNo">479</span> if (stackIndices != null) {<a name="line.479"></a>
+<span class="sourceLineNo">480</span> sb.append("\n");<a name="line.480"></a>
+<span class="sourceLineNo">481</span> sb.append("stackIndexes=");<a name="line.481"></a>
+<span class="sourceLineNo">482</span> sb.append(Arrays.toString(stackIndices));<a name="line.482"></a>
+<span class="sourceLineNo">483</span> }<a name="line.483"></a>
+<span class="sourceLineNo">484</span><a name="line.484"></a>
+<span class="sourceLineNo">485</span> return sb.toString();<a name="line.485"></a>
+<span class="sourceLineNo">486</span> }<a name="line.486"></a>
+<span class="sourceLineNo">487</span><a name="line.487"></a>
+<span class="sourceLineNo">488</span> protected String toStringClass() {<a name="line.488"></a>
+<span class="sourceLineNo">489</span> StringBuilder sb = new StringBuilder();<a name="line.489"></a>
+<span class="sourceLineNo">490</span> toStringClassDetails(sb);<a name="line.490"></a>
+<span class="sourceLineNo">491</span> return sb.toString();<a name="line.491"></a>
+<span class="sourceLineNo">492</span> }<a name="line.492"></a>
+<span class="sourceLineNo">493</span><a name="line.493"></a>
+<span class="sourceLineNo">494</span> /**<a name="line.494"></a>
+<span class="sourceLineNo">495</span> * Called from {@link #toString()} when interpolating {@link Procedure} State. Allows decorating<a name="line.495"></a>
+<span class="sourceLineNo">496</span> * generic Procedure State with Procedure particulars.<a name="line.496"></a>
+<span class="sourceLineNo">497</span> * @param builder Append current {@link ProcedureState}<a name="line.497"></a>
+<span class="sourceLineNo">498</span> */<a name="line.498"></a>
+<span class="sourceLineNo">499</span> protected void toStringState(StringBuilder builder) {<a name="line.499"></a>
+<span class="sourceLineNo">500</span> builder.append(getState());<a name="line.500"></a>
+<span class="sourceLineNo">501</span> }<a name="line.501"></a>
+<span class="sourceLineNo">502</span><a name="line.502"></a>
+<span class="sourceLineNo">503</span> /**<a name="line.503"></a>
+<span class="sourceLineNo">504</span> * Extend the toString() information with the procedure details<a name="line.504"></a>
+<span class="sourceLineNo">505</span> * e.g. className and parameters<a name="line.505"></a>
+<span class="sourceLineNo">506</span> * @param builder the string builder to use to append the proc specific information<a name="line.506"></a>
+<span class="sourceLineNo">507</span> */<a name="line.507"></a>
+<span class="sourceLineNo">508</span> protected void toStringClassDetails(StringBuilder builder) {<a name="line.508"></a>
+<span class="sourceLineNo">509</span> builder.append(getClass().getName());<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> // ==========================================================================<a name="line.512"></a>
+<span class="sourceLineNo">513</span> // Those fields are unchanged after initialization.<a name="line.513"></a>
+<span class="sourceLineNo">514</span> //<a name="line.514"></a>
+<span class="sourceLineNo">515</span> // Each procedure will get created from the user or during<a name="line.515"></a>
+<span class="sourceLineNo">516</span> // ProcedureExecutor.start() during the load() phase and then submitted<a name="line.516"></a>
+<span class="sourceLineNo">517</span> // to the executor. these fields will never be changed after initialization<a name="line.517"></a>
+<span class="sourceLineNo">518</span> // ==========================================================================<a name="line.518"></a>
+<span class="sourceLineNo">519</span> public long getProcId() {<a name="line.519"></a>
+<span class="sourceLineNo">520</span> return procId;<a name="line.520"></a>
+<span class="sourceLineNo">521</span> }<a name="line.521"></a>
+<span class="sourceLineNo">522</span><a name="line.522"></a>
+<span class="sourceLineNo">523</span> public boolean hasParent() {<a name="line.523"></a>
+<span class="sourceLineNo">524</span> return parentProcId != NO_PROC_ID;<a name="line.524"></a>
+<span class="sourceLineNo">525</span> }<a name="line.525"></a>
+<span class="sourceLineNo">526</span><a name="line.526"></a>
+<span class="sourceLineNo">527</span> public long getParentProcId() {<a name="line.527"></a>
+<span class="sourceLineNo">528</span> return parentProcId;<a name="line.528"></a>
+<span class="sourceLineNo">529</span> }<a name="line.529"></a>
+<span class="sourceLineNo">530</span><a name="line.530"></a>
+<span class="sourceLineNo">531</span> public long getRootProcId() {<a name="line.531"></a>
+<span class="sourceLineNo">532</span> return rootProcId;<a name="line.532"></a>
<span class="sourceLineNo">533</span> }<a name="line.533"></a>
<span class="sourceLineNo">534</span><a name="line.534"></a>
-<span class="sourceLineNo">535</span> /**<a name="line.535"></a>
-<span class="sourceLineNo">536</span> * Called by the ProcedureExecutor to assign the parent to the newly created procedure.<a name="line.536"></a>
-<span class="sourceLineNo">537</span> */<a name="line.537"></a>
-<span class="sourceLineNo">538</span> protected void setParentProcId(long parentProcId) {<a name="line.538"></a>
-<span class="sourceLineNo">539</span> this.parentProcId = parentProcId;<a name="line.539"></a>
-<span class="sourceLineNo">540</span> }<a name="line.540"></a>
-<span class="sourceLineNo">541</span><a name="line.541"></a>
-<span class="sourceLineNo">542</span> protected void setRootProcId(long rootProcId) {<a name="line.542"></a>
-<span class="sourceLineNo">543</span> this.rootProcId = rootProcId;<a name="line.543"></a>
-<span class="sourceLineNo">544</span> }<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> * Called by the ProcedureExecutor to set the value to the newly created procedure.<a name="line.547"></a>
-<span class="sourceLineNo">548</span> */<a name="line.548"></a>
-<span class="sourceLineNo">549</span> @VisibleForTesting<a name="line.549"></a>
-<span class="sourceLineNo">550</span> protected void setNonceKey(NonceKey nonceKey) {<a name="line.550"></a>
-<span class="sourceLineNo">551</span> this.nonceKey = nonceKey;<a name="line.551"></a>
-<span class="sourceLineNo">552</span> }<a name="line.552"></a>
-<span class="sourceLineNo">553</span><a name="line.553"></a>
-<span class="sourceLineNo">554</span> @VisibleForTesting<a name="line.554"></a>
-<span class="sourceLineNo">555</span> public void setOwner(String owner) {<a name="line.555"></a>
-<span class="sourceLineNo">556</span> this.owner = StringUtils.isEmpty(owner) ? null : owner;<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 void setOwner(User owner) {<a name="line.559"></a>
-<span class="sourceLineNo">560</span> assert owner != null : "expected owner to be not null";<a name="line.560"></a>
-<span class="sourceLineNo">561</span> setOwner(owner.getShortName());<a name="line.561"></a>
-<span class="sourceLineNo">562</span> }<a name="line.562"></a>
-<span class="sourceLineNo">563</span><a name="line.563"></a>
-<span class="sourceLineNo">564</span> /**<a name="line.564"></a>
-<span class="sourceLineNo">565</span> * Called on store load to initialize the Procedure internals after<a name="line.565"></a>
-<span class="sourceLineNo">566</span> * the creation/deserialization.<a name="line.566"></a>
+<span class="sourceLineNo">535</span> public String getProcName() {<a name="line.535"></a>
+<span class="sourceLineNo">536</span> return toStringClass();<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 NonceKey getNonceKey() {<a name="line.539"></a>
+<span class="sourceLineNo">540</span> return nonceKey;<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 getSubmittedTime() {<a name="line.543"></a>
+<span class="sourceLineNo">544</span> return submittedTime;<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 String getOwner() {<a name="line.547"></a>
+<span class="sourceLineNo">548</span> return owner;<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 boolean hasOwner() {<a name="line.551"></a>
+<span class="sourceLineNo">552</span> return owner != null;<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> /**<a name="line.555"></a>
+<span class="sourceLineNo">556</span> * Called by the ProcedureExecutor to assign the ID to the newly created procedure.<a name="line.556"></a>
+<span class="sourceLineNo">557</span> */<a name="line.557"></a>
+<span class="sourceLineNo">558</span> @VisibleForTesting<a name="line.558"></a>
+<span class="sourceLineNo">559</span> protected void setProcId(long procId) {<a name="line.559"></a>
+<span class="sourceLineNo">560</span> this.procId = procId;<a name="line.560"></a>
+<span class="sourceLineNo">561</span> this.submittedTime = EnvironmentEdgeManager.currentTime();<a name="line.561"></a>
+<span class="sourceLineNo">562</span> setState(ProcedureState.RUNNABLE);<a name="line.562"></a>
+<span class="sourceLineNo">563</span> }<a name="line.563"></a>
+<span class="sourceLineNo">564</span><a name="line.564"></a>
+<span class="sourceLineNo">565</span> /**<a name="line.565"></a>
+<span class="sourceLineNo">566</span> * Called by the ProcedureExecutor to assign the parent to the newly created procedure.<a name="line.566"></a>
<span class="sourceLineNo">567</span> */<a name="line.567"></a>
-<span class="sourceLineNo">568</span> protected void setSubmittedTime(long submittedTime) {<a name="line.568"></a>
-<span class="sourceLineNo">569</span> this.submittedTime = submittedTime;<a name="line.569"></a>
+<span class="sourceLineNo">568</span> protected void setParentProcId(long parentProcId) {<a name="line.568"></a>
+<span class="sourceLineNo">569</span> this.parentProcId = parentProcId;<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> // ==========================================================================<a name="line.572"></a>
-<span class="sourceLineNo">573</span> // runtime state - timeout related<a name="line.573"></a>
-<span class="sourceLineNo">574</span> // ==========================================================================<a name="line.574"></a>
-<span class="sourceLineNo">575</span> /**<a name="line.575"></a>
-<span class="sourceLineNo">576</span> * @param timeout timeout interval in msec<a name="line.576"></a>
-<span class="sourceLineNo">577</span> */<a name="line.577"></a>
-<span class="sourceLineNo">578</span> protected void setTimeout(int timeout) {<a name="line.578"></a>
-<span class="sourceLineNo">579</span> this.timeout = timeout;<a name="line.579"></a>
-<span class="sourceLineNo">580</span> }<a name="line.580"></a>
-<span class="sourceLineNo">581</span><a name="line.581"></a>
-<span class="sourceLineNo">582</span> public boolean hasTimeout() {<a name="line.582"></a>
-<span class="sourceLineNo">583</span> return timeout != NO_TIMEOUT;<a name="line.583"></a>
-<span class="sourceLineNo">584</span> }<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> * @return the timeout in msec<a name="line.587"></a>
-<span class="sourceLineNo">588</span> */<a name="line.588"></a>
-<span class="sourceLineNo">589</span> public int getTimeout() {<a name="line.589"></a>
-<span class="sourceLineNo">590</span> return timeout;<a name="line.590"></a>
-<span class="sourceLineNo">591</span> }<a name="line.591"></a>
-<span class="sourceLineNo">592</span><a name="line.592"></a>
-<span class="sourceLineNo">593</span> /**<a name="line.593"></a>
-<span class="sourceLineNo">594</span> * Called on store load to initialize the Procedure internals after<a name="line.594"></a>
-<span class="sourceLineNo">595</span> * the creation/deserialization.<a name="line.595"></a>
-<span class="sourceLineNo">596</span> */<a name="line.596"></a>
-<span class="sourceLineNo">597</span> protected void setLastUpdate(long lastUpdate) {<a name="line.597"></a>
-<span class="sourceLineNo">598</span> this.lastUpdate = lastUpdate;<a name="line.598"></a>
-<span class="sourceLineNo">599</span> }<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> * Called by ProcedureExecutor after each time a procedure step is executed.<a name="line.602"></a>
-<span class="sourceLineNo">603</span> */<a name="line.603"></a>
-<span class="sourceLineNo">604</span> protected void updateTimestamp() {<a name="line.604"></a>
-<span class="sourceLineNo">605</span> this.lastUpdate = EnvironmentEdgeManager.currentTime();<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> public long getLastUpdate() {<a name="line.608"></a>
-<span class="sourceLineNo">609</span> return lastUpdate;<a name="line.609"></a>
+<span class="sourceLineNo">572</span> protected void setRootProcId(long rootProcId) {<a name="line.572"></a>
+<span class="sourceLineNo">573</span> this.rootProcId = rootProcId;<a name="line.573"></a>
+<span class="sourceLineNo">574</span> }<a name="line.574"></a>
+<span class="sourceLineNo">575</span><a name="line.575"></a>
+<span class="sourceLineNo">576</span> /**<a name="line.576"></a>
+<span class="sourceLineNo">577</span> * Called by the ProcedureExecutor to set the value to the newly created procedure.<a name="line.577"></a>
+<span class="sourceLineNo">578</span> */<a name="line.578"></a>
+<span class="sourceLineNo">579</span> @VisibleForTesting<a name="line.579"></a>
+<span class="sourceLineNo">580</span> protected void setNonceKey(NonceKey nonceKey) {<a name="line.580"></a>
+<span class="sourceLineNo">581</span> this.nonceKey = nonceKey;<a name="line.581"></a>
+<span class="sourceLineNo">582</span> }<a name="line.582"></a>
+<span class="sourceLineNo">583</span><a name="line.583"></a>
+<span class="sourceLineNo">584</span> @VisibleForTesting<a name="line.584"></a>
+<span class="sourceLineNo">585</span> public void setOwner(String owner) {<a name="line.585"></a>
+<span class="sourceLineNo">586</span> this.owner = StringUtils.isEmpty(owner) ? null : owner;<a name="line.586"></a>
+<span class="sourceLineNo">587</span> }<a name="line.587"></a>
+<span class="sourceLineNo">588</span><a name="line.588"></a>
+<span class="sourceLineNo">589</span> public void setOwner(User owner) {<a name="line.589"></a>
+<span class="sourceLineNo">590</span> assert owner != null : "expected owner to be not null";<a name="line.590"></a>
+<span class="sourceLineNo">591</span> setOwner(owner.getShortName());<a name="line.591"></a>
+<span class="sourceLineNo">592</span> }<a name="line.592"></a>
+<span class="sourceLineNo">593</span><a name="line.593"></a>
+<span class="sourceLineNo">594</span> /**<a name="line.594"></a>
+<span class="sourceLineNo">595</span> * Called on store load to initialize the Procedure internals after<a name="line.595"></a>
+<span class="sourceLineNo">596</span> * the creation/deserialization.<a name="line.596"></a>
+<span class="sourceLineNo">597</span> */<a name="line.597"></a>
+<span class="sourceLineNo">598</span> protected void setSubmittedTime(long submittedTime) {<a name="line.598"></a>
+<span class="sourceLineNo">599</span> this.submittedTime = submittedTime;<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> // ==========================================================================<a name="line.602"></a>
+<span class="sourceLineNo">603</span> // runtime state - timeout related<a name="line.603"></a>
+<span class="sourceLineNo">604</span> // ==========================================================================<a name="line.604"></a>
+<span class="sourceLineNo">605</span> /**<a name="line.605"></a>
+<span class="sourceLineNo">606</span> * @param timeout timeout interval in msec<a name="line.606"></a>
+<span class="sourceLineNo">607</span> */<a name="line.607"></a>
+<span class="sourceLineNo">608</span> protected void setTimeout(int timeout) {<a name="line.608"></a>
+<span class="sourceLineNo">609</span> this.timeout = timeout;<a name="line.609"></a>
<span class="sourceLineNo">610</span> }<a name="line.610"></a>
<span class="sourceLineNo">611</span><a name="line.611"></a>
-<span class="sourceLineNo">612</span> /**<a name="line.612"></a>
-<span class="sourceLineNo">613</span> * Timeout of the next timeout.<a name="line.613"></a>
-<span class="sourceLineNo">614</span> * Called by the ProcedureExecutor if the procedure has timeout set and<a name="line.614"></a>
-<span class="sourceLineNo">615</span> * the procedure is in the waiting queue.<a name="line.615"></a>
-<span class="sourceLineNo">616</span> * @return the timestamp of the next timeout.<a name="line.616"></a>
-<span class="sourceLineNo">617</span> */<a name="line.617"></a>
-<span class="sourceLine
<TRUNCATED>