http://git-wip-us.apache.org/repos/asf/hbase-site/blob/a949969b/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/Procedure.LockState.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/Procedure.LockState.html b/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/Procedure.LockState.html index 94f6ab6..d18d851 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/Procedure.LockState.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/procedure2/Procedure.LockState.html @@ -46,7 +46,7 @@ <span class="sourceLineNo">038</span><a name="line.38"></a> <span class="sourceLineNo">039</span>/**<a name="line.39"></a> <span class="sourceLineNo">040</span> * Base Procedure class responsible to handle the Procedure Metadata<a name="line.40"></a> -<span class="sourceLineNo">041</span> * e.g. state, startTime, lastUpdate, stack-indexes, ...<a name="line.41"></a> +<span class="sourceLineNo">041</span> * e.g. state, submittedTime, lastUpdate, stack-indexes, ...<a name="line.41"></a> <span class="sourceLineNo">042</span> *<a name="line.42"></a> <span class="sourceLineNo">043</span> * execute() is called each time the procedure is executed.<a name="line.43"></a> <span class="sourceLineNo">044</span> * it may be called multiple times in case of failure and restart, so the<a name="line.44"></a> @@ -81,7 +81,7 @@ <span class="sourceLineNo">073</span> private long parentProcId = NO_PROC_ID;<a name="line.73"></a> <span class="sourceLineNo">074</span> private long rootProcId = NO_PROC_ID;<a name="line.74"></a> <span class="sourceLineNo">075</span> private long procId = NO_PROC_ID;<a name="line.75"></a> -<span class="sourceLineNo">076</span> private long startTime;<a name="line.76"></a> +<span class="sourceLineNo">076</span> private long submittedTime;<a name="line.76"></a> <span class="sourceLineNo">077</span><a name="line.77"></a> <span class="sourceLineNo">078</span> // runtime state, updated every operation<a name="line.78"></a> <span class="sourceLineNo">079</span> private ProcedureState state = ProcedureState.INITIALIZING;<a name="line.79"></a> @@ -248,566 +248,587 @@ <span class="sourceLineNo">240</span> return true;<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> @Override<a name="line.243"></a> -<span class="sourceLineNo">244</span> public String toString() {<a name="line.244"></a> -<span class="sourceLineNo">245</span> // Return the simple String presentation of the procedure.<a name="line.245"></a> -<span class="sourceLineNo">246</span> return toStringSimpleSB().toString();<a name="line.246"></a> -<span class="sourceLineNo">247</span> }<a name="line.247"></a> +<span class="sourceLineNo">243</span> /**<a name="line.243"></a> +<span class="sourceLineNo">244</span> * This function will be called just when procedure is submitted for execution. Override this<a name="line.244"></a> +<span class="sourceLineNo">245</span> * method to update the metrics at the beginning of the procedure<a name="line.245"></a> +<span class="sourceLineNo">246</span> */<a name="line.246"></a> +<span class="sourceLineNo">247</span> protected void updateMetricsOnSubmit(final TEnvironment env) {}<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> * Build the StringBuilder for the simple form of<a name="line.250"></a> -<span class="sourceLineNo">251</span> * procedure string.<a name="line.251"></a> -<span class="sourceLineNo">252</span> * @return the StringBuilder<a name="line.252"></a> -<span class="sourceLineNo">253</span> */<a name="line.253"></a> -<span class="sourceLineNo">254</span> protected StringBuilder toStringSimpleSB() {<a name="line.254"></a> -<span class="sourceLineNo">255</span> final StringBuilder sb = new StringBuilder();<a name="line.255"></a> -<span class="sourceLineNo">256</span><a name="line.256"></a> -<span class="sourceLineNo">257</span> sb.append("procId=");<a name="line.257"></a> -<span class="sourceLineNo">258</span> sb.append(getProcId());<a name="line.258"></a> -<span class="sourceLineNo">259</span><a name="line.259"></a> -<span class="sourceLineNo">260</span> if (hasParent()) {<a name="line.260"></a> -<span class="sourceLineNo">261</span> sb.append(", parentProcId=");<a name="line.261"></a> -<span class="sourceLineNo">262</span> sb.append(getParentProcId());<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> if (hasOwner()) {<a name="line.265"></a> -<span class="sourceLineNo">266</span> sb.append(", owner=");<a name="line.266"></a> -<span class="sourceLineNo">267</span> sb.append(getOwner());<a name="line.267"></a> -<span class="sourceLineNo">268</span> }<a name="line.268"></a> +<span class="sourceLineNo">250</span> * This function will be called just after procedure execution is finished. Override this method<a name="line.250"></a> +<span class="sourceLineNo">251</span> * to update metrics at the end of the procedure<a name="line.251"></a> +<span class="sourceLineNo">252</span> *<a name="line.252"></a> +<span class="sourceLineNo">253</span> * TODO: As any of the sub-procedures on failure rolls back all procedures in the stack,<a name="line.253"></a> +<span class="sourceLineNo">254</span> * including successfully finished siblings, this function may get called twice in certain<a name="line.254"></a> +<span class="sourceLineNo">255</span> * cases for certain procedures. Explore further if this can be called once.<a name="line.255"></a> +<span class="sourceLineNo">256</span> *<a name="line.256"></a> +<span class="sourceLineNo">257</span> * @param env<a name="line.257"></a> +<span class="sourceLineNo">258</span> * @param runtime - Runtime of the procedure in milliseconds<a name="line.258"></a> +<span class="sourceLineNo">259</span> * @param success - true if procedure is completed successfully<a name="line.259"></a> +<span class="sourceLineNo">260</span> */<a name="line.260"></a> +<span class="sourceLineNo">261</span> protected void updateMetricsOnFinish(final TEnvironment env, final long runtime,<a name="line.261"></a> +<span class="sourceLineNo">262</span> boolean success) {}<a name="line.262"></a> +<span class="sourceLineNo">263</span><a name="line.263"></a> +<span class="sourceLineNo">264</span> @Override<a name="line.264"></a> +<span class="sourceLineNo">265</span> public String toString() {<a name="line.265"></a> +<span class="sourceLineNo">266</span> // Return the simple String presentation of the procedure.<a name="line.266"></a> +<span class="sourceLineNo">267</span> return toStringSimpleSB().toString();<a name="line.267"></a> +<span class="sourceLineNo">268</span> }<a name="line.268"></a> <span class="sourceLineNo">269</span><a name="line.269"></a> -<span class="sourceLineNo">270</span> sb.append(", state=");<a name="line.270"></a> -<span class="sourceLineNo">271</span> toStringState(sb);<a name="line.271"></a> -<span class="sourceLineNo">272</span><a name="line.272"></a> -<span class="sourceLineNo">273</span> if (hasException()) {<a name="line.273"></a> -<span class="sourceLineNo">274</span> sb.append(", exception=" + getException());<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> sb.append(", ");<a name="line.277"></a> -<span class="sourceLineNo">278</span> toStringClassDetails(sb);<a name="line.278"></a> -<span class="sourceLineNo">279</span><a name="line.279"></a> -<span class="sourceLineNo">280</span> return sb;<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> * Extend the toString() information with more procedure<a name="line.284"></a> -<span class="sourceLineNo">285</span> * details<a name="line.285"></a> -<span class="sourceLineNo">286</span> */<a name="line.286"></a> -<span class="sourceLineNo">287</span> public String toStringDetails() {<a name="line.287"></a> -<span class="sourceLineNo">288</span> final StringBuilder sb = toStringSimpleSB();<a name="line.288"></a> -<span class="sourceLineNo">289</span><a name="line.289"></a> -<span class="sourceLineNo">290</span> sb.append(" startTime=");<a name="line.290"></a> -<span class="sourceLineNo">291</span> sb.append(getStartTime());<a name="line.291"></a> -<span class="sourceLineNo">292</span><a name="line.292"></a> -<span class="sourceLineNo">293</span> sb.append(" lastUpdate=");<a name="line.293"></a> -<span class="sourceLineNo">294</span> sb.append(getLastUpdate());<a name="line.294"></a> -<span class="sourceLineNo">295</span><a name="line.295"></a> -<span class="sourceLineNo">296</span> final int[] stackIndices = getStackIndexes();<a name="line.296"></a> -<span class="sourceLineNo">297</span> if (stackIndices != null) {<a name="line.297"></a> -<span class="sourceLineNo">298</span> sb.append("\n");<a name="line.298"></a> -<span class="sourceLineNo">299</span> sb.append("stackIndexes=");<a name="line.299"></a> -<span class="sourceLineNo">300</span> sb.append(Arrays.toString(stackIndices));<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> return sb.toString();<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> protected String toStringClass() {<a name="line.306"></a> -<span class="sourceLineNo">307</span> StringBuilder sb = new StringBuilder();<a name="line.307"></a> -<span class="sourceLineNo">308</span> toStringClassDetails(sb);<a name="line.308"></a> -<span class="sourceLineNo">309</span> return sb.toString();<a name="line.309"></a> -<span class="sourceLineNo">310</span> }<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> * Called from {@link #toString()} when interpolating {@link Procedure} state<a name="line.313"></a> -<span class="sourceLineNo">314</span> * @param builder Append current {@link ProcedureState}<a name="line.314"></a> -<span class="sourceLineNo">315</span> */<a name="line.315"></a> -<span class="sourceLineNo">316</span> protected void toStringState(StringBuilder builder) {<a name="line.316"></a> -<span class="sourceLineNo">317</span> builder.append(getState());<a name="line.317"></a> -<span class="sourceLineNo">318</span> }<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> * Extend the toString() information with the procedure details<a name="line.321"></a> -<span class="sourceLineNo">322</span> * e.g. className and parameters<a name="line.322"></a> -<span class="sourceLineNo">323</span> * @param builder the string builder to use to append the proc specific information<a name="line.323"></a> -<span class="sourceLineNo">324</span> */<a name="line.324"></a> -<span class="sourceLineNo">325</span> protected void toStringClassDetails(StringBuilder builder) {<a name="line.325"></a> -<span class="sourceLineNo">326</span> builder.append(getClass().getName());<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> // ==========================================================================<a name="line.329"></a> -<span class="sourceLineNo">330</span> // Those fields are unchanged after initialization.<a name="line.330"></a> -<span class="sourceLineNo">331</span> //<a name="line.331"></a> -<span class="sourceLineNo">332</span> // Each procedure will get created from the user or during<a name="line.332"></a> -<span class="sourceLineNo">333</span> // ProcedureExecutor.start() during the load() phase and then submitted<a name="line.333"></a> -<span class="sourceLineNo">334</span> // to the executor. these fields will never be changed after initialization<a name="line.334"></a> -<span class="sourceLineNo">335</span> // ==========================================================================<a name="line.335"></a> -<span class="sourceLineNo">336</span> public long getProcId() {<a name="line.336"></a> -<span class="sourceLineNo">337</span> return procId;<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> public boolean hasParent() {<a name="line.340"></a> -<span class="sourceLineNo">341</span> return parentProcId != NO_PROC_ID;<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> public long getParentProcId() {<a name="line.344"></a> -<span class="sourceLineNo">345</span> return parentProcId;<a name="line.345"></a> -<span class="sourceLineNo">346</span> }<a name="line.346"></a> -<span class="sourceLineNo">347</span><a name="line.347"></a> -<span class="sourceLineNo">348</span> public long getRootProcId() {<a name="line.348"></a> -<span class="sourceLineNo">349</span> return rootProcId;<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> public NonceKey getNonceKey() {<a name="line.352"></a> -<span class="sourceLineNo">353</span> return nonceKey;<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> public long getStartTime() {<a name="line.356"></a> -<span class="sourceLineNo">357</span> return startTime;<a name="line.357"></a> -<span class="sourceLineNo">358</span> }<a name="line.358"></a> -<span class="sourceLineNo">359</span><a name="line.359"></a> -<span class="sourceLineNo">360</span> public String getOwner() {<a name="line.360"></a> -<span class="sourceLineNo">361</span> return owner;<a name="line.361"></a> -<span class="sourceLineNo">362</span> }<a name="line.362"></a> -<span class="sourceLineNo">363</span><a name="line.363"></a> -<span class="sourceLineNo">364</span> public boolean hasOwner() {<a name="line.364"></a> -<span class="sourceLineNo">365</span> return owner != null;<a name="line.365"></a> -<span class="sourceLineNo">366</span> }<a name="line.366"></a> -<span class="sourceLineNo">367</span><a name="line.367"></a> -<span class="sourceLineNo">368</span> /**<a name="line.368"></a> -<span class="sourceLineNo">369</span> * Called by the ProcedureExecutor to assign the ID to the newly created procedure.<a name="line.369"></a> -<span class="sourceLineNo">370</span> */<a name="line.370"></a> -<span class="sourceLineNo">371</span> @VisibleForTesting<a name="line.371"></a> -<span class="sourceLineNo">372</span> @InterfaceAudience.Private<a name="line.372"></a> -<span class="sourceLineNo">373</span> protected void setProcId(final long procId) {<a name="line.373"></a> -<span class="sourceLineNo">374</span> this.procId = procId;<a name="line.374"></a> -<span class="sourceLineNo">375</span> this.startTime = EnvironmentEdgeManager.currentTime();<a name="line.375"></a> -<span class="sourceLineNo">376</span> setState(ProcedureState.RUNNABLE);<a name="line.376"></a> -<span class="sourceLineNo">377</span> }<a name="line.377"></a> -<span class="sourceLineNo">378</span><a name="line.378"></a> -<span class="sourceLineNo">379</span> /**<a name="line.379"></a> -<span class="sourceLineNo">380</span> * Called by the ProcedureExecutor to assign the parent to the newly created procedure.<a name="line.380"></a> -<span class="sourceLineNo">381</span> */<a name="line.381"></a> -<span class="sourceLineNo">382</span> @InterfaceAudience.Private<a name="line.382"></a> -<span class="sourceLineNo">383</span> protected void setParentProcId(final long parentProcId) {<a name="line.383"></a> -<span class="sourceLineNo">384</span> this.parentProcId = parentProcId;<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> @InterfaceAudience.Private<a name="line.387"></a> -<span class="sourceLineNo">388</span> protected void setRootProcId(final long rootProcId) {<a name="line.388"></a> -<span class="sourceLineNo">389</span> this.rootProcId = rootProcId;<a name="line.389"></a> -<span class="sourceLineNo">390</span> }<a name="line.390"></a> -<span class="sourceLineNo">391</span><a name="line.391"></a> -<span class="sourceLineNo">392</span> /**<a name="line.392"></a> -<span class="sourceLineNo">393</span> * Called by the ProcedureExecutor to set the value to the newly created procedure.<a name="line.393"></a> -<span class="sourceLineNo">394</span> */<a name="line.394"></a> -<span class="sourceLineNo">395</span> @VisibleForTesting<a name="line.395"></a> -<span class="sourceLineNo">396</span> @InterfaceAudience.Private<a name="line.396"></a> -<span class="sourceLineNo">397</span> protected void setNonceKey(final NonceKey nonceKey) {<a name="line.397"></a> -<span class="sourceLineNo">398</span> this.nonceKey = nonceKey;<a name="line.398"></a> -<span class="sourceLineNo">399</span> }<a name="line.399"></a> -<span class="sourceLineNo">400</span><a name="line.400"></a> -<span class="sourceLineNo">401</span> @VisibleForTesting<a name="line.401"></a> -<span class="sourceLineNo">402</span> @InterfaceAudience.Private<a name="line.402"></a> -<span class="sourceLineNo">403</span> public void setOwner(final String owner) {<a name="line.403"></a> -<span class="sourceLineNo">404</span> this.owner = StringUtils.isEmpty(owner) ? null : owner;<a name="line.404"></a> -<span class="sourceLineNo">405</span> }<a name="line.405"></a> -<span class="sourceLineNo">406</span><a name="line.406"></a> -<span class="sourceLineNo">407</span> public void setOwner(final User owner) {<a name="line.407"></a> -<span class="sourceLineNo">408</span> assert owner != null : "expected owner to be not null";<a name="line.408"></a> -<span class="sourceLineNo">409</span> setOwner(owner.getShortName());<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> * Called on store load to initialize the Procedure internals after<a name="line.413"></a> -<span class="sourceLineNo">414</span> * the creation/deserialization.<a name="line.414"></a> +<span class="sourceLineNo">270</span> /**<a name="line.270"></a> +<span class="sourceLineNo">271</span> * Build the StringBuilder for the simple form of<a name="line.271"></a> +<span class="sourceLineNo">272</span> * procedure string.<a name="line.272"></a> +<span class="sourceLineNo">273</span> * @return the StringBuilder<a name="line.273"></a> +<span class="sourceLineNo">274</span> */<a name="line.274"></a> +<span class="sourceLineNo">275</span> protected StringBuilder toStringSimpleSB() {<a name="line.275"></a> +<span class="sourceLineNo">276</span> final StringBuilder sb = new StringBuilder();<a name="line.276"></a> +<span class="sourceLineNo">277</span><a name="line.277"></a> +<span class="sourceLineNo">278</span> sb.append("procId=");<a name="line.278"></a> +<span class="sourceLineNo">279</span> sb.append(getProcId());<a name="line.279"></a> +<span class="sourceLineNo">280</span><a name="line.280"></a> +<span class="sourceLineNo">281</span> if (hasParent()) {<a name="line.281"></a> +<span class="sourceLineNo">282</span> sb.append(", parentProcId=");<a name="line.282"></a> +<span class="sourceLineNo">283</span> sb.append(getParentProcId());<a name="line.283"></a> +<span class="sourceLineNo">284</span> }<a name="line.284"></a> +<span class="sourceLineNo">285</span><a name="line.285"></a> +<span class="sourceLineNo">286</span> if (hasOwner()) {<a name="line.286"></a> +<span class="sourceLineNo">287</span> sb.append(", owner=");<a name="line.287"></a> +<span class="sourceLineNo">288</span> sb.append(getOwner());<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> sb.append(", state=");<a name="line.291"></a> +<span class="sourceLineNo">292</span> toStringState(sb);<a name="line.292"></a> +<span class="sourceLineNo">293</span><a name="line.293"></a> +<span class="sourceLineNo">294</span> if (hasException()) {<a name="line.294"></a> +<span class="sourceLineNo">295</span> sb.append(", exception=" + getException());<a name="line.295"></a> +<span class="sourceLineNo">296</span> }<a name="line.296"></a> +<span class="sourceLineNo">297</span><a name="line.297"></a> +<span class="sourceLineNo">298</span> sb.append(", ");<a name="line.298"></a> +<span class="sourceLineNo">299</span> toStringClassDetails(sb);<a name="line.299"></a> +<span class="sourceLineNo">300</span><a name="line.300"></a> +<span class="sourceLineNo">301</span> return sb;<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> /**<a name="line.304"></a> +<span class="sourceLineNo">305</span> * Extend the toString() information with more procedure<a name="line.305"></a> +<span class="sourceLineNo">306</span> * details<a name="line.306"></a> +<span class="sourceLineNo">307</span> */<a name="line.307"></a> +<span class="sourceLineNo">308</span> public String toStringDetails() {<a name="line.308"></a> +<span class="sourceLineNo">309</span> final StringBuilder sb = toStringSimpleSB();<a name="line.309"></a> +<span class="sourceLineNo">310</span><a name="line.310"></a> +<span class="sourceLineNo">311</span> sb.append(" submittedTime=");<a name="line.311"></a> +<span class="sourceLineNo">312</span> sb.append(getSubmittedTime());<a name="line.312"></a> +<span class="sourceLineNo">313</span><a name="line.313"></a> +<span class="sourceLineNo">314</span> sb.append(" lastUpdate=");<a name="line.314"></a> +<span class="sourceLineNo">315</span> sb.append(getLastUpdate());<a name="line.315"></a> +<span class="sourceLineNo">316</span><a name="line.316"></a> +<span class="sourceLineNo">317</span> final int[] stackIndices = getStackIndexes();<a name="line.317"></a> +<span class="sourceLineNo">318</span> if (stackIndices != null) {<a name="line.318"></a> +<span class="sourceLineNo">319</span> sb.append("\n");<a name="line.319"></a> +<span class="sourceLineNo">320</span> sb.append("stackIndexes=");<a name="line.320"></a> +<span class="sourceLineNo">321</span> sb.append(Arrays.toString(stackIndices));<a name="line.321"></a> +<span class="sourceLineNo">322</span> }<a name="line.322"></a> +<span class="sourceLineNo">323</span><a name="line.323"></a> +<span class="sourceLineNo">324</span> return sb.toString();<a name="line.324"></a> +<span class="sourceLineNo">325</span> }<a name="line.325"></a> +<span class="sourceLineNo">326</span><a name="line.326"></a> +<span class="sourceLineNo">327</span> protected String toStringClass() {<a name="line.327"></a> +<span class="sourceLineNo">328</span> StringBuilder sb = new StringBuilder();<a name="line.328"></a> +<span class="sourceLineNo">329</span> toStringClassDetails(sb);<a name="line.329"></a> +<span class="sourceLineNo">330</span> return sb.toString();<a name="line.330"></a> +<span class="sourceLineNo">331</span> }<a name="line.331"></a> +<span class="sourceLineNo">332</span><a name="line.332"></a> +<span class="sourceLineNo">333</span> /**<a name="line.333"></a> +<span class="sourceLineNo">334</span> * Called from {@link #toString()} when interpolating {@link Procedure} state<a name="line.334"></a> +<span class="sourceLineNo">335</span> * @param builder Append current {@link ProcedureState}<a name="line.335"></a> +<span class="sourceLineNo">336</span> */<a name="line.336"></a> +<span class="sourceLineNo">337</span> protected void toStringState(StringBuilder builder) {<a name="line.337"></a> +<span class="sourceLineNo">338</span> builder.append(getState());<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> /**<a name="line.341"></a> +<span class="sourceLineNo">342</span> * Extend the toString() information with the procedure details<a name="line.342"></a> +<span class="sourceLineNo">343</span> * e.g. className and parameters<a name="line.343"></a> +<span class="sourceLineNo">344</span> * @param builder the string builder to use to append the proc specific information<a name="line.344"></a> +<span class="sourceLineNo">345</span> */<a name="line.345"></a> +<span class="sourceLineNo">346</span> protected void toStringClassDetails(StringBuilder builder) {<a name="line.346"></a> +<span class="sourceLineNo">347</span> builder.append(getClass().getName());<a name="line.347"></a> +<span class="sourceLineNo">348</span> }<a name="line.348"></a> +<span class="sourceLineNo">349</span><a name="line.349"></a> +<span class="sourceLineNo">350</span> // ==========================================================================<a name="line.350"></a> +<span class="sourceLineNo">351</span> // Those fields are unchanged after initialization.<a name="line.351"></a> +<span class="sourceLineNo">352</span> //<a name="line.352"></a> +<span class="sourceLineNo">353</span> // Each procedure will get created from the user or during<a name="line.353"></a> +<span class="sourceLineNo">354</span> // ProcedureExecutor.start() during the load() phase and then submitted<a name="line.354"></a> +<span class="sourceLineNo">355</span> // to the executor. these fields will never be changed after initialization<a name="line.355"></a> +<span class="sourceLineNo">356</span> // ==========================================================================<a name="line.356"></a> +<span class="sourceLineNo">357</span> public long getProcId() {<a name="line.357"></a> +<span class="sourceLineNo">358</span> return procId;<a name="line.358"></a> +<span class="sourceLineNo">359</span> }<a name="line.359"></a> +<span class="sourceLineNo">360</span><a name="line.360"></a> +<span class="sourceLineNo">361</span> public boolean hasParent() {<a name="line.361"></a> +<span class="sourceLineNo">362</span> return parentProcId != NO_PROC_ID;<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> public long getParentProcId() {<a name="line.365"></a> +<span class="sourceLineNo">366</span> return parentProcId;<a name="line.366"></a> +<span class="sourceLineNo">367</span> }<a name="line.367"></a> +<span class="sourceLineNo">368</span><a name="line.368"></a> +<span class="sourceLineNo">369</span> public long getRootProcId() {<a name="line.369"></a> +<span class="sourceLineNo">370</span> return rootProcId;<a name="line.370"></a> +<span class="sourceLineNo">371</span> }<a name="line.371"></a> +<span class="sourceLineNo">372</span><a name="line.372"></a> +<span class="sourceLineNo">373</span> public NonceKey getNonceKey() {<a name="line.373"></a> +<span class="sourceLineNo">374</span> return nonceKey;<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> public long getSubmittedTime() {<a name="line.377"></a> +<span class="sourceLineNo">378</span> return submittedTime;<a name="line.378"></a> +<span class="sourceLineNo">379</span> }<a name="line.379"></a> +<span class="sourceLineNo">380</span><a name="line.380"></a> +<span class="sourceLineNo">381</span> public String getOwner() {<a name="line.381"></a> +<span class="sourceLineNo">382</span> return owner;<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> public boolean hasOwner() {<a name="line.385"></a> +<span class="sourceLineNo">386</span> return owner != null;<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> * Called by the ProcedureExecutor to assign the ID to the newly created procedure.<a name="line.390"></a> +<span class="sourceLineNo">391</span> */<a name="line.391"></a> +<span class="sourceLineNo">392</span> @VisibleForTesting<a name="line.392"></a> +<span class="sourceLineNo">393</span> @InterfaceAudience.Private<a name="line.393"></a> +<span class="sourceLineNo">394</span> protected void setProcId(final long procId) {<a name="line.394"></a> +<span class="sourceLineNo">395</span> this.procId = procId;<a name="line.395"></a> +<span class="sourceLineNo">396</span> this.submittedTime = EnvironmentEdgeManager.currentTime();<a name="line.396"></a> +<span class="sourceLineNo">397</span> setState(ProcedureState.RUNNABLE);<a name="line.397"></a> +<span class="sourceLineNo">398</span> }<a name="line.398"></a> +<span class="sourceLineNo">399</span><a name="line.399"></a> +<span class="sourceLineNo">400</span> /**<a name="line.400"></a> +<span class="sourceLineNo">401</span> * Called by the ProcedureExecutor to assign the parent to the newly created procedure.<a name="line.401"></a> +<span class="sourceLineNo">402</span> */<a name="line.402"></a> +<span class="sourceLineNo">403</span> @InterfaceAudience.Private<a name="line.403"></a> +<span class="sourceLineNo">404</span> protected void setParentProcId(final long parentProcId) {<a name="line.404"></a> +<span class="sourceLineNo">405</span> this.parentProcId = parentProcId;<a name="line.405"></a> +<span class="sourceLineNo">406</span> }<a name="line.406"></a> +<span class="sourceLineNo">407</span><a name="line.407"></a> +<span class="sourceLineNo">408</span> @InterfaceAudience.Private<a name="line.408"></a> +<span class="sourceLineNo">409</span> protected void setRootProcId(final long rootProcId) {<a name="line.409"></a> +<span class="sourceLineNo">410</span> this.rootProcId = rootProcId;<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> /**<a name="line.413"></a> +<span class="sourceLineNo">414</span> * Called by the ProcedureExecutor to set the value to the newly created procedure.<a name="line.414"></a> <span class="sourceLineNo">415</span> */<a name="line.415"></a> -<span class="sourceLineNo">416</span> @InterfaceAudience.Private<a name="line.416"></a> -<span class="sourceLineNo">417</span> protected void setStartTime(final long startTime) {<a name="line.417"></a> -<span class="sourceLineNo">418</span> this.startTime = startTime;<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> // ==========================================================================<a name="line.421"></a> -<span class="sourceLineNo">422</span> // runtime state - timeout related<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> * @param timeout timeout interval in msec<a name="line.425"></a> -<span class="sourceLineNo">426</span> */<a name="line.426"></a> -<span class="sourceLineNo">427</span> protected void setTimeout(final int timeout) {<a name="line.427"></a> -<span class="sourceLineNo">428</span> this.timeout = timeout;<a name="line.428"></a> -<span class="sourceLineNo">429</span> }<a name="line.429"></a> -<span class="sourceLineNo">430</span><a name="line.430"></a> -<span class="sourceLineNo">431</span> public boolean hasTimeout() {<a name="line.431"></a> -<span class="sourceLineNo">432</span> return timeout != NO_TIMEOUT;<a name="line.432"></a> -<span class="sourceLineNo">433</span> }<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> * @return the timeout in msec<a name="line.436"></a> -<span class="sourceLineNo">437</span> */<a name="line.437"></a> -<span class="sourceLineNo">438</span> public int getTimeout() {<a name="line.438"></a> -<span class="sourceLineNo">439</span> return timeout;<a name="line.439"></a> +<span class="sourceLineNo">416</span> @VisibleForTesting<a name="line.416"></a> +<span class="sourceLineNo">417</span> @InterfaceAudience.Private<a name="line.417"></a> +<span class="sourceLineNo">418</span> protected void setNonceKey(final NonceKey nonceKey) {<a name="line.418"></a> +<span class="sourceLineNo">419</span> this.nonceKey = nonceKey;<a name="line.419"></a> +<span class="sourceLineNo">420</span> }<a name="line.420"></a> +<span class="sourceLineNo">421</span><a name="line.421"></a> +<span class="sourceLineNo">422</span> @VisibleForTesting<a name="line.422"></a> +<span class="sourceLineNo">423</span> @InterfaceAudience.Private<a name="line.423"></a> +<span class="sourceLineNo">424</span> public void setOwner(final String owner) {<a name="line.424"></a> +<span class="sourceLineNo">425</span> this.owner = StringUtils.isEmpty(owner) ? null : owner;<a name="line.425"></a> +<span class="sourceLineNo">426</span> }<a name="line.426"></a> +<span class="sourceLineNo">427</span><a name="line.427"></a> +<span class="sourceLineNo">428</span> public void setOwner(final User owner) {<a name="line.428"></a> +<span class="sourceLineNo">429</span> assert owner != null : "expected owner to be not null";<a name="line.429"></a> +<span class="sourceLineNo">430</span> setOwner(owner.getShortName());<a name="line.430"></a> +<span class="sourceLineNo">431</span> }<a name="line.431"></a> +<span class="sourceLineNo">432</span><a name="line.432"></a> +<span class="sourceLineNo">433</span> /**<a name="line.433"></a> +<span class="sourceLineNo">434</span> * Called on store load to initialize the Procedure internals after<a name="line.434"></a> +<span class="sourceLineNo">435</span> * the creation/deserialization.<a name="line.435"></a> +<span class="sourceLineNo">436</span> */<a name="line.436"></a> +<span class="sourceLineNo">437</span> @InterfaceAudience.Private<a name="line.437"></a> +<span class="sourceLineNo">438</span> protected void setSubmittedTime(final long submittedTime) {<a name="line.438"></a> +<span class="sourceLineNo">439</span> this.submittedTime = submittedTime;<a name="line.439"></a> <span class="sourceLineNo">440</span> }<a name="line.440"></a> <span class="sourceLineNo">441</span><a name="line.441"></a> -<span class="sourceLineNo">442</span> /**<a name="line.442"></a> -<span class="sourceLineNo">443</span> * Called on store load to initialize the Procedure internals after<a name="line.443"></a> -<span class="sourceLineNo">444</span> * the creation/deserialization.<a name="line.444"></a> -<span class="sourceLineNo">445</span> */<a name="line.445"></a> -<span class="sourceLineNo">446</span> @InterfaceAudience.Private<a name="line.446"></a> -<span class="sourceLineNo">447</span> protected void setLastUpdate(final long lastUpdate) {<a name="line.447"></a> -<span class="sourceLineNo">448</span> this.lastUpdate = lastUpdate;<a name="line.448"></a> -<span class="sourceLineNo">449</span> }<a name="line.449"></a> -<span class="sourceLineNo">450</span><a name="line.450"></a> -<span class="sourceLineNo">451</span> /**<a name="line.451"></a> -<span class="sourceLineNo">452</span> * Called by ProcedureExecutor after each time a procedure step is executed.<a name="line.452"></a> -<span class="sourceLineNo">453</span> */<a name="line.453"></a> -<span class="sourceLineNo">454</span> @InterfaceAudience.Private<a name="line.454"></a> -<span class="sourceLineNo">455</span> protected void updateTimestamp() {<a name="line.455"></a> -<span class="sourceLineNo">456</span> this.lastUpdate = EnvironmentEdgeManager.currentTime();<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> public long getLastUpdate() {<a name="line.459"></a> -<span class="sourceLineNo">460</span> return lastUpdate;<a name="line.460"></a> +<span class="sourceLineNo">442</span> // ==========================================================================<a name="line.442"></a> +<span class="sourceLineNo">443</span> // runtime state - timeout related<a name="line.443"></a> +<span class="sourceLineNo">444</span> // ==========================================================================<a name="line.444"></a> +<span class="sourceLineNo">445</span> /**<a name="line.445"></a> +<span class="sourceLineNo">446</span> * @param timeout timeout interval in msec<a name="line.446"></a> +<span class="sourceLineNo">447</span> */<a name="line.447"></a> +<span class="sourceLineNo">448</span> protected void setTimeout(final int timeout) {<a name="line.448"></a> +<span class="sourceLineNo">449</span> this.timeout = timeout;<a name="line.449"></a> +<span class="sourceLineNo">450</span> }<a name="line.450"></a> +<span class="sourceLineNo">451</span><a name="line.451"></a> +<span class="sourceLineNo">452</span> public boolean hasTimeout() {<a name="line.452"></a> +<span class="sourceLineNo">453</span> return timeout != NO_TIMEOUT;<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> /**<a name="line.456"></a> +<span class="sourceLineNo">457</span> * @return the timeout in msec<a name="line.457"></a> +<span class="sourceLineNo">458</span> */<a name="line.458"></a> +<span class="sourceLineNo">459</span> public int getTimeout() {<a name="line.459"></a> +<span class="sourceLineNo">460</span> return timeout;<a name="line.460"></a> <span class="sourceLineNo">461</span> }<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> * Timeout of the next timeout.<a name="line.464"></a> -<span class="sourceLineNo">465</span> * Called by the ProcedureExecutor if the procedure has timeout set and<a name="line.465"></a> -<span class="sourceLineNo">466</span> * the procedure is in the waiting queue.<a name="line.466"></a> -<span class="sourceLineNo">467</span> * @return the timestamp of the next timeout.<a name="line.467"></a> -<span class="sourceLineNo">468</span> */<a name="line.468"></a> -<span class="sourceLineNo">469</span> @InterfaceAudience.Private<a name="line.469"></a> -<span class="sourceLineNo">470</span> protected long getTimeoutTimestamp() {<a name="line.470"></a> -<span class="sourceLineNo">471</span> return getLastUpdate() + getTimeout();<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> // ==========================================================================<a name="line.474"></a> -<span class="sourceLineNo">475</span> // runtime state<a name="line.475"></a> -<span class="sourceLineNo">476</span> // ==========================================================================<a name="line.476"></a> -<span class="sourceLineNo">477</span> /**<a name="line.477"></a> -<span class="sourceLineNo">478</span> * @return the time elapsed between the last update and the start time of the procedure.<a name="line.478"></a> -<span class="sourceLineNo">479</span> */<a name="line.479"></a> -<span class="sourceLineNo">480</span> public long elapsedTime() {<a name="line.480"></a> -<span class="sourceLineNo">481</span> return getLastUpdate() - getStartTime();<a name="line.481"></a> +<span class="sourceLineNo">464</span> * Called on store load to initialize the Procedure internals after<a name="line.464"></a> +<span class="sourceLineNo">465</span> * the creation/deserialization.<a name="line.465"></a> +<span class="sourceLineNo">466</span> */<a name="line.466"></a> +<span class="sourceLineNo">467</span> @InterfaceAudience.Private<a name="line.467"></a> +<span class="sourceLineNo">468</span> protected void setLastUpdate(final long lastUpdate) {<a name="line.468"></a> +<span class="sourceLineNo">469</span> this.lastUpdate = lastUpdate;<a name="line.469"></a> +<span class="sourceLineNo">470</span> }<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> * Called by ProcedureExecutor after each time a procedure step is executed.<a name="line.473"></a> +<span class="sourceLineNo">474</span> */<a name="line.474"></a> +<span class="sourceLineNo">475</span> @InterfaceAudience.Private<a name="line.475"></a> +<span class="sourceLineNo">476</span> protected void updateTimestamp() {<a name="line.476"></a> +<span class="sourceLineNo">477</span> this.lastUpdate = EnvironmentEdgeManager.currentTime();<a name="line.477"></a> +<span class="sourceLineNo">478</span> }<a name="line.478"></a> +<span class="sourceLineNo">479</span><a name="line.479"></a> +<span class="sourceLineNo">480</span> public long getLastUpdate() {<a name="line.480"></a> +<span class="sourceLineNo">481</span> return lastUpdate;<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> /**<a name="line.484"></a> -<span class="sourceLineNo">485</span> * @return the serialized result if any, otherwise null<a name="line.485"></a> -<span class="sourceLineNo">486</span> */<a name="line.486"></a> -<span class="sourceLineNo">487</span> public byte[] getResult() {<a name="line.487"></a> -<span class="sourceLineNo">488</span> return result;<a name="line.488"></a> -<span class="sourceLineNo">489</span> }<a name="line.489"></a> -<span class="sourceLineNo">490</span><a name="line.490"></a> -<span class="sourceLineNo">491</span> /**<a name="line.491"></a> -<span class="sourceLineNo">492</span> * The procedure may leave a "result" on completion.<a name="line.492"></a> -<span class="sourceLineNo">493</span> * @param result the serialized result that will be passed to the client<a name="line.493"></a> -<span class="sourceLineNo">494</span> */<a name="line.494"></a> -<span class="sourceLineNo">495</span> protected void setResult(final byte[] result) {<a name="line.495"></a> -<span class="sourceLineNo">496</span> this.result = result;<a name="line.496"></a> -<span class="sourceLineNo">497</span> }<a name="line.497"></a> -<span class="sourceLineNo">498</span><a name="line.498"></a> -<span class="sourceLineNo">499</span> // ==============================================================================================<a name="line.499"></a> -<span class="sourceLineNo">500</span> // Runtime state, updated every operation by the ProcedureExecutor<a name="line.500"></a> -<span class="sourceLineNo">501</span> //<a name="line.501"></a> -<span class="sourceLineNo">502</span> // There is always 1 thread at the time operating on the state of the procedure.<a name="line.502"></a> -<span class="sourceLineNo">503</span> // The ProcedureExecutor may check and set states, or some Procecedure may<a name="line.503"></a> -<span class="sourceLineNo">504</span> // update its own state. but no concurrent updates. we use synchronized here<a name="line.504"></a> -<span class="sourceLineNo">505</span> // just because the procedure can get scheduled on different executor threads on each step.<a name="line.505"></a> -<span class="sourceLineNo">506</span> // ==============================================================================================<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> * Procedure has states which are defined in proto file. At some places in the code, we<a name="line.509"></a> -<span class="sourceLineNo">510</span> * need to determine more about those states. Following Methods help determine:<a name="line.510"></a> -<span class="sourceLineNo">511</span> *<a name="line.511"></a> -<span class="sourceLineNo">512</span> * {@link #isFailed()} - A procedure has executed at least once and has failed. The procedure<a name="line.512"></a> -<span class="sourceLineNo">513</span> * may or may not have rolled back yet. Any procedure in FAILED state<a name="line.513"></a> -<span class="sourceLineNo">514</span> * will be eventually moved to ROLLEDBACK state.<a name="line.514"></a> -<span class="sourceLineNo">515</span> *<a name="line.515"></a> -<span class="sourceLineNo">516</span> * {@link #isSuccess()} - A procedure is completed successfully without any exception.<a name="line.516"></a> -<span class="sourceLineNo">517</span> *<a name="line.517"></a> -<span class="sourceLineNo">518</span> * {@link #isFinished()} - As a procedure in FAILED state will be tried forever for rollback, only<a name="line.518"></a> -<span class="sourceLineNo">519</span> * condition when scheduler/ executor will drop procedure from further<a name="line.519"></a> -<span class="sourceLineNo">520</span> * processing is when procedure state is ROLLEDBACK or isSuccess()<a name="line.520"></a> -<span class="sourceLineNo">521</span> * returns true. This is a terminal state of the procedure.<a name="line.521"></a> -<span class="sourceLineNo">522</span> *<a name="line.522"></a> -<span class="sourceLineNo">523</span> * {@link #isWaiting()} - Procedure is in one of the two waiting states ({@link<a name="line.523"></a> -<span class="sourceLineNo">524</span> * ProcedureState#WAITING}, {@link ProcedureState#WAITING_TIMEOUT}).<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> /**<a name="line.527"></a> -<span class="sourceLineNo">528</span> * @return true if the procedure is in a RUNNABLE state.<a name="line.528"></a> -<span class="sourceLineNo">529</span> */<a name="line.529"></a> -<span class="sourceLineNo">530</span> protected synchronized boolean isRunnable() {<a name="line.530"></a> -<span class="sourceLineNo">531</span> return state == ProcedureState.RUNNABLE;<a name="line.531"></a> -<span class="sourceLineNo">532</span> }<a name="line.532"></a> -<span class="sourceLineNo">533</span><a name="line.533"></a> -<span class="sourceLineNo">534</span> public synchronized boolean isInitializing() {<a name="line.534"></a> -<span class="sourceLineNo">535</span> return state == ProcedureState.INITIALIZING;<a name="line.535"></a> -<span class="sourceLineNo">536</span> }<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> * @return true if the procedure has failed. It may or may not have rolled back.<a name="line.539"></a> -<span class="sourceLineNo">540</span> */<a name="line.540"></a> -<span class="sourceLineNo">541</span> public synchronized boolean isFailed() {<a name="line.541"></a> -<span class="sourceLineNo">542</span> return state == ProcedureState.FAILED || state == ProcedureState.ROLLEDBACK;<a name="line.542"></a> -<span class="sourceLineNo">543</span> }<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> * @return true if the procedure is finished successfully.<a name="line.546"></a> -<span class="sourceLineNo">547</span> */<a name="line.547"></a> -<span class="sourceLineNo">548</span> public synchronized boolean isSuccess() {<a name="line.548"></a> -<span class="sourceLineNo">549</span> return state == ProcedureState.SUCCESS && !hasException();<a name="line.549"></a> -<span class="sourceLineNo">550</span> }<a name="line.550"></a> -<span class="sourceLineNo">551</span><a name="line.551"></a> -<span class="sourceLineNo">552</span> /**<a name="line.552"></a> -<span class="sourceLineNo">553</span> * @return true if the procedure is finished. The Procedure may be completed successfully or<a name="line.553"></a> -<span class="sourceLineNo">554</span> * rolledback.<a name="line.554"></a> -<span class="sourceLineNo">555</span> */<a name="line.555"></a> -<span class="sourceLineNo">556</span> public synchronized boolean isFinished() {<a name="line.556"></a> -<span class="sourceLineNo">557</span> return isSuccess() || state == ProcedureState.ROLLEDBACK;<a name="line.557"></a> -<span class="sourceLineNo">558</span> }<a name="line.558"></a> -<span class="sourceLineNo">559</span><a name="line.559"></a> -<span class="sourceLineNo">560</span> /**<a name="line.560"></a> -<span class="sourceLineNo">561</span> * @return true if the procedure is waiting for a child to finish or for an external event.<a name="line.561"></a> -<span class="sourceLineNo">562</span> */<a name="line.562"></a> -<span class="sourceLineNo">563</span> public synchronized boolean isWaiting() {<a name="line.563"></a> -<span class="sourceLineNo">564</span> switch (state) {<a name="line.564"></a> -<span class="sourceLineNo">565</span> case WAITING:<a name="line.565"></a> -<span class="sourceLineNo">566</span> case WAITING_TIMEOUT:<a name="line.566"></a> -<span class="sourceLineNo">567</span> return true;<a name="line.567"></a> -<span class="sourceLineNo">568</span> default:<a name="line.568"></a> -<span class="sourceLineNo">569</span> break;<a name="line.569"></a> -<span class="sourceLineNo">570</span> }<a name="line.570"></a> -<span class="sourceLineNo">571</span> return false;<a name="line.571"></a> -<span class="sourceLineNo">572</span> }<a name="line.572"></a> -<span class="sourceLineNo">573</span><a name="line.573"></a> -<span class="sourceLineNo">574</span> @VisibleForTesting<a name="line.574"></a> -<span class="sourceLineNo">575</span> @InterfaceAudience.Private<a name="line.575"></a> -<span class="sourceLineNo">576</span> protected synchronized void setState(final ProcedureState state) {<a name="line.576"></a> -<span class="sourceLineNo">577</span> this.state = state;<a name="line.577"></a> -<span class="sourceLineNo">578</span> updateTimestamp();<a name="line.578"></a> +<span class="sourceLineNo">485</span> * Timeout of the next timeout.<a name="line.485"></a> +<span class="sourceLineNo">486</span> * Called by the ProcedureExecutor if the procedure has timeout set and<a name="line.486"></a> +<span class="sourceLineNo">487</span> * the procedure is in the waiting queue.<a name="line.487"></a> +<span class="sourceLineNo">488</span> * @return the timestamp of the next timeout.<a name="line.488"></a> +<span class="sourceLineNo">489</span> */<a name="line.489"></a> +<span class="sourceLineNo">490</span> @InterfaceAudience.Private<a name="line.490"></a> +<span class="sourceLineNo">491</span> protected long getTimeoutTimestamp() {<a name="line.491"></a> +<span class="sourceLineNo">492</span> return getLastUpdate() + getTimeout();<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> // ==========================================================================<a name="line.495"></a> +<span class="sourceLineNo">496</span> // runtime state<a name="line.496"></a> +<span class="sourceLineNo">497</span> // ==========================================================================<a name="line.497"></a> +<span class="sourceLineNo">498</span> /**<a name="line.498"></a> +<span class="sourceLineNo">499</span> * @return the time elapsed between the last update and the start time of the procedure.<a name="line.499"></a> +<span class="sourceLineNo">500</span> */<a name="line.500"></a> +<span class="sourceLineNo">501</span> public long elapsedTime() {<a name="line.501"></a> +<span class="sourceLineNo">502</span> return getLastUpdate() - getSubmittedTime();<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> /**<a name="line.505"></a> +<span class="sourceLineNo">506</span> * @return the serialized result if any, otherwise null<a name="line.506"></a> +<span class="sourceLineNo">507</span> */<a name="line.507"></a> +<span class="sourceLineNo">508</span> public byte[] getResult() {<a name="line.508"></a> +<span class="sourceLineNo">509</span> return result;<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> * The procedure may leave a "result" on completion.<a name="line.513"></a> +<span class="sourceLineNo">514</span> * @param result the serialized result that will be passed to the client<a name="line.514"></a> +<span class="sourceLineNo">515</span> */<a name="line.515"></a> +<span class="sourceLineNo">516</span> protected void setResult(final byte[] result) {<a name="line.516"></a> +<span class="sourceLineNo">517</span> this.result = result;<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> // Runtime state, updated every operation by the ProcedureExecutor<a name="line.521"></a> +<span class="sourceLineNo">522</span> //<a name="line.522"></a> +<span class="sourceLineNo">523</span> // There is always 1 thread at the time operating on the state of the procedure.<a name="line.523"></a> +<span class="sourceLineNo">524</span> // The ProcedureExecutor may check and set states, or some Procecedure may<a name="line.524"></a> +<span class="sourceLineNo">525</span> // update its own state. but no concurrent updates. we use synchronized here<a name="line.525"></a> +<span class="sourceLineNo">526</span> // just because the procedure can get scheduled on different executor threads on each step.<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> /**<a name="line.529"></a> +<span class="sourceLineNo">530</span> * Procedure has states which are defined in proto file. At some places in the code, we<a name="line.530"></a> +<span class="sourceLineNo">531</span> * need to determine more about those states. Following Methods help determine:<a name="line.531"></a> +<span class="sourceLineNo">532</span> *<a name="line.532"></a> +<span class="sourceLineNo">533</span> * {@link #isFailed()} - A procedure has executed at least once and has failed. The procedure<a name="line.533"></a> +<span class="sourceLineNo">534</span> * may or may not have rolled back yet. Any procedure in FAILED state<a name="line.534"></a> +<span class="sourceLineNo">535</span> * will be eventually moved to ROLLEDBACK state.<a name="line.535"></a> +<span class="sourceLineNo">536</span> *<a name="line.536"></a> +<span class="sourceLineNo">537</span> * {@link #isSuccess()} - A procedure is completed successfully without any exception.<a name="line.537"></a> +<span class="sourceLineNo">538</span> *<a name="line.538"></a> +<span class="sourceLineNo">539</span> * {@link #isFinished()} - As a procedure in FAILED state will be tried forever for rollback, only<a name="line.539"></a> +<span class="sourceLineNo">540</span> * condition when scheduler/ executor will drop procedure from further<a name="line.540"></a> +<span class="sourceLineNo">541</span> * processing is when procedure state is ROLLEDBACK or isSuccess()<a name="line.541"></a> +<span class="sourceLineNo">542</span> * returns true. This is a terminal state of the procedure.<a name="line.542"></a> +<span class="sourceLineNo">543</span> *<a name="line.543"></a> +<span class="sourceLineNo">544</span> * {@link #isWaiting()} - Procedure is in one of the two waiting states ({@link<a name="line.544"></a> +<span class="sourceLineNo">545</span> * ProcedureState#WAITING}, {@link ProcedureState#WAITING_TIMEOUT}).<a name="line.545"></a> +<span class="sourceLineNo">546</span> */<a name="line.546"></a> +<span class="sourceLineNo">547</span><a name="line.547"></a> +<span class="sourceLineNo">548</span> /**<a name="line.548"></a> +<span class="sourceLineNo">549</span> * @return true if the procedure is in a RUNNABLE state.<a name="line.549"></a> +<span class="sourceLineNo">550</span> */<a name="line.550"></a> +<span class="sourceLineNo">551</span> protected synchronized boolean isRunnable() {<a name="line.551"></a> +<span class="sourceLineNo">552</span> return state == ProcedureState.RUNNABLE;<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 synchronized boolean isInitializing() {<a name="line.555"></a> +<span class="sourceLineNo">556</span> return state == ProcedureState.INITIALIZING;<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> /**<a name="line.559"></a> +<span class="sourceLineNo">560</span> * @return true if the procedure has failed. It may or may not have rolled back.<a name="line.560"></a> +<span class="sourceLineNo">561</span> */<a name="line.561"></a> +<span class="sourceLineNo">562</span> public synchronized boolean isFailed() {<a name="line.562"></a> +<span class="sourceLineNo">563</span> return state == ProcedureState.FAILED || state == ProcedureState.ROLLEDBACK;<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> /**<a name="line.566"></a> +<span class="sourceLineNo">567</span> * @return true if the procedure is finished successfully.<a name="line.567"></a> +<span class="sourceLineNo">568</span> */<a name="line.568"></a> +<span class="sourceLineNo">569</span> public synchronized boolean isSuccess() {<a name="line.569"></a> +<span class="sourceLineNo">570</span> return state == ProcedureState.SUCCESS && !hasException();<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> /**<a name="line.573"></a> +<span class="sourceLineNo">574</span> * @return true if the procedure is finished. The Procedure may be completed successfully or<a name="line.574"></a> +<span class="sourceLineNo">575</span> * rolledback.<a name="line.575"></a> +<span class="sourceLineNo">576</span> */<a name="line.576"></a> +<span class="sourceLineNo">577</span> public synchronized boolean isFinished() {<a name="line.577"></a> +<span class="sourceLineNo">578</span> return isSuccess() || state == ProcedureState.ROLLEDBACK;<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> @InterfaceAudience.Private<a name="line.581"></a> -<span class="sourceLineNo">582</span> protected synchronized ProcedureState getState() {<a name="line.582"></a> -<span class="sourceLineNo">583</span> return state;<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> protected void setFailure(final String source, final Throwable cause) {<a name="line.586"></a> -<span class="sourceLineNo">587</span> setFailure(new RemoteProcedureException(source, cause));<a name="line.587"></a> -<span class="sourceLineNo">588</span> }<a name="line.588"></a> -<span class="sourceLineNo">589</span><a name="line.589"></a> -<span class="sourceLineNo">590</span> protected synchronized void setFailure(final RemoteProcedureException exception) {<a name="line.590"></a> -<span class="sourceLineNo">591</span> this.exception = exception;<a name="line.591"></a> -<span class="sourceLineNo">592</span> if (!isFinished()) {<a name="line.592"></a> -<span class="sourceLineNo">593</span> setState(ProcedureState.FAILED);<a name="line.593"></a> -<span class="sourceLineNo">594</span> }<a name="line.594"></a> -<span class="sourceLineNo">595</span> }<a name="line.595"></a> -<span class="sourceLineNo">596</span><a name="line.596"></a> -<span class="sourceLineNo">597</span> protected void setAbortFailure(final String source, final String msg) {<a name="line.597"></a> -<span class="sourceLineNo">598</span> setFailure(source, new ProcedureAbortedException(msg));<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 the ProcedureExecutor when the timeout set by setTimeout() is expired.<a name="line.602"></a> -<span class="sourceLineNo">603</span> * @return true to let the framework handle the timeout as abort,<a name="line.603"></a> -<span class="sourceLineNo">604</span> * false in case the procedure handled the timeout itself.<a name="line.604"></a> -<span class="sourceLineNo">605</span> */<a name="line.605"></a> -<span class="sourceLineNo">606</span> protected synchronized boolean setTimeoutFailure(final TEnvironment env) {<a name="line.606"></a> -<span class="sourceLineNo">607</span> if (state == ProcedureState.WAITING_TIMEOUT) {<a name="line.607"></a> -<span class="sourceLineNo">608</span> long timeDiff = EnvironmentEdgeManager.currentTime() - lastUpdate;<a name="line.608"></a> -<span class="sourceLineNo">609</span> setFailure("ProcedureExecutor", new TimeoutIOException(<a name="line.609"></a> -<span class="sourceLineNo">610</span> "Operation timed out after " + StringUtils.humanTimeDiff(timeDiff)));<a name="line.610"></a> -<span class="sourceLineNo">611</span> return true;<a name="line.611"></a> -<span class="sourceLineNo">612</span> }<a name="line.612"></a> -<span class="sourceLineNo">613</span> return false;<a name="line.613"></a> -<span class="sourceLineNo">614</span> }<a name="line.614"></a> -<span class="sourceLineNo">615</span><a name="line.615"></a> -<span class="sourceLineNo">616</span> public synchronized boolean hasException() {<a name="line.616"></a> -<span class="sourceLineNo">617</span> return exception != null;<a name="line.617"></a> -<span class="sourceLineNo">618</span> }<a name="line.618"></a> -<span class="sourceLineNo">619</span><a name="line.619"></a> -<span class="sourceLineNo">620</span> public synchronized RemoteProcedureException getException() {<a name="line.620"></a> -<span class="sourceLineNo">621</span> return exception;<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> /**<a name="line.624"></a> -<span class="sourceLineNo">625</span> * Called by the ProcedureExecutor on procedure-load to restore the latch state<a name="line.625"></a> +<span class="sourceLineNo">581</span> /**<a name="line.581"></a> +<span class="sourceLineNo">582</span> * @return true if the procedure is waiting for a child to finish or for an external event.<a name="line.582"></a> +<span class="sourceLineNo">583</span> */<a name="line.583"></a> +<span class="sourceLineNo">584</span> public synchronized boolean isWaiting() {<a name="line.584"></a> +<span class="sourceLineNo">585</span> switch (state) {<a name="line.585"></a> +<span class="sourceLineNo">586</span> case WAITING:<a name="line.586"></a> +<span class="sourceLineNo">587</span> case WAITING_TIMEOUT:<a name="line.587"></a> +<span class="sourceLineNo">588</span> return true;<a name="line.588"></a> +<span class="sourceLineNo">589</span> default:<a name="line.589"></a> +<span class="sourceLineNo">590</span> break;<a name="line.590"></a> +<span class="sourceLineNo">591</span> }<a name="line.591"></a> +<span class="sourceLineNo">592</span> return false;<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> @VisibleForTesting<a name="line.595"></a> +<span class="sourceLineNo">596</span> @InterfaceAudience.Private<a name="line.596"></a> +<span class="sourceLineNo">597</span> protected synchronized void setState(final ProcedureState state) {<a name="line.597"></a> +<span class="sourceLineNo">598</span> this.state = state;<a name="line.598"></a> +<span class="sourceLineNo">599</span> updateTimestamp();<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> @InterfaceAudience.Private<a name="line.602"></a> +<span class="sourceLineNo">603</span> protected synchronized ProcedureState getState() {<a name="line.603"></a> +<span class="sourceLineNo">604</span> return state;<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> protected void setFailure(final String source, final Throwable cause) {<a name="line.607"></a> +<span class="sourceLineNo">608</span> setFailure(new RemoteProcedureException(source, cause));<a name="line.608"></a> +<span class="sourceLineNo">609</span> }<a name="line.609"></a> +<span class="sourceLineNo">610</span><a name="line.610"></a> +<span class="sourceLineNo">611</span> protected synchronized void setFailure(final RemoteProcedureException exception) {<a name="line.611"></a> +<span class="sourceLineNo">612</span> this.exception = exception;<a name="line.612"></a> +<span class="sourceLineNo">613</span> if (!isFinished()) {<a name="line.613"></a> +<span class="sourceLineNo">614</span> setState(ProcedureState.FAILED);<a name="line.614"></a> +<span class="sourceLineNo">615</span> }<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> protected void setAbortFailure(final String source, final String msg) {<a name="line.618"></a> +<span class="sourceLineNo">619</span> setFailure(source, new ProcedureAbortedException(msg));<a name="line.619"></a> +<span class="sourceLineNo">620</span> }<a name="line.620"></a> +<span class="sourceLineNo">621</span><a name="line.621"></a> +<span class="sourceLineNo">622</span> /**<a name="line.622"></a> +<span class="sourceLineNo">623</span> * Called by the ProcedureExecutor when the timeout set by setTimeout() is expired.<a name="line.623"></a> +<span class="sourceLineNo">624</span> * @return true to let the framework handle the timeout as abort,<a name="line.624"></a> +<span class="sourceLineNo">625</span> * false in case the procedure handled the timeout itself.<a name="line.625"></a> <span class="sourceLineNo">626</span> */<a name="line.626"></a> -<span class="sourceLineNo">627</span> @InterfaceAudience.Private<a name="line.627"></a> -<span class="sourceLineNo">628</span> protected synchronized void setChildrenLatch(final int numChildren) {<a name="line.628"></a> -<span class="sourceLineNo">629</span> this.childrenLatch = numChildren;<a name="line.629"></a> -<span class="sourceLineNo">630</span> }<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> * Called by the ProcedureExecutor on procedure-load to restore the latch state<a name="line.633"></a> -<span class="sourceLineNo">634</span> */<a name="line.634"></a> -<span class="sourceLineNo">635</span> @InterfaceAudience.Private<a name="line.635"></a> -<span class="sourceLineNo">636</span> protected synchronized void incChildrenLatch() {<a name="line.636"></a> -<span class="sourceLineNo">637</span> // TODO: can this be inferred from the stack? I think so...<a name="line.637"></a> -<span class="sourceLineNo">638</span> this.childrenLatch++;<a name="line.638"></a> +<span class="sourceLineNo">627</span> protected synchronized boolean setTimeoutFailure(final TEnvironment env) {<a name="line.627"></a> +<span class="sourceLineNo">628</span> if (state == ProcedureState.WAITING_TIMEOUT) {<a name="line.628"></a> +<span class="sourceLineNo">629</span> long timeDiff = EnvironmentEdgeManager.currentTime() - lastUpdate;<a name="line.629"></a> +<span class="sourceLineNo">630</span> setFailure("ProcedureExecutor", new TimeoutIOException(<a name="line.630"></a> +<span class="sourceLineNo">631</span> "Operation timed out after " + StringUtils.humanTimeDiff(timeDiff)));<a name="line.631"></a> +<span class="sourceLineNo">632</span> return true;<a name="line.632"></a> +<span class="sourceLineNo">633</span> }<a name="line.633"></a> +<span class="sourceLineNo">634</span> return false;<a name="line.634"></a> +<span class="sourceLineNo">635</span> }<a name="line.635"></a> +<span class="sourceLineNo">636</span><a name="line.636"></a> +<span class="sourceLineNo">637</span> public synchronized boolean hasException() {<a name="line.637"></a> +<span class="sourceLineNo">638</span> return exception != null;<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> /**<a name="line.641"></a> -<span class="sourceLineNo">642</span> * Called by the ProcedureExecutor to notify that one of the sub-procedures has completed.<a name="line.642"></a> -<span class="sourceLineNo">643</span> */<a name="line.643"></a> -<span class="sourceLineNo">644</span> @InterfaceAudience.Private<a name="line.644"></a> -<span class="sourceLineNo">645</span> protected synchronized boolean childrenCountDown() {<a name="line.645"></a> -<span class="sourceLineNo">646</span> assert childrenLatch > 0: this;<a name="line.646"></a> -<span class="sourceLineNo">647</span> return --childrenLatch == 0;<a name="line.647"></a> -<span class="sourceLineNo">648</span> }<a name="line.648"></a> -<span class="sourceLineNo">649</span><a name="line.649"></a> -<span class="sourceLineNo">650</span> @InterfaceAudience.Private<a name="line.650"></a> -<span class="sourceLineNo">651</span> protected synchronized boolean hasChildren() {<a name="line.651"></a> -<span class="sourceLineNo">652</span> return childrenLatch > 0;<a name="line.652"></a> -<span class="sourceLineNo">653</span> }<a name="line.653"></a> -<span class="sourceLineNo">654</span><a name="line.654"></a> -<span class="sourceLineNo">655</span> @InterfaceAudience.Private<a name="line.655"></a> -<span class="sourceLineNo">656</span> protected synchronized int getChildrenLatch() {<a name="line.656"></a> -<span class="sourceLineNo">657</span> return childrenLatch;<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> * Called by the RootProcedureState on procedure execution.<a name="line.661"></a> -<span class="sourceLineNo">662</span> * Each procedure store its stack-index positions.<a name="line.662"></a> -<span class="sourceLineNo">663</span> */<a name="line.663"></a> -<span class="sourceLineNo">664</span> @InterfaceAudience.Private<a name="line.664"></a> -<span class="sourceLineNo">665</span> protected synchronized void addStackIndex(final int index) {<a name="line.665"></a> -<span class="sourceLineNo">666</span> if (stackIndexes == null) {<a name="line.666"></a> -<span class="sourceLineNo">667</span> stackIndexes = new int[] { index };<a name="line.667"></a> -<span class="sourceLineNo">668</span> } else {<a name="line.668"></a> -<span class="sourceLineNo">669</span> int count = stackIndexes.length;<a name="line.669"></a> -<span class="sourceLineNo">670</span> stackIndexes = Arrays.copyOf(stackIndexes, count + 1);<a name="line.670"></a> -<span class="sourceLineNo">671</span> stackIndexes[count] = index;<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><a name="line.674"></a> -<span class="sourceLineNo">675</span> @InterfaceAudience.Private<a name="line.675"></a> -<span class="sourceLineNo">676</span> protected synchronized boolean removeStackIndex() {<a name="line.676"></a> -<span class="sourceLineNo">677</span> if (stackIndexes != null && stackIndexes.length > 1) {<a name="line.677"></a> -<span class="sourceLineNo">678</span> stackIndexes = Arrays.copyOf(stackIndexes, stackIndexes.length - 1);<a name="line.678"></a> -<span class="sourceLineNo">679</span> return false;<a name="line.679"></a> -<span class="sourceLineNo">680</span> } else {<a name="line.680"></a> -<span class="sourceLineNo">681</span> stackIndexes = null;<a name="line.681"></a> -<span class="sourceLineNo">682</span> return true;<a name="line.682"></a> -<span class="sourceLineNo">683</span> }<a name="line.683"></a> -<span class="sourceLineNo">684</span> }<a name="line.684"></a> -<span class="sourceLineNo">685</span><a name="line.685"></a> -<span class="sourceLineNo">686</span> /**<a name="line.686"></a> -<span class="sourceLineNo">687</span> * Called on store load to initialize the Procedure internals after<a name="line.687"></a> -<span class="sourceLineNo">688</span> * the creation/deserialization.<a name="line.688"></a> -<span class="sourceLineNo">689</span> */<a name="line.689"></a> -<span class="sourceLineNo">690</span> @InterfaceAudience.Private<a name="line.690"></a> -<span class="sourceLineNo">691</span> protected synchronized void setStackIndexes(final List<Integer> stackIndexes) {<a name="line.691"></a> -<span class="sourceLineNo">692</span> this.stackIndexes = new int[stackIndexes.size()];<a name="line.692"></a> -<span class="sourceLineNo">693</span> for (int i = 0; i < this.stackIndexes.length; ++i) {<a name="line.693"></a> -<span class="sourceLineNo">694</span> this.stackIndexes[i] = stackIndexes.get(i);<a name="line.694"></a> -<span class="sourceLineNo">695</span> }<a name="line.695"></a> -<span class="sourceLineNo">696</span> }<a name="line.696"></a> -<span class="sourceLineNo">697</span><a name="line.697"></a> -<span class="sourceLineNo">698</span> @InterfaceAudience.Private<a name="line.698"></a> -<span class="sourceLineNo">699</span> protected synchronized boolean wasExecuted() {<a name="line.699"></a> -<span class="sourceLineNo">700</span> return stackIndexes != null;<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> @InterfaceAudience.Private<a name="line.703"></a> -<span class="sourceLineNo">704</span> protected synchronized int[] getStackIndexes() {<a name="line.704"></a> -<span class="sourceLineNo">705</span> return stackIndexes;<a name="line.705"></a> -<span class="sourceLineNo">706</span> }<a name="line.706"></a> -<span class="sourceLineNo">707</span><a name="line.707"></a> -<span class="sourceLineNo">708</span> // ==========================================================================<a name="line.708"></a> -<span class="sourceLineNo">709</span> // Internal methods - called by the ProcedureExecutor<a name="line.709"></a> -<span class="sourceLineNo">710</span> // ==========================================================================<a name="line.710"></a> -<span class="sourceLineNo">711</span><a name="line.711"></a> -<span class="sourceLineNo">712</span> /**<a name="line.712"></a> -<span class="sourceLineNo">713</span> * Internal method called by the ProcedureExecutor that starts the user-level code execute().<a name="line.713"></a> -<span class="sourceLineNo">714</span> */<a name="line.714"></a> -<span class="sourceLineNo">715</span> @InterfaceAudience.Private<a name="line.715"></a> -<span class="sourceLineNo">716</span> protected Procedure[] doExecute(final TEnvironment env)<a name="line.716"></a> -<span class="sourceLineNo">717</span> throws ProcedureYieldException, ProcedureSuspendedException, InterruptedException {<a name="line.717"></a> -<span class="sourceLineNo">718</span> try {<a name="line.718"></a> -<span class="sourceLineNo">719</span> updateTimestamp();<a name="line.719"></a> -<span class="sourceLineNo">720</span> return execute(env);<a name="line.720"></a> -<span class="sourceLineNo">721</span> } finally {<a name="line.721"></a> -<span class="sourceLineNo">722</span> updateTimestamp();<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><a name="line.725"></a> -<span class="sourceLineNo">726</span> /**<a name="line.726"></a> -<span class="sourceLineNo">727</span> * Internal method called by the ProcedureExecutor that starts the user-level code rollback().<a name="line.727"></a> -<span class="sourceLineNo">728</span> */<a name="line.728"></a> -<span class="sourceLineNo">729</span> @InterfaceAudience.Private<a name="line.729"></a> -<span class="sourceLineNo">730</span> protected void doRollback(final TEnvironment env)<a name="line.730"></a> -<span class="sourceLineNo">731</span> throws IOException, InterruptedException {<a name="line.731"></a> -<span class="sourceLineNo">732</span> try {<a name="line.732"></a> -<span class="sourceLineNo">733</span> updateTimestamp();<a name="line.733"></a> -<span class="sourceLineNo">734</span> rollback(env);<a name="line.734"></a> -<span class="sourceLineNo">735</span> } finally {<a name="line.735"></a> -<span class="sourceLineNo">736</span> updateTimestamp();<a name="line.736"></a> -<span class="sourceLineNo">737</span> }<a name="line.737"></a> -<span class="sourceLineNo">738</span> }<a name="line.738"></a> -<span class="sourceLineNo">739</span><a name="line.739"></a> -<span class="sourceLineNo">740</span> /**<a name="line.740"></a> -<span class="sourceLineNo">741</span> * Internal method called by the ProcedureExecutor that starts the user-level code acquireLock().<a name="line.741"></a> -<span class="sourceLineNo">742</span> */<a name="line.742"></a> -<span class="sourceLineNo">743</span> @InterfaceAudience.Private<a name="line.743"></a> -<span class="sourceLineNo">744</span> protected LockState doAcquireLock(final TEnvironment env) {<a name="line.744"></a> -<span class="sourceLineNo">745</span> return acquireLock(env);<a name="line.745"></a> -<span class="sourceLineNo">746</span> }<a name="line.746"></a> -<span class="sourceLineNo">747</span><a name="line.747"></a> -<span class="sourceLineNo">748</span> /**<a name="line.748"></a> -<span class="sourceLineNo">749</span> * Internal method called by the ProcedureExecutor that starts the user-level code releaseLock().<a name="line.749"></a> -<span class="sourceLineNo">750</span> */<a name="line.750"></a> -<span class="sourceLineNo">751</span> @InterfaceAudience.Private<a name="line.751"></a> -<span class="sourceLineNo">752</span> protected void doReleaseLock(final TEnvironment env) {<a name="line.752"></a> -<span class="sourceLineNo">753</span> releaseLock(env);<a name="line.753"></a> -<span class="sourceLineNo">754</span> }<a name="line.754"></a> -<span class="sourceLineNo">755</span><a name="line.755"></a> -<span class="sourceLineNo">756</span> @Override<a name="line.756"></a> -<span class="sourceLineNo">757</span> public int compareTo(final Procedure other) {<a name="line.757"></a> -<span class="sourceLineNo">758</span> return Long.compare(getProcId(), other.getProcId());<a name="line.758"></a> +<span class="sourceLineNo">641</span> public synchronized RemoteProcedureException getException() {<a name="line.641"></a> +<span class="sourceLineNo">642</span> return exception;<a name="line.642"></a> +<span class="sourceLineNo">643</span> }<a name="line.643"></a> +<span class="sourceLineNo">644</span><a name="line.644"></a> +<span class="sourceLineNo">645</span> /**<a name="line.645"></a> +<span class="sourceLineNo">646</span> * Called by the ProcedureExecutor on procedure-load to restore the latch state<a name="line.646"></a> +<span class="sourceLineNo">647</span> */<a name="line.647"></a> +<span class="sourceLineNo">648</span> @InterfaceAudience.Private<a name="line.648"></a> +<span class="sourceLineNo">649</span> protected synchronized void setChildrenLatch(final int numChildren) {<a name="line.649"></a> +<span class="sourceLineNo">650</span> this.childrenLatch = numChildren;<a name="line.650"></a> +<span class="sourceLineNo">651</span> }<a name="line.651"></a> +<span class="sourceLineNo">652</span><a name="line.652"></a> +<span class="sourceLineNo">653</span> /**<a name="line.653"></a> +<span class="sourceLineNo">654</span> * Called by the ProcedureExecutor on procedure-load to restore the latch state<a name="line.654"></a> +<span class="sourceLineNo">655</span> */<a name="line.655"></a> +<span class="sourceLineNo">656</span> @InterfaceAudience.Private<a name="line.656"></a> +<span class="sourceLineNo">657</span> protected synchronized void incChildrenLatch() {<a name="line.657"></a> +<span class="sourceLineNo">658</span> // TODO: can this be inferred from the stack? I think so...<a name="line.658"></a> +<span class="sourceLineNo">659</span> this.childrenLatch++;<a name="line.659"></a> +<span class="sourceLineNo">660</span> }<a name="line.660"></a> +<span class="sourceLineNo">661</span><a name="line.661"></a> +<span class="sourceLineNo">662</span> /**<a name="line.662"></a> +<span class="sourceLineNo">663</span> * Called by the ProcedureExecutor to notify that one of the sub-procedures has completed.<a name="line.663"></a> +<span class="sourceLineNo">664</span> */<a name="line.664"></a> +<span class="sourceLineNo">665</span> @InterfaceAudience.Private<a name="line.665"></a> +<span class="sourceLineNo">666</span> protected synchronized boolean childrenCountDown() {<a name="line.666"></a> +<span class="sourceLineNo">667</span> assert childrenLatch > 0: this;<a name="line.667"></a> +<span class="sourceLineNo">668</span> return --childrenLatch == 0;<a name="line.668"></a> +<span class="sourceLineNo">669</span> }<a name="line.669"></a> +<span class="sourceLineNo">670</span><a name="line.670"></a> +<span class="sourceLineNo">671</span> @InterfaceAudience.Private<a name="line.671"></a> +<span class="sourceLineNo">672</span> protected synchronized boolean hasChildren() {<a name="line.672"></a> +<span class="sourceLineNo">673</span> return childrenLatch > 0;<a name="line.673"></a> +<span class="sourceLineNo">674</span> }<a name="line.674"></a> +<span class="sourceLineNo">675</span><a name="line.675"></a> +<span class="sourceLineNo">676</span> @InterfaceAudience.Private<a name="line.676"></a> +<span class="sourceLineNo">677</span> protected synchronized int getChildrenLatch() {<a name="line.677"></a> +<span class="sourceLineNo">678</span> return childrenLatch;<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> * Called by the RootProcedureState on procedure execution.<a name="line.682"></a> +<span class="sourceLineNo">683</span> * Each procedure store its stack-index positions.<a name="line.683"></a> +<span class="sourceLineNo">684</span> */<a name="line.684"></a> +<span class="sourceLineNo">685</span> @InterfaceAudience.Private<a name="line.685"></a> +<span class="sourceLineNo">686</span> protected synchronized void addStackIndex(final int index) {<a name="line.686"></a> +<span class="sourceLineNo">687</span> if (stackIndexes == null) {<a name="line.687"></a> +<span class="sourceLineNo">688</span> stackIndexes = new int[] { index };<a name="line.688"></a> +<span class="sourceLineNo">689</span> } else {<a name="line.689"></a> +<span class="sourceLineNo">690</span> int count = stackIndexes.length;<a name="line.690"></a> +<span class="sourceLineNo">691</span> stackIndexes = Arrays.copyOf(stackIndexes, count + 1);<a name="line.691"></a> +<span class="sourceLineNo">692</span> stackIndexes[count] = index;<a name="line.692"></a> +<span class="sourceLineNo">693</span> }<a name="line.693"></a> +<span class="sourceLineNo">694</span> }<a name="line.694"></a> +<span class="sourceLineNo">695</span><a name="line.695"></a> +<span class="sourceLineNo">696</span> @InterfaceAudience.Private<a name="line.696"></a> +<span class="sourceLineNo">697</span> protected synchronized boolean removeStackIndex() {<a name="line.697"></a> +<span class="sourceLineNo">698</span> if (stackIndexes != null && stackIndexes.length > 1) {<a name="line.698"></a> +<span class="sourceLineNo">699</span> stackIndexes = Arrays.copyOf(stackIndexes, stackIndexes.length - 1);<a name="line.699"></a> +<span class="sourceLineNo">700</span> return false;<a name="line.700"></a> +<span class="sourceLineNo">701</span> } else {<a name="line.701"></a> +<span class="sourceLineNo">702</span> stackIndexes = null;<a na
<TRUNCATED>
