blob: 7080197b254e51c07a4df895dd2932158e8564fa [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><a name="line.18"></a>
<span class="sourceLineNo">019</span>package org.apache.hadoop.hbase.procedure2;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.io.IOException;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.lang.Thread.UncaughtExceptionHandler;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.HashSet;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.List;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.Optional;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.Set;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.concurrent.ConcurrentHashMap;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.concurrent.DelayQueue;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.concurrent.ThreadPoolExecutor;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.util.concurrent.TimeUnit;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import java.util.concurrent.atomic.AtomicBoolean;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.conf.Configuration;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.procedure2.util.DelayedUtil;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.procedure2.util.DelayedUtil.DelayedContainerWithTimestamp;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.procedure2.util.DelayedUtil.DelayedWithTimeout;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.procedure2.util.StringUtils;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.util.Threads;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.slf4j.Logger;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.slf4j.LoggerFactory;<a name="line.41"></a>
<span class="sourceLineNo">042</span><a name="line.42"></a>
<span class="sourceLineNo">043</span>import org.apache.hbase.thirdparty.com.google.common.collect.ArrayListMultimap;<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span>/**<a name="line.45"></a>
<span class="sourceLineNo">046</span> * A procedure dispatcher that aggregates and sends after elapsed time or after we hit<a name="line.46"></a>
<span class="sourceLineNo">047</span> * count threshold. Creates its own threadpool to run RPCs with timeout.<a name="line.47"></a>
<span class="sourceLineNo">048</span> * &lt;ul&gt;<a name="line.48"></a>
<span class="sourceLineNo">049</span> * &lt;li&gt;Each server queue has a dispatch buffer&lt;/li&gt;<a name="line.49"></a>
<span class="sourceLineNo">050</span> * &lt;li&gt;Once the dispatch buffer reaches a threshold-size/time we send&lt;li&gt;<a name="line.50"></a>
<span class="sourceLineNo">051</span> * &lt;/ul&gt;<a name="line.51"></a>
<span class="sourceLineNo">052</span> * &lt;p&gt;Call {@link #start()} and then {@link #submitTask(Runnable)}. When done,<a name="line.52"></a>
<span class="sourceLineNo">053</span> * call {@link #stop()}.<a name="line.53"></a>
<span class="sourceLineNo">054</span> */<a name="line.54"></a>
<span class="sourceLineNo">055</span>@InterfaceAudience.Private<a name="line.55"></a>
<span class="sourceLineNo">056</span>public abstract class RemoteProcedureDispatcher&lt;TEnv, TRemote extends Comparable&lt;TRemote&gt;&gt; {<a name="line.56"></a>
<span class="sourceLineNo">057</span> private static final Logger LOG = LoggerFactory.getLogger(RemoteProcedureDispatcher.class);<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span> public static final String THREAD_POOL_SIZE_CONF_KEY =<a name="line.59"></a>
<span class="sourceLineNo">060</span> "hbase.procedure.remote.dispatcher.threadpool.size";<a name="line.60"></a>
<span class="sourceLineNo">061</span> private static final int DEFAULT_THREAD_POOL_SIZE = 128;<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span> public static final String DISPATCH_DELAY_CONF_KEY =<a name="line.63"></a>
<span class="sourceLineNo">064</span> "hbase.procedure.remote.dispatcher.delay.msec";<a name="line.64"></a>
<span class="sourceLineNo">065</span> private static final int DEFAULT_DISPATCH_DELAY = 150;<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span> public static final String DISPATCH_MAX_QUEUE_SIZE_CONF_KEY =<a name="line.67"></a>
<span class="sourceLineNo">068</span> "hbase.procedure.remote.dispatcher.max.queue.size";<a name="line.68"></a>
<span class="sourceLineNo">069</span> private static final int DEFAULT_MAX_QUEUE_SIZE = 32;<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span> private final AtomicBoolean running = new AtomicBoolean(false);<a name="line.71"></a>
<span class="sourceLineNo">072</span> private final ConcurrentHashMap&lt;TRemote, BufferNode&gt; nodeMap =<a name="line.72"></a>
<span class="sourceLineNo">073</span> new ConcurrentHashMap&lt;TRemote, BufferNode&gt;();<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span> private final int operationDelay;<a name="line.75"></a>
<span class="sourceLineNo">076</span> private final int queueMaxSize;<a name="line.76"></a>
<span class="sourceLineNo">077</span> private final int corePoolSize;<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span> private TimeoutExecutorThread timeoutExecutor;<a name="line.79"></a>
<span class="sourceLineNo">080</span> private ThreadPoolExecutor threadPool;<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span> protected RemoteProcedureDispatcher(Configuration conf) {<a name="line.82"></a>
<span class="sourceLineNo">083</span> this.corePoolSize = conf.getInt(THREAD_POOL_SIZE_CONF_KEY, DEFAULT_THREAD_POOL_SIZE);<a name="line.83"></a>
<span class="sourceLineNo">084</span> this.operationDelay = conf.getInt(DISPATCH_DELAY_CONF_KEY, DEFAULT_DISPATCH_DELAY);<a name="line.84"></a>
<span class="sourceLineNo">085</span> this.queueMaxSize = conf.getInt(DISPATCH_MAX_QUEUE_SIZE_CONF_KEY, DEFAULT_MAX_QUEUE_SIZE);<a name="line.85"></a>
<span class="sourceLineNo">086</span> }<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span> public boolean start() {<a name="line.88"></a>
<span class="sourceLineNo">089</span> if (running.getAndSet(true)) {<a name="line.89"></a>
<span class="sourceLineNo">090</span> LOG.warn("Already running");<a name="line.90"></a>
<span class="sourceLineNo">091</span> return false;<a name="line.91"></a>
<span class="sourceLineNo">092</span> }<a name="line.92"></a>
<span class="sourceLineNo">093</span><a name="line.93"></a>
<span class="sourceLineNo">094</span> LOG.info("Instantiated, coreThreads={} (allowCoreThreadTimeOut=true), queueMaxSize={}, " +<a name="line.94"></a>
<span class="sourceLineNo">095</span> "operationDelay={}", this.corePoolSize, this.queueMaxSize, this.operationDelay);<a name="line.95"></a>
<span class="sourceLineNo">096</span><a name="line.96"></a>
<span class="sourceLineNo">097</span> // Create the timeout executor<a name="line.97"></a>
<span class="sourceLineNo">098</span> timeoutExecutor = new TimeoutExecutorThread();<a name="line.98"></a>
<span class="sourceLineNo">099</span> timeoutExecutor.start();<a name="line.99"></a>
<span class="sourceLineNo">100</span><a name="line.100"></a>
<span class="sourceLineNo">101</span> // Create the thread pool that will execute RPCs<a name="line.101"></a>
<span class="sourceLineNo">102</span> threadPool = Threads.getBoundedCachedThreadPool(corePoolSize, 60L, TimeUnit.SECONDS,<a name="line.102"></a>
<span class="sourceLineNo">103</span> Threads.newDaemonThreadFactory(this.getClass().getSimpleName(),<a name="line.103"></a>
<span class="sourceLineNo">104</span> getUncaughtExceptionHandler()));<a name="line.104"></a>
<span class="sourceLineNo">105</span> return true;<a name="line.105"></a>
<span class="sourceLineNo">106</span> }<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span> public boolean stop() {<a name="line.108"></a>
<span class="sourceLineNo">109</span> if (!running.getAndSet(false)) {<a name="line.109"></a>
<span class="sourceLineNo">110</span> return false;<a name="line.110"></a>
<span class="sourceLineNo">111</span> }<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span> LOG.info("Stopping procedure remote dispatcher");<a name="line.113"></a>
<span class="sourceLineNo">114</span><a name="line.114"></a>
<span class="sourceLineNo">115</span> // send stop signals<a name="line.115"></a>
<span class="sourceLineNo">116</span> timeoutExecutor.sendStopSignal();<a name="line.116"></a>
<span class="sourceLineNo">117</span> threadPool.shutdownNow();<a name="line.117"></a>
<span class="sourceLineNo">118</span> return true;<a name="line.118"></a>
<span class="sourceLineNo">119</span> }<a name="line.119"></a>
<span class="sourceLineNo">120</span><a name="line.120"></a>
<span class="sourceLineNo">121</span> public void join() {<a name="line.121"></a>
<span class="sourceLineNo">122</span> assert !running.get() : "expected not running";<a name="line.122"></a>
<span class="sourceLineNo">123</span><a name="line.123"></a>
<span class="sourceLineNo">124</span> // wait the timeout executor<a name="line.124"></a>
<span class="sourceLineNo">125</span> timeoutExecutor.awaitTermination();<a name="line.125"></a>
<span class="sourceLineNo">126</span> timeoutExecutor = null;<a name="line.126"></a>
<span class="sourceLineNo">127</span><a name="line.127"></a>
<span class="sourceLineNo">128</span> // wait for the thread pool to terminate<a name="line.128"></a>
<span class="sourceLineNo">129</span> threadPool.shutdownNow();<a name="line.129"></a>
<span class="sourceLineNo">130</span> try {<a name="line.130"></a>
<span class="sourceLineNo">131</span> while (!threadPool.awaitTermination(60, TimeUnit.SECONDS)) {<a name="line.131"></a>
<span class="sourceLineNo">132</span> LOG.warn("Waiting for thread-pool to terminate");<a name="line.132"></a>
<span class="sourceLineNo">133</span> }<a name="line.133"></a>
<span class="sourceLineNo">134</span> } catch (InterruptedException e) {<a name="line.134"></a>
<span class="sourceLineNo">135</span> LOG.warn("Interrupted while waiting for thread-pool termination", e);<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> protected abstract UncaughtExceptionHandler getUncaughtExceptionHandler();<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span> // ============================================================================================<a name="line.141"></a>
<span class="sourceLineNo">142</span> // Node Helpers<a name="line.142"></a>
<span class="sourceLineNo">143</span> // ============================================================================================<a name="line.143"></a>
<span class="sourceLineNo">144</span> /**<a name="line.144"></a>
<span class="sourceLineNo">145</span> * Add a node that will be able to execute remote procedures<a name="line.145"></a>
<span class="sourceLineNo">146</span> * @param key the node identifier<a name="line.146"></a>
<span class="sourceLineNo">147</span> */<a name="line.147"></a>
<span class="sourceLineNo">148</span> public void addNode(final TRemote key) {<a name="line.148"></a>
<span class="sourceLineNo">149</span> assert key != null: "Tried to add a node with a null key";<a name="line.149"></a>
<span class="sourceLineNo">150</span> final BufferNode newNode = new BufferNode(key);<a name="line.150"></a>
<span class="sourceLineNo">151</span> nodeMap.putIfAbsent(key, newNode);<a name="line.151"></a>
<span class="sourceLineNo">152</span> }<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> * Add a remote rpc.<a name="line.155"></a>
<span class="sourceLineNo">156</span> * @param key the node identifier<a name="line.156"></a>
<span class="sourceLineNo">157</span> */<a name="line.157"></a>
<span class="sourceLineNo">158</span> public void addOperationToNode(final TRemote key, RemoteProcedure rp)<a name="line.158"></a>
<span class="sourceLineNo">159</span> throws NullTargetServerDispatchException, NoServerDispatchException,<a name="line.159"></a>
<span class="sourceLineNo">160</span> NoNodeDispatchException {<a name="line.160"></a>
<span class="sourceLineNo">161</span> if (key == null) {<a name="line.161"></a>
<span class="sourceLineNo">162</span> throw new NullTargetServerDispatchException(rp.toString());<a name="line.162"></a>
<span class="sourceLineNo">163</span> }<a name="line.163"></a>
<span class="sourceLineNo">164</span> BufferNode node = nodeMap.get(key);<a name="line.164"></a>
<span class="sourceLineNo">165</span> if (node == null) {<a name="line.165"></a>
<span class="sourceLineNo">166</span> // If null here, it means node has been removed because it crashed. This happens when server<a name="line.166"></a>
<span class="sourceLineNo">167</span> // is expired in ServerManager. ServerCrashProcedure may or may not have run.<a name="line.167"></a>
<span class="sourceLineNo">168</span> throw new NoServerDispatchException(key.toString() + "; " + rp.toString());<a name="line.168"></a>
<span class="sourceLineNo">169</span> }<a name="line.169"></a>
<span class="sourceLineNo">170</span> node.add(rp);<a name="line.170"></a>
<span class="sourceLineNo">171</span> // Check our node still in the map; could have been removed by #removeNode.<a name="line.171"></a>
<span class="sourceLineNo">172</span> if (!nodeMap.containsValue(node)) {<a name="line.172"></a>
<span class="sourceLineNo">173</span> throw new NoNodeDispatchException(key.toString() + "; " + rp.toString());<a name="line.173"></a>
<span class="sourceLineNo">174</span> }<a name="line.174"></a>
<span class="sourceLineNo">175</span> }<a name="line.175"></a>
<span class="sourceLineNo">176</span><a name="line.176"></a>
<span class="sourceLineNo">177</span> public void removeCompletedOperation(final TRemote key, RemoteProcedure rp) {<a name="line.177"></a>
<span class="sourceLineNo">178</span> BufferNode node = nodeMap.get(key);<a name="line.178"></a>
<span class="sourceLineNo">179</span> if (node == null) {<a name="line.179"></a>
<span class="sourceLineNo">180</span> LOG.warn("since no node for this key {}, we can't removed the finished remote procedure",<a name="line.180"></a>
<span class="sourceLineNo">181</span> key);<a name="line.181"></a>
<span class="sourceLineNo">182</span> return;<a name="line.182"></a>
<span class="sourceLineNo">183</span> }<a name="line.183"></a>
<span class="sourceLineNo">184</span> node.operationCompleted(rp);<a name="line.184"></a>
<span class="sourceLineNo">185</span> }<a name="line.185"></a>
<span class="sourceLineNo">186</span><a name="line.186"></a>
<span class="sourceLineNo">187</span> /**<a name="line.187"></a>
<span class="sourceLineNo">188</span> * Remove a remote node<a name="line.188"></a>
<span class="sourceLineNo">189</span> * @param key the node identifier<a name="line.189"></a>
<span class="sourceLineNo">190</span> */<a name="line.190"></a>
<span class="sourceLineNo">191</span> public boolean removeNode(final TRemote key) {<a name="line.191"></a>
<span class="sourceLineNo">192</span> final BufferNode node = nodeMap.remove(key);<a name="line.192"></a>
<span class="sourceLineNo">193</span> if (node == null) {<a name="line.193"></a>
<span class="sourceLineNo">194</span> return false;<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> node.abortOperationsInQueue();<a name="line.197"></a>
<span class="sourceLineNo">198</span> return true;<a name="line.198"></a>
<span class="sourceLineNo">199</span> }<a name="line.199"></a>
<span class="sourceLineNo">200</span><a name="line.200"></a>
<span class="sourceLineNo">201</span> // ============================================================================================<a name="line.201"></a>
<span class="sourceLineNo">202</span> // Task Helpers<a name="line.202"></a>
<span class="sourceLineNo">203</span> // ============================================================================================<a name="line.203"></a>
<span class="sourceLineNo">204</span> protected final void submitTask(Runnable task) {<a name="line.204"></a>
<span class="sourceLineNo">205</span> threadPool.execute(task);<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> protected final void submitTask(Runnable task, long delay, TimeUnit unit) {<a name="line.208"></a>
<span class="sourceLineNo">209</span> timeoutExecutor.add(new DelayedTask(task, delay, unit));<a name="line.209"></a>
<span class="sourceLineNo">210</span> }<a name="line.210"></a>
<span class="sourceLineNo">211</span><a name="line.211"></a>
<span class="sourceLineNo">212</span> protected abstract void remoteDispatch(TRemote key, Set&lt;RemoteProcedure&gt; operations);<a name="line.212"></a>
<span class="sourceLineNo">213</span> protected abstract void abortPendingOperations(TRemote key, Set&lt;RemoteProcedure&gt; operations);<a name="line.213"></a>
<span class="sourceLineNo">214</span><a name="line.214"></a>
<span class="sourceLineNo">215</span> /**<a name="line.215"></a>
<span class="sourceLineNo">216</span> * Data structure with reference to remote operation.<a name="line.216"></a>
<span class="sourceLineNo">217</span> */<a name="line.217"></a>
<span class="sourceLineNo">218</span> public static abstract class RemoteOperation {<a name="line.218"></a>
<span class="sourceLineNo">219</span> private final RemoteProcedure remoteProcedure;<a name="line.219"></a>
<span class="sourceLineNo">220</span><a name="line.220"></a>
<span class="sourceLineNo">221</span> protected RemoteOperation(final RemoteProcedure remoteProcedure) {<a name="line.221"></a>
<span class="sourceLineNo">222</span> this.remoteProcedure = remoteProcedure;<a name="line.222"></a>
<span class="sourceLineNo">223</span> }<a name="line.223"></a>
<span class="sourceLineNo">224</span><a name="line.224"></a>
<span class="sourceLineNo">225</span> public RemoteProcedure getRemoteProcedure() {<a name="line.225"></a>
<span class="sourceLineNo">226</span> return remoteProcedure;<a name="line.226"></a>
<span class="sourceLineNo">227</span> }<a name="line.227"></a>
<span class="sourceLineNo">228</span> }<a name="line.228"></a>
<span class="sourceLineNo">229</span><a name="line.229"></a>
<span class="sourceLineNo">230</span> /**<a name="line.230"></a>
<span class="sourceLineNo">231</span> * Remote procedure reference.<a name="line.231"></a>
<span class="sourceLineNo">232</span> */<a name="line.232"></a>
<span class="sourceLineNo">233</span> public interface RemoteProcedure&lt;TEnv, TRemote&gt; {<a name="line.233"></a>
<span class="sourceLineNo">234</span> /**<a name="line.234"></a>
<span class="sourceLineNo">235</span> * For building the remote operation.<a name="line.235"></a>
<span class="sourceLineNo">236</span> * May be empty if no need to send remote call. Usually, this means the RemoteProcedure has been<a name="line.236"></a>
<span class="sourceLineNo">237</span> * finished already. This is possible, as we may have already sent the procedure to RS but then<a name="line.237"></a>
<span class="sourceLineNo">238</span> * the rpc connection is broken so the executeProcedures call fails, but the RS does receive the<a name="line.238"></a>
<span class="sourceLineNo">239</span> * procedure and execute it and then report back, before we retry again.<a name="line.239"></a>
<span class="sourceLineNo">240</span> */<a name="line.240"></a>
<span class="sourceLineNo">241</span> Optional&lt;RemoteOperation&gt; remoteCallBuild(TEnv env, TRemote remote);<a name="line.241"></a>
<span class="sourceLineNo">242</span><a name="line.242"></a>
<span class="sourceLineNo">243</span> /**<a name="line.243"></a>
<span class="sourceLineNo">244</span> * Called when the executeProcedure call is failed.<a name="line.244"></a>
<span class="sourceLineNo">245</span> */<a name="line.245"></a>
<span class="sourceLineNo">246</span> void remoteCallFailed(TEnv env, TRemote remote, IOException exception);<a name="line.246"></a>
<span class="sourceLineNo">247</span><a name="line.247"></a>
<span class="sourceLineNo">248</span> /**<a name="line.248"></a>
<span class="sourceLineNo">249</span> * Called when RS tells the remote procedure is succeeded through the<a name="line.249"></a>
<span class="sourceLineNo">250</span> * {@code reportProcedureDone} method.<a name="line.250"></a>
<span class="sourceLineNo">251</span> */<a name="line.251"></a>
<span class="sourceLineNo">252</span> void remoteOperationCompleted(TEnv env);<a name="line.252"></a>
<span class="sourceLineNo">253</span><a name="line.253"></a>
<span class="sourceLineNo">254</span> /**<a name="line.254"></a>
<span class="sourceLineNo">255</span> * Called when RS tells the remote procedure is failed through the {@code reportProcedureDone}<a name="line.255"></a>
<span class="sourceLineNo">256</span> * method.<a name="line.256"></a>
<span class="sourceLineNo">257</span> */<a name="line.257"></a>
<span class="sourceLineNo">258</span> void remoteOperationFailed(TEnv env, RemoteProcedureException error);<a name="line.258"></a>
<span class="sourceLineNo">259</span><a name="line.259"></a>
<span class="sourceLineNo">260</span> /**<a name="line.260"></a>
<span class="sourceLineNo">261</span> * Whether store this remote procedure in dispatched queue<a name="line.261"></a>
<span class="sourceLineNo">262</span> * only OpenRegionProcedure and CloseRegionProcedure return false since they are<a name="line.262"></a>
<span class="sourceLineNo">263</span> * not fully controlled by dispatcher<a name="line.263"></a>
<span class="sourceLineNo">264</span> */<a name="line.264"></a>
<span class="sourceLineNo">265</span> default boolean storeInDispatchedQueue() {<a name="line.265"></a>
<span class="sourceLineNo">266</span> return true;<a name="line.266"></a>
<span class="sourceLineNo">267</span> }<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> /**<a name="line.270"></a>
<span class="sourceLineNo">271</span> * Account of what procedures are running on remote node.<a name="line.271"></a>
<span class="sourceLineNo">272</span> */<a name="line.272"></a>
<span class="sourceLineNo">273</span> public interface RemoteNode&lt;TEnv, TRemote&gt; {<a name="line.273"></a>
<span class="sourceLineNo">274</span> TRemote getKey();<a name="line.274"></a>
<span class="sourceLineNo">275</span><a name="line.275"></a>
<span class="sourceLineNo">276</span> void add(RemoteProcedure&lt;TEnv, TRemote&gt; operation);<a name="line.276"></a>
<span class="sourceLineNo">277</span><a name="line.277"></a>
<span class="sourceLineNo">278</span> void dispatch();<a name="line.278"></a>
<span class="sourceLineNo">279</span> }<a name="line.279"></a>
<span class="sourceLineNo">280</span><a name="line.280"></a>
<span class="sourceLineNo">281</span> protected ArrayListMultimap&lt;Class&lt;?&gt;, RemoteOperation&gt; buildAndGroupRequestByType(final TEnv env,<a name="line.281"></a>
<span class="sourceLineNo">282</span> final TRemote remote, final Set&lt;RemoteProcedure&gt; remoteProcedures) {<a name="line.282"></a>
<span class="sourceLineNo">283</span> final ArrayListMultimap&lt;Class&lt;?&gt;, RemoteOperation&gt; requestByType = ArrayListMultimap.create();<a name="line.283"></a>
<span class="sourceLineNo">284</span> for (RemoteProcedure proc : remoteProcedures) {<a name="line.284"></a>
<span class="sourceLineNo">285</span> Optional&lt;RemoteOperation&gt; operation = proc.remoteCallBuild(env, remote);<a name="line.285"></a>
<span class="sourceLineNo">286</span> operation.ifPresent(op -&gt; requestByType.put(op.getClass(), op));<a name="line.286"></a>
<span class="sourceLineNo">287</span> }<a name="line.287"></a>
<span class="sourceLineNo">288</span> return requestByType;<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> protected &lt;T extends RemoteOperation&gt; List&lt;T&gt; fetchType(<a name="line.291"></a>
<span class="sourceLineNo">292</span> final ArrayListMultimap&lt;Class&lt;?&gt;, RemoteOperation&gt; requestByType, final Class&lt;T&gt; type) {<a name="line.292"></a>
<span class="sourceLineNo">293</span> return (List&lt;T&gt;)requestByType.removeAll(type);<a name="line.293"></a>
<span class="sourceLineNo">294</span> }<a name="line.294"></a>
<span class="sourceLineNo">295</span><a name="line.295"></a>
<span class="sourceLineNo">296</span> // ============================================================================================<a name="line.296"></a>
<span class="sourceLineNo">297</span> // Timeout Helpers<a name="line.297"></a>
<span class="sourceLineNo">298</span> // ============================================================================================<a name="line.298"></a>
<span class="sourceLineNo">299</span> private final class TimeoutExecutorThread extends Thread {<a name="line.299"></a>
<span class="sourceLineNo">300</span> private final DelayQueue&lt;DelayedWithTimeout&gt; queue = new DelayQueue&lt;DelayedWithTimeout&gt;();<a name="line.300"></a>
<span class="sourceLineNo">301</span><a name="line.301"></a>
<span class="sourceLineNo">302</span> public TimeoutExecutorThread() {<a name="line.302"></a>
<span class="sourceLineNo">303</span> super("ProcedureDispatcherTimeoutThread");<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> @Override<a name="line.306"></a>
<span class="sourceLineNo">307</span> public void run() {<a name="line.307"></a>
<span class="sourceLineNo">308</span> while (running.get()) {<a name="line.308"></a>
<span class="sourceLineNo">309</span> final DelayedWithTimeout task = DelayedUtil.takeWithoutInterrupt(queue);<a name="line.309"></a>
<span class="sourceLineNo">310</span> if (task == null || task == DelayedUtil.DELAYED_POISON) {<a name="line.310"></a>
<span class="sourceLineNo">311</span> // the executor may be shutting down, and the task is just the shutdown request<a name="line.311"></a>
<span class="sourceLineNo">312</span> continue;<a name="line.312"></a>
<span class="sourceLineNo">313</span> }<a name="line.313"></a>
<span class="sourceLineNo">314</span> if (task instanceof DelayedTask) {<a name="line.314"></a>
<span class="sourceLineNo">315</span> threadPool.execute(((DelayedTask) task).getObject());<a name="line.315"></a>
<span class="sourceLineNo">316</span> } else {<a name="line.316"></a>
<span class="sourceLineNo">317</span> ((BufferNode) task).dispatch();<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><a name="line.321"></a>
<span class="sourceLineNo">322</span> public void add(final DelayedWithTimeout delayed) {<a name="line.322"></a>
<span class="sourceLineNo">323</span> queue.add(delayed);<a name="line.323"></a>
<span class="sourceLineNo">324</span> }<a name="line.324"></a>
<span class="sourceLineNo">325</span><a name="line.325"></a>
<span class="sourceLineNo">326</span> public void remove(final DelayedWithTimeout delayed) {<a name="line.326"></a>
<span class="sourceLineNo">327</span> queue.remove(delayed);<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> public void sendStopSignal() {<a name="line.330"></a>
<span class="sourceLineNo">331</span> queue.add(DelayedUtil.DELAYED_POISON);<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> public void awaitTermination() {<a name="line.334"></a>
<span class="sourceLineNo">335</span> try {<a name="line.335"></a>
<span class="sourceLineNo">336</span> final long startTime = EnvironmentEdgeManager.currentTime();<a name="line.336"></a>
<span class="sourceLineNo">337</span> for (int i = 0; isAlive(); ++i) {<a name="line.337"></a>
<span class="sourceLineNo">338</span> sendStopSignal();<a name="line.338"></a>
<span class="sourceLineNo">339</span> join(250);<a name="line.339"></a>
<span class="sourceLineNo">340</span> if (i &gt; 0 &amp;&amp; (i % 8) == 0) {<a name="line.340"></a>
<span class="sourceLineNo">341</span> LOG.warn("Waiting termination of thread " + getName() + ", " +<a name="line.341"></a>
<span class="sourceLineNo">342</span> StringUtils.humanTimeDiff(EnvironmentEdgeManager.currentTime() - startTime));<a name="line.342"></a>
<span class="sourceLineNo">343</span> }<a name="line.343"></a>
<span class="sourceLineNo">344</span> }<a name="line.344"></a>
<span class="sourceLineNo">345</span> } catch (InterruptedException e) {<a name="line.345"></a>
<span class="sourceLineNo">346</span> LOG.warn(getName() + " join wait got interrupted", e);<a name="line.346"></a>
<span class="sourceLineNo">347</span> }<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> // ============================================================================================<a name="line.351"></a>
<span class="sourceLineNo">352</span> // Internals Helpers<a name="line.352"></a>
<span class="sourceLineNo">353</span> // ============================================================================================<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> * Node that contains a set of RemoteProcedures<a name="line.356"></a>
<span class="sourceLineNo">357</span> */<a name="line.357"></a>
<span class="sourceLineNo">358</span> protected final class BufferNode extends DelayedContainerWithTimestamp&lt;TRemote&gt;<a name="line.358"></a>
<span class="sourceLineNo">359</span> implements RemoteNode&lt;TEnv, TRemote&gt; {<a name="line.359"></a>
<span class="sourceLineNo">360</span> private Set&lt;RemoteProcedure&gt; operations;<a name="line.360"></a>
<span class="sourceLineNo">361</span> private final Set&lt;RemoteProcedure&gt; dispatchedOperations = new HashSet&lt;&gt;();<a name="line.361"></a>
<span class="sourceLineNo">362</span><a name="line.362"></a>
<span class="sourceLineNo">363</span> protected BufferNode(final TRemote key) {<a name="line.363"></a>
<span class="sourceLineNo">364</span> super(key, 0);<a name="line.364"></a>
<span class="sourceLineNo">365</span> }<a name="line.365"></a>
<span class="sourceLineNo">366</span><a name="line.366"></a>
<span class="sourceLineNo">367</span> @Override<a name="line.367"></a>
<span class="sourceLineNo">368</span> public TRemote getKey() {<a name="line.368"></a>
<span class="sourceLineNo">369</span> return getObject();<a name="line.369"></a>
<span class="sourceLineNo">370</span> }<a name="line.370"></a>
<span class="sourceLineNo">371</span><a name="line.371"></a>
<span class="sourceLineNo">372</span> @Override<a name="line.372"></a>
<span class="sourceLineNo">373</span> public synchronized void add(final RemoteProcedure operation) {<a name="line.373"></a>
<span class="sourceLineNo">374</span> if (this.operations == null) {<a name="line.374"></a>
<span class="sourceLineNo">375</span> this.operations = new HashSet&lt;&gt;();<a name="line.375"></a>
<span class="sourceLineNo">376</span> setTimeout(EnvironmentEdgeManager.currentTime() + operationDelay);<a name="line.376"></a>
<span class="sourceLineNo">377</span> timeoutExecutor.add(this);<a name="line.377"></a>
<span class="sourceLineNo">378</span> }<a name="line.378"></a>
<span class="sourceLineNo">379</span> this.operations.add(operation);<a name="line.379"></a>
<span class="sourceLineNo">380</span> if (this.operations.size() &gt; queueMaxSize) {<a name="line.380"></a>
<span class="sourceLineNo">381</span> timeoutExecutor.remove(this);<a name="line.381"></a>
<span class="sourceLineNo">382</span> dispatch();<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><a name="line.385"></a>
<span class="sourceLineNo">386</span> @Override<a name="line.386"></a>
<span class="sourceLineNo">387</span> public synchronized void dispatch() {<a name="line.387"></a>
<span class="sourceLineNo">388</span> if (operations != null) {<a name="line.388"></a>
<span class="sourceLineNo">389</span> remoteDispatch(getKey(), operations);<a name="line.389"></a>
<span class="sourceLineNo">390</span> operations.stream().filter(operation -&gt; operation.storeInDispatchedQueue())<a name="line.390"></a>
<span class="sourceLineNo">391</span> .forEach(operation -&gt; dispatchedOperations.add(operation));<a name="line.391"></a>
<span class="sourceLineNo">392</span> this.operations = null;<a name="line.392"></a>
<span class="sourceLineNo">393</span> }<a name="line.393"></a>
<span class="sourceLineNo">394</span> }<a name="line.394"></a>
<span class="sourceLineNo">395</span><a name="line.395"></a>
<span class="sourceLineNo">396</span> public synchronized void abortOperationsInQueue() {<a name="line.396"></a>
<span class="sourceLineNo">397</span> if (operations != null) {<a name="line.397"></a>
<span class="sourceLineNo">398</span> abortPendingOperations(getKey(), operations);<a name="line.398"></a>
<span class="sourceLineNo">399</span> this.operations = null;<a name="line.399"></a>
<span class="sourceLineNo">400</span> }<a name="line.400"></a>
<span class="sourceLineNo">401</span> abortPendingOperations(getKey(), dispatchedOperations);<a name="line.401"></a>
<span class="sourceLineNo">402</span> this.dispatchedOperations.clear();<a name="line.402"></a>
<span class="sourceLineNo">403</span> }<a name="line.403"></a>
<span class="sourceLineNo">404</span><a name="line.404"></a>
<span class="sourceLineNo">405</span> public synchronized void operationCompleted(final RemoteProcedure remoteProcedure){<a name="line.405"></a>
<span class="sourceLineNo">406</span> this.dispatchedOperations.remove(remoteProcedure);<a name="line.406"></a>
<span class="sourceLineNo">407</span> }<a name="line.407"></a>
<span class="sourceLineNo">408</span><a name="line.408"></a>
<span class="sourceLineNo">409</span> @Override<a name="line.409"></a>
<span class="sourceLineNo">410</span> public String toString() {<a name="line.410"></a>
<span class="sourceLineNo">411</span> return super.toString() + ", operations=" + this.operations;<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><a name="line.414"></a>
<span class="sourceLineNo">415</span> /**<a name="line.415"></a>
<span class="sourceLineNo">416</span> * Delayed object that holds a FutureTask.<a name="line.416"></a>
<span class="sourceLineNo">417</span> * &lt;p/&gt;<a name="line.417"></a>
<span class="sourceLineNo">418</span> * used to submit something later to the thread-pool.<a name="line.418"></a>
<span class="sourceLineNo">419</span> */<a name="line.419"></a>
<span class="sourceLineNo">420</span> private static final class DelayedTask extends DelayedContainerWithTimestamp&lt;Runnable&gt; {<a name="line.420"></a>
<span class="sourceLineNo">421</span> public DelayedTask(Runnable task, long delay, TimeUnit unit) {<a name="line.421"></a>
<span class="sourceLineNo">422</span> super(task, EnvironmentEdgeManager.currentTime() + unit.toMillis(delay));<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>}<a name="line.425"></a>
</pre>
</div>
</body>
</html>