Google Git
Sign in
apache / hbase-site / 690a3160206c1db10da5912f1efe153de9843573 / . / devapidocs / src-html / org / apache / hadoop / hbase / procedure2 / RootProcedureState.html
blob: 5257e8b331c66e5218cf819fd523455fe8a632c0 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a>
<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a>
<span class="sourceLineNo">017</span> */<a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.procedure2;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.util.ArrayList;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.HashSet;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.List;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.Set;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.slf4j.Logger;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.slf4j.LoggerFactory;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.ProcedureState;<a name="line.29"></a>
<span class="sourceLineNo">030</span><a name="line.30"></a>
<span class="sourceLineNo">031</span>/**<a name="line.31"></a>
<span class="sourceLineNo">032</span> * Internal state of the ProcedureExecutor that describes the state of a "Root Procedure".<a name="line.32"></a>
<span class="sourceLineNo">033</span> * A "Root Procedure" is a Procedure without parent, each subprocedure will be<a name="line.33"></a>
<span class="sourceLineNo">034</span> * added to the "Root Procedure" stack (or rollback-stack).<a name="line.34"></a>
<span class="sourceLineNo">035</span> *<a name="line.35"></a>
<span class="sourceLineNo">036</span> * RootProcedureState is used and managed only by the ProcedureExecutor.<a name="line.36"></a>
<span class="sourceLineNo">037</span> * Long rootProcId = getRootProcedureId(proc);<a name="line.37"></a>
<span class="sourceLineNo">038</span> * rollbackStack.get(rootProcId).acquire(proc)<a name="line.38"></a>
<span class="sourceLineNo">039</span> * rollbackStack.get(rootProcId).release(proc)<a name="line.39"></a>
<span class="sourceLineNo">040</span> * ...<a name="line.40"></a>
<span class="sourceLineNo">041</span> */<a name="line.41"></a>
<span class="sourceLineNo">042</span>@InterfaceAudience.Private<a name="line.42"></a>
<span class="sourceLineNo">043</span>@InterfaceStability.Evolving<a name="line.43"></a>
<span class="sourceLineNo">044</span>class RootProcedureState&lt;TEnvironment&gt; {<a name="line.44"></a>
<span class="sourceLineNo">045</span> private static final Logger LOG = LoggerFactory.getLogger(RootProcedureState.class);<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span> private enum State {<a name="line.47"></a>
<span class="sourceLineNo">048</span> RUNNING, // The Procedure is running or ready to run<a name="line.48"></a>
<span class="sourceLineNo">049</span> FAILED, // The Procedure failed, waiting for the rollback executing<a name="line.49"></a>
<span class="sourceLineNo">050</span> ROLLINGBACK, // The Procedure failed and the execution was rolledback<a name="line.50"></a>
<span class="sourceLineNo">051</span> }<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span> private Set&lt;Procedure&lt;TEnvironment&gt;&gt; subprocs = null;<a name="line.53"></a>
<span class="sourceLineNo">054</span> private ArrayList&lt;Procedure&lt;TEnvironment&gt;&gt; subprocStack = null;<a name="line.54"></a>
<span class="sourceLineNo">055</span> private State state = State.RUNNING;<a name="line.55"></a>
<span class="sourceLineNo">056</span> private int running = 0;<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> public synchronized boolean isFailed() {<a name="line.58"></a>
<span class="sourceLineNo">059</span> switch (state) {<a name="line.59"></a>
<span class="sourceLineNo">060</span> case ROLLINGBACK:<a name="line.60"></a>
<span class="sourceLineNo">061</span> case FAILED:<a name="line.61"></a>
<span class="sourceLineNo">062</span> return true;<a name="line.62"></a>
<span class="sourceLineNo">063</span> default:<a name="line.63"></a>
<span class="sourceLineNo">064</span> break;<a name="line.64"></a>
<span class="sourceLineNo">065</span> }<a name="line.65"></a>
<span class="sourceLineNo">066</span> return false;<a name="line.66"></a>
<span class="sourceLineNo">067</span> }<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span> public synchronized boolean isRollingback() {<a name="line.69"></a>
<span class="sourceLineNo">070</span> return state == State.ROLLINGBACK;<a name="line.70"></a>
<span class="sourceLineNo">071</span> }<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> /**<a name="line.73"></a>
<span class="sourceLineNo">074</span> * Called by the ProcedureExecutor to mark rollback execution<a name="line.74"></a>
<span class="sourceLineNo">075</span> */<a name="line.75"></a>
<span class="sourceLineNo">076</span> protected synchronized boolean setRollback() {<a name="line.76"></a>
<span class="sourceLineNo">077</span> if (running == 0 &amp;&amp; state == State.FAILED) {<a name="line.77"></a>
<span class="sourceLineNo">078</span> state = State.ROLLINGBACK;<a name="line.78"></a>
<span class="sourceLineNo">079</span> return true;<a name="line.79"></a>
<span class="sourceLineNo">080</span> }<a name="line.80"></a>
<span class="sourceLineNo">081</span> return false;<a name="line.81"></a>
<span class="sourceLineNo">082</span> }<a name="line.82"></a>
<span class="sourceLineNo">083</span><a name="line.83"></a>
<span class="sourceLineNo">084</span> /**<a name="line.84"></a>
<span class="sourceLineNo">085</span> * Called by the ProcedureExecutor to mark rollback execution<a name="line.85"></a>
<span class="sourceLineNo">086</span> */<a name="line.86"></a>
<span class="sourceLineNo">087</span> protected synchronized void unsetRollback() {<a name="line.87"></a>
<span class="sourceLineNo">088</span> assert state == State.ROLLINGBACK;<a name="line.88"></a>
<span class="sourceLineNo">089</span> state = State.FAILED;<a name="line.89"></a>
<span class="sourceLineNo">090</span> }<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span> protected synchronized long[] getSubprocedureIds() {<a name="line.92"></a>
<span class="sourceLineNo">093</span> if (subprocs == null) {<a name="line.93"></a>
<span class="sourceLineNo">094</span> return null;<a name="line.94"></a>
<span class="sourceLineNo">095</span> }<a name="line.95"></a>
<span class="sourceLineNo">096</span> return subprocs.stream().mapToLong(Procedure::getProcId).toArray();<a name="line.96"></a>
<span class="sourceLineNo">097</span> }<a name="line.97"></a>
<span class="sourceLineNo">098</span><a name="line.98"></a>
<span class="sourceLineNo">099</span> protected synchronized List&lt;Procedure&lt;TEnvironment&gt;&gt; getSubproceduresStack() {<a name="line.99"></a>
<span class="sourceLineNo">100</span> return subprocStack;<a name="line.100"></a>
<span class="sourceLineNo">101</span> }<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span> protected synchronized RemoteProcedureException getException() {<a name="line.103"></a>
<span class="sourceLineNo">104</span> if (subprocStack != null) {<a name="line.104"></a>
<span class="sourceLineNo">105</span> for (Procedure&lt;TEnvironment&gt; proc: subprocStack) {<a name="line.105"></a>
<span class="sourceLineNo">106</span> if (proc.hasException()) {<a name="line.106"></a>
<span class="sourceLineNo">107</span> return proc.getException();<a name="line.107"></a>
<span class="sourceLineNo">108</span> }<a name="line.108"></a>
<span class="sourceLineNo">109</span> }<a name="line.109"></a>
<span class="sourceLineNo">110</span> }<a name="line.110"></a>
<span class="sourceLineNo">111</span> return null;<a name="line.111"></a>
<span class="sourceLineNo">112</span> }<a name="line.112"></a>
<span class="sourceLineNo">113</span><a name="line.113"></a>
<span class="sourceLineNo">114</span> /**<a name="line.114"></a>
<span class="sourceLineNo">115</span> * Called by the ProcedureExecutor to mark the procedure step as running.<a name="line.115"></a>
<span class="sourceLineNo">116</span> */<a name="line.116"></a>
<span class="sourceLineNo">117</span> protected synchronized boolean acquire(Procedure&lt;TEnvironment&gt; proc) {<a name="line.117"></a>
<span class="sourceLineNo">118</span> if (state != State.RUNNING) {<a name="line.118"></a>
<span class="sourceLineNo">119</span> return false;<a name="line.119"></a>
<span class="sourceLineNo">120</span> }<a name="line.120"></a>
<span class="sourceLineNo">121</span><a name="line.121"></a>
<span class="sourceLineNo">122</span> running++;<a name="line.122"></a>
<span class="sourceLineNo">123</span> return true;<a name="line.123"></a>
<span class="sourceLineNo">124</span> }<a name="line.124"></a>
<span class="sourceLineNo">125</span><a name="line.125"></a>
<span class="sourceLineNo">126</span> /**<a name="line.126"></a>
<span class="sourceLineNo">127</span> * Called by the ProcedureExecutor to mark the procedure step as finished.<a name="line.127"></a>
<span class="sourceLineNo">128</span> */<a name="line.128"></a>
<span class="sourceLineNo">129</span> protected synchronized void release(Procedure&lt;TEnvironment&gt; proc) {<a name="line.129"></a>
<span class="sourceLineNo">130</span> running--;<a name="line.130"></a>
<span class="sourceLineNo">131</span> }<a name="line.131"></a>
<span class="sourceLineNo">132</span><a name="line.132"></a>
<span class="sourceLineNo">133</span> protected synchronized void abort() {<a name="line.133"></a>
<span class="sourceLineNo">134</span> if (state == State.RUNNING) {<a name="line.134"></a>
<span class="sourceLineNo">135</span> state = State.FAILED;<a name="line.135"></a>
<span class="sourceLineNo">136</span> }<a name="line.136"></a>
<span class="sourceLineNo">137</span> }<a name="line.137"></a>
<span class="sourceLineNo">138</span><a name="line.138"></a>
<span class="sourceLineNo">139</span> /**<a name="line.139"></a>
<span class="sourceLineNo">140</span> * Called by the ProcedureExecutor after the procedure step is completed,<a name="line.140"></a>
<span class="sourceLineNo">141</span> * to add the step to the rollback list (or procedure stack)<a name="line.141"></a>
<span class="sourceLineNo">142</span> */<a name="line.142"></a>
<span class="sourceLineNo">143</span> protected synchronized void addRollbackStep(Procedure&lt;TEnvironment&gt; proc) {<a name="line.143"></a>
<span class="sourceLineNo">144</span> if (proc.isFailed()) {<a name="line.144"></a>
<span class="sourceLineNo">145</span> state = State.FAILED;<a name="line.145"></a>
<span class="sourceLineNo">146</span> }<a name="line.146"></a>
<span class="sourceLineNo">147</span> if (subprocStack == null) {<a name="line.147"></a>
<span class="sourceLineNo">148</span> subprocStack = new ArrayList&lt;&gt;();<a name="line.148"></a>
<span class="sourceLineNo">149</span> }<a name="line.149"></a>
<span class="sourceLineNo">150</span> proc.addStackIndex(subprocStack.size());<a name="line.150"></a>
<span class="sourceLineNo">151</span> LOG.trace("Add procedure {} as the {}th rollback step", proc, subprocStack.size());<a name="line.151"></a>
<span class="sourceLineNo">152</span> subprocStack.add(proc);<a name="line.152"></a>
<span class="sourceLineNo">153</span> }<a name="line.153"></a>
<span class="sourceLineNo">154</span><a name="line.154"></a>
<span class="sourceLineNo">155</span> protected synchronized void addSubProcedure(Procedure&lt;TEnvironment&gt; proc) {<a name="line.155"></a>
<span class="sourceLineNo">156</span> if (!proc.hasParent()) {<a name="line.156"></a>
<span class="sourceLineNo">157</span> return;<a name="line.157"></a>
<span class="sourceLineNo">158</span> }<a name="line.158"></a>
<span class="sourceLineNo">159</span> if (subprocs == null) {<a name="line.159"></a>
<span class="sourceLineNo">160</span> subprocs = new HashSet&lt;&gt;();<a name="line.160"></a>
<span class="sourceLineNo">161</span> }<a name="line.161"></a>
<span class="sourceLineNo">162</span> subprocs.add(proc);<a name="line.162"></a>
<span class="sourceLineNo">163</span> }<a name="line.163"></a>
<span class="sourceLineNo">164</span><a name="line.164"></a>
<span class="sourceLineNo">165</span> /**<a name="line.165"></a>
<span class="sourceLineNo">166</span> * Called on store load by the ProcedureExecutor to load part of the stack.<a name="line.166"></a>
<span class="sourceLineNo">167</span> *<a name="line.167"></a>
<span class="sourceLineNo">168</span> * Each procedure has its own stack-positions. Which means we have to write<a name="line.168"></a>
<span class="sourceLineNo">169</span> * to the store only the Procedure we executed, and nothing else.<a name="line.169"></a>
<span class="sourceLineNo">170</span> * on load we recreate the full stack by aggregating each procedure stack-positions.<a name="line.170"></a>
<span class="sourceLineNo">171</span> */<a name="line.171"></a>
<span class="sourceLineNo">172</span> protected synchronized void loadStack(Procedure&lt;TEnvironment&gt; proc) {<a name="line.172"></a>
<span class="sourceLineNo">173</span> addSubProcedure(proc);<a name="line.173"></a>
<span class="sourceLineNo">174</span> int[] stackIndexes = proc.getStackIndexes();<a name="line.174"></a>
<span class="sourceLineNo">175</span> if (stackIndexes != null) {<a name="line.175"></a>
<span class="sourceLineNo">176</span> if (subprocStack == null) {<a name="line.176"></a>
<span class="sourceLineNo">177</span> subprocStack = new ArrayList&lt;&gt;();<a name="line.177"></a>
<span class="sourceLineNo">178</span> }<a name="line.178"></a>
<span class="sourceLineNo">179</span> int diff = (1 + stackIndexes[stackIndexes.length - 1]) - subprocStack.size();<a name="line.179"></a>
<span class="sourceLineNo">180</span> if (diff &gt; 0) {<a name="line.180"></a>
<span class="sourceLineNo">181</span> subprocStack.ensureCapacity(1 + stackIndexes[stackIndexes.length - 1]);<a name="line.181"></a>
<span class="sourceLineNo">182</span> while (diff-- &gt; 0) {<a name="line.182"></a>
<span class="sourceLineNo">183</span> subprocStack.add(null);<a name="line.183"></a>
<span class="sourceLineNo">184</span> }<a name="line.184"></a>
<span class="sourceLineNo">185</span> }<a name="line.185"></a>
<span class="sourceLineNo">186</span> for (int i = 0; i &lt; stackIndexes.length; ++i) {<a name="line.186"></a>
<span class="sourceLineNo">187</span> subprocStack.set(stackIndexes[i], proc);<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> if (proc.getState() == ProcedureState.ROLLEDBACK) {<a name="line.190"></a>
<span class="sourceLineNo">191</span> state = State.ROLLINGBACK;<a name="line.191"></a>
<span class="sourceLineNo">192</span> } else if (proc.isFailed()) {<a name="line.192"></a>
<span class="sourceLineNo">193</span> state = State.FAILED;<a name="line.193"></a>
<span class="sourceLineNo">194</span> }<a name="line.194"></a>
<span class="sourceLineNo">195</span> }<a name="line.195"></a>
<span class="sourceLineNo">196</span><a name="line.196"></a>
<span class="sourceLineNo">197</span> /**<a name="line.197"></a>
<span class="sourceLineNo">198</span> * Called on store load by the ProcedureExecutor to validate the procedure stack.<a name="line.198"></a>
<span class="sourceLineNo">199</span> */<a name="line.199"></a>
<span class="sourceLineNo">200</span> protected synchronized boolean isValid() {<a name="line.200"></a>
<span class="sourceLineNo">201</span> if (subprocStack != null) {<a name="line.201"></a>
<span class="sourceLineNo">202</span> for (Procedure&lt;TEnvironment&gt; proc : subprocStack) {<a name="line.202"></a>
<span class="sourceLineNo">203</span> if (proc == null) {<a name="line.203"></a>
<span class="sourceLineNo">204</span> return false;<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> }<a name="line.207"></a>
<span class="sourceLineNo">208</span> return true;<a name="line.208"></a>
<span class="sourceLineNo">209</span> }<a name="line.209"></a>
<span class="sourceLineNo">210</span>}<a name="line.210"></a>
</pre>
</div>
</body>
</html>