| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.hadoop.hbase.procedure2, class: RemoteProcedureDispatcher, class: BufferNode"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.procedure2;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import com.google.errorprone.annotations.RestrictedApi;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.io.IOException;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.lang.Thread.UncaughtExceptionHandler;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.util.HashSet;</span> |
| <span class="source-line-no">024</span><span id="line-24">import java.util.List;</span> |
| <span class="source-line-no">025</span><span id="line-25">import java.util.Optional;</span> |
| <span class="source-line-no">026</span><span id="line-26">import java.util.Set;</span> |
| <span class="source-line-no">027</span><span id="line-27">import java.util.concurrent.ConcurrentHashMap;</span> |
| <span class="source-line-no">028</span><span id="line-28">import java.util.concurrent.DelayQueue;</span> |
| <span class="source-line-no">029</span><span id="line-29">import java.util.concurrent.ThreadPoolExecutor;</span> |
| <span class="source-line-no">030</span><span id="line-30">import java.util.concurrent.TimeUnit;</span> |
| <span class="source-line-no">031</span><span id="line-31">import java.util.concurrent.atomic.AtomicBoolean;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.procedure2.util.DelayedUtil;</span> |
| <span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.procedure2.util.DelayedUtil.DelayedContainerWithTimestamp;</span> |
| <span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.procedure2.util.DelayedUtil.DelayedWithTimeout;</span> |
| <span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.procedure2.util.StringUtils;</span> |
| <span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;</span> |
| <span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.util.Threads;</span> |
| <span class="source-line-no">039</span><span id="line-39">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">040</span><span id="line-40">import org.slf4j.Logger;</span> |
| <span class="source-line-no">041</span><span id="line-41">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">042</span><span id="line-42"></span> |
| <span class="source-line-no">043</span><span id="line-43">import org.apache.hbase.thirdparty.com.google.common.collect.ArrayListMultimap;</span> |
| <span class="source-line-no">044</span><span id="line-44">import org.apache.hbase.thirdparty.com.google.common.util.concurrent.ThreadFactoryBuilder;</span> |
| <span class="source-line-no">045</span><span id="line-45"></span> |
| <span class="source-line-no">046</span><span id="line-46">/**</span> |
| <span class="source-line-no">047</span><span id="line-47"> * A procedure dispatcher that aggregates and sends after elapsed time or after we hit count</span> |
| <span class="source-line-no">048</span><span id="line-48"> * threshold. Creates its own threadpool to run RPCs with timeout.</span> |
| <span class="source-line-no">049</span><span id="line-49"> * <ul></span> |
| <span class="source-line-no">050</span><span id="line-50"> * <li>Each server queue has a dispatch buffer</li></span> |
| <span class="source-line-no">051</span><span id="line-51"> * <li>Once the dispatch buffer reaches a threshold-size/time we send</span> |
| <span class="source-line-no">052</span><span id="line-52"> * <li></span> |
| <span class="source-line-no">053</span><span id="line-53"> * </ul></span> |
| <span class="source-line-no">054</span><span id="line-54"> * <p></span> |
| <span class="source-line-no">055</span><span id="line-55"> * Call {@link #start()} and then {@link #submitTask(Runnable)}. When done, call {@link #stop()}.</span> |
| <span class="source-line-no">056</span><span id="line-56"> */</span> |
| <span class="source-line-no">057</span><span id="line-57">@InterfaceAudience.Private</span> |
| <span class="source-line-no">058</span><span id="line-58">public abstract class RemoteProcedureDispatcher<TEnv, TRemote extends Comparable<TRemote>> {</span> |
| <span class="source-line-no">059</span><span id="line-59"> private static final Logger LOG = LoggerFactory.getLogger(RemoteProcedureDispatcher.class);</span> |
| <span class="source-line-no">060</span><span id="line-60"></span> |
| <span class="source-line-no">061</span><span id="line-61"> public static final String THREAD_POOL_SIZE_CONF_KEY =</span> |
| <span class="source-line-no">062</span><span id="line-62"> "hbase.procedure.remote.dispatcher.threadpool.size";</span> |
| <span class="source-line-no">063</span><span id="line-63"> private static final int DEFAULT_THREAD_POOL_SIZE = 128;</span> |
| <span class="source-line-no">064</span><span id="line-64"></span> |
| <span class="source-line-no">065</span><span id="line-65"> public static final String DISPATCH_DELAY_CONF_KEY =</span> |
| <span class="source-line-no">066</span><span id="line-66"> "hbase.procedure.remote.dispatcher.delay.msec";</span> |
| <span class="source-line-no">067</span><span id="line-67"> private static final int DEFAULT_DISPATCH_DELAY = 150;</span> |
| <span class="source-line-no">068</span><span id="line-68"></span> |
| <span class="source-line-no">069</span><span id="line-69"> public static final String DISPATCH_MAX_QUEUE_SIZE_CONF_KEY =</span> |
| <span class="source-line-no">070</span><span id="line-70"> "hbase.procedure.remote.dispatcher.max.queue.size";</span> |
| <span class="source-line-no">071</span><span id="line-71"> private static final int DEFAULT_MAX_QUEUE_SIZE = 32;</span> |
| <span class="source-line-no">072</span><span id="line-72"></span> |
| <span class="source-line-no">073</span><span id="line-73"> private final AtomicBoolean running = new AtomicBoolean(false);</span> |
| <span class="source-line-no">074</span><span id="line-74"> private final ConcurrentHashMap<TRemote, BufferNode> nodeMap =</span> |
| <span class="source-line-no">075</span><span id="line-75"> new ConcurrentHashMap<TRemote, BufferNode>();</span> |
| <span class="source-line-no">076</span><span id="line-76"></span> |
| <span class="source-line-no">077</span><span id="line-77"> private final int operationDelay;</span> |
| <span class="source-line-no">078</span><span id="line-78"> private final int queueMaxSize;</span> |
| <span class="source-line-no">079</span><span id="line-79"> private final int corePoolSize;</span> |
| <span class="source-line-no">080</span><span id="line-80"></span> |
| <span class="source-line-no">081</span><span id="line-81"> private TimeoutExecutorThread timeoutExecutor;</span> |
| <span class="source-line-no">082</span><span id="line-82"> private ThreadPoolExecutor threadPool;</span> |
| <span class="source-line-no">083</span><span id="line-83"></span> |
| <span class="source-line-no">084</span><span id="line-84"> protected RemoteProcedureDispatcher(Configuration conf) {</span> |
| <span class="source-line-no">085</span><span id="line-85"> this.corePoolSize = conf.getInt(THREAD_POOL_SIZE_CONF_KEY, DEFAULT_THREAD_POOL_SIZE);</span> |
| <span class="source-line-no">086</span><span id="line-86"> this.operationDelay = conf.getInt(DISPATCH_DELAY_CONF_KEY, DEFAULT_DISPATCH_DELAY);</span> |
| <span class="source-line-no">087</span><span id="line-87"> this.queueMaxSize = conf.getInt(DISPATCH_MAX_QUEUE_SIZE_CONF_KEY, DEFAULT_MAX_QUEUE_SIZE);</span> |
| <span class="source-line-no">088</span><span id="line-88"> }</span> |
| <span class="source-line-no">089</span><span id="line-89"></span> |
| <span class="source-line-no">090</span><span id="line-90"> public boolean start() {</span> |
| <span class="source-line-no">091</span><span id="line-91"> if (running.getAndSet(true)) {</span> |
| <span class="source-line-no">092</span><span id="line-92"> LOG.warn("Already running");</span> |
| <span class="source-line-no">093</span><span id="line-93"> return false;</span> |
| <span class="source-line-no">094</span><span id="line-94"> }</span> |
| <span class="source-line-no">095</span><span id="line-95"></span> |
| <span class="source-line-no">096</span><span id="line-96"> LOG.info("Instantiated, coreThreads={} (allowCoreThreadTimeOut=true), queueMaxSize={}, "</span> |
| <span class="source-line-no">097</span><span id="line-97"> + "operationDelay={}", this.corePoolSize, this.queueMaxSize, this.operationDelay);</span> |
| <span class="source-line-no">098</span><span id="line-98"></span> |
| <span class="source-line-no">099</span><span id="line-99"> // Create the timeout executor</span> |
| <span class="source-line-no">100</span><span id="line-100"> timeoutExecutor = new TimeoutExecutorThread();</span> |
| <span class="source-line-no">101</span><span id="line-101"> timeoutExecutor.start();</span> |
| <span class="source-line-no">102</span><span id="line-102"></span> |
| <span class="source-line-no">103</span><span id="line-103"> // Create the thread pool that will execute RPCs</span> |
| <span class="source-line-no">104</span><span id="line-104"> threadPool = Threads.getBoundedCachedThreadPool(corePoolSize, 60L, TimeUnit.SECONDS,</span> |
| <span class="source-line-no">105</span><span id="line-105"> new ThreadFactoryBuilder().setNameFormat(this.getClass().getSimpleName() + "-pool-%d")</span> |
| <span class="source-line-no">106</span><span id="line-106"> .setDaemon(true).setUncaughtExceptionHandler(getUncaughtExceptionHandler()).build());</span> |
| <span class="source-line-no">107</span><span id="line-107"> return true;</span> |
| <span class="source-line-no">108</span><span id="line-108"> }</span> |
| <span class="source-line-no">109</span><span id="line-109"></span> |
| <span class="source-line-no">110</span><span id="line-110"> protected void setTimeoutExecutorUncaughtExceptionHandler(UncaughtExceptionHandler eh) {</span> |
| <span class="source-line-no">111</span><span id="line-111"> timeoutExecutor.setUncaughtExceptionHandler(eh);</span> |
| <span class="source-line-no">112</span><span id="line-112"> }</span> |
| <span class="source-line-no">113</span><span id="line-113"></span> |
| <span class="source-line-no">114</span><span id="line-114"> public boolean stop() {</span> |
| <span class="source-line-no">115</span><span id="line-115"> if (!running.getAndSet(false)) {</span> |
| <span class="source-line-no">116</span><span id="line-116"> return false;</span> |
| <span class="source-line-no">117</span><span id="line-117"> }</span> |
| <span class="source-line-no">118</span><span id="line-118"></span> |
| <span class="source-line-no">119</span><span id="line-119"> LOG.info("Stopping procedure remote dispatcher");</span> |
| <span class="source-line-no">120</span><span id="line-120"></span> |
| <span class="source-line-no">121</span><span id="line-121"> // send stop signals</span> |
| <span class="source-line-no">122</span><span id="line-122"> timeoutExecutor.sendStopSignal();</span> |
| <span class="source-line-no">123</span><span id="line-123"> threadPool.shutdownNow();</span> |
| <span class="source-line-no">124</span><span id="line-124"> return true;</span> |
| <span class="source-line-no">125</span><span id="line-125"> }</span> |
| <span class="source-line-no">126</span><span id="line-126"></span> |
| <span class="source-line-no">127</span><span id="line-127"> public void join() {</span> |
| <span class="source-line-no">128</span><span id="line-128"> assert !running.get() : "expected not running";</span> |
| <span class="source-line-no">129</span><span id="line-129"></span> |
| <span class="source-line-no">130</span><span id="line-130"> // wait the timeout executor</span> |
| <span class="source-line-no">131</span><span id="line-131"> timeoutExecutor.awaitTermination();</span> |
| <span class="source-line-no">132</span><span id="line-132"> timeoutExecutor = null;</span> |
| <span class="source-line-no">133</span><span id="line-133"></span> |
| <span class="source-line-no">134</span><span id="line-134"> // wait for the thread pool to terminate</span> |
| <span class="source-line-no">135</span><span id="line-135"> threadPool.shutdownNow();</span> |
| <span class="source-line-no">136</span><span id="line-136"> try {</span> |
| <span class="source-line-no">137</span><span id="line-137"> while (!threadPool.awaitTermination(60, TimeUnit.SECONDS)) {</span> |
| <span class="source-line-no">138</span><span id="line-138"> LOG.warn("Waiting for thread-pool to terminate");</span> |
| <span class="source-line-no">139</span><span id="line-139"> }</span> |
| <span class="source-line-no">140</span><span id="line-140"> } catch (InterruptedException e) {</span> |
| <span class="source-line-no">141</span><span id="line-141"> LOG.warn("Interrupted while waiting for thread-pool termination", e);</span> |
| <span class="source-line-no">142</span><span id="line-142"> }</span> |
| <span class="source-line-no">143</span><span id="line-143"> }</span> |
| <span class="source-line-no">144</span><span id="line-144"></span> |
| <span class="source-line-no">145</span><span id="line-145"> protected abstract UncaughtExceptionHandler getUncaughtExceptionHandler();</span> |
| <span class="source-line-no">146</span><span id="line-146"></span> |
| <span class="source-line-no">147</span><span id="line-147"> // ============================================================================================</span> |
| <span class="source-line-no">148</span><span id="line-148"> // Node Helpers</span> |
| <span class="source-line-no">149</span><span id="line-149"> // ============================================================================================</span> |
| <span class="source-line-no">150</span><span id="line-150"> /**</span> |
| <span class="source-line-no">151</span><span id="line-151"> * Add a node that will be able to execute remote procedures</span> |
| <span class="source-line-no">152</span><span id="line-152"> * @param key the node identifier</span> |
| <span class="source-line-no">153</span><span id="line-153"> */</span> |
| <span class="source-line-no">154</span><span id="line-154"> public void addNode(final TRemote key) {</span> |
| <span class="source-line-no">155</span><span id="line-155"> assert key != null : "Tried to add a node with a null key";</span> |
| <span class="source-line-no">156</span><span id="line-156"> nodeMap.computeIfAbsent(key, k -> new BufferNode(k));</span> |
| <span class="source-line-no">157</span><span id="line-157"> }</span> |
| <span class="source-line-no">158</span><span id="line-158"></span> |
| <span class="source-line-no">159</span><span id="line-159"> /**</span> |
| <span class="source-line-no">160</span><span id="line-160"> * Add a remote rpc.</span> |
| <span class="source-line-no">161</span><span id="line-161"> * @param key the node identifier</span> |
| <span class="source-line-no">162</span><span id="line-162"> */</span> |
| <span class="source-line-no">163</span><span id="line-163"> public void addOperationToNode(final TRemote key, RemoteProcedure rp)</span> |
| <span class="source-line-no">164</span><span id="line-164"> throws NullTargetServerDispatchException, NoServerDispatchException, NoNodeDispatchException {</span> |
| <span class="source-line-no">165</span><span id="line-165"> if (key == null) {</span> |
| <span class="source-line-no">166</span><span id="line-166"> throw new NullTargetServerDispatchException(rp.toString());</span> |
| <span class="source-line-no">167</span><span id="line-167"> }</span> |
| <span class="source-line-no">168</span><span id="line-168"> BufferNode node = nodeMap.get(key);</span> |
| <span class="source-line-no">169</span><span id="line-169"> if (node == null) {</span> |
| <span class="source-line-no">170</span><span id="line-170"> // If null here, it means node has been removed because it crashed. This happens when server</span> |
| <span class="source-line-no">171</span><span id="line-171"> // is expired in ServerManager. ServerCrashProcedure may or may not have run.</span> |
| <span class="source-line-no">172</span><span id="line-172"> throw new NoServerDispatchException(key.toString() + "; " + rp.toString());</span> |
| <span class="source-line-no">173</span><span id="line-173"> }</span> |
| <span class="source-line-no">174</span><span id="line-174"> node.add(rp);</span> |
| <span class="source-line-no">175</span><span id="line-175"> // Check our node still in the map; could have been removed by #removeNode.</span> |
| <span class="source-line-no">176</span><span id="line-176"> if (!nodeMap.containsValue(node)) {</span> |
| <span class="source-line-no">177</span><span id="line-177"> throw new NoNodeDispatchException(key.toString() + "; " + rp.toString());</span> |
| <span class="source-line-no">178</span><span id="line-178"> }</span> |
| <span class="source-line-no">179</span><span id="line-179"> }</span> |
| <span class="source-line-no">180</span><span id="line-180"></span> |
| <span class="source-line-no">181</span><span id="line-181"> public void removeCompletedOperation(final TRemote key, RemoteProcedure rp) {</span> |
| <span class="source-line-no">182</span><span id="line-182"> BufferNode node = nodeMap.get(key);</span> |
| <span class="source-line-no">183</span><span id="line-183"> if (node == null) {</span> |
| <span class="source-line-no">184</span><span id="line-184"> LOG.warn("since no node for this key {}, we can't removed the finished remote procedure",</span> |
| <span class="source-line-no">185</span><span id="line-185"> key);</span> |
| <span class="source-line-no">186</span><span id="line-186"> return;</span> |
| <span class="source-line-no">187</span><span id="line-187"> }</span> |
| <span class="source-line-no">188</span><span id="line-188"> node.operationCompleted(rp);</span> |
| <span class="source-line-no">189</span><span id="line-189"> }</span> |
| <span class="source-line-no">190</span><span id="line-190"></span> |
| <span class="source-line-no">191</span><span id="line-191"> /**</span> |
| <span class="source-line-no">192</span><span id="line-192"> * Remove a remote node</span> |
| <span class="source-line-no">193</span><span id="line-193"> * @param key the node identifier</span> |
| <span class="source-line-no">194</span><span id="line-194"> */</span> |
| <span class="source-line-no">195</span><span id="line-195"> public boolean removeNode(final TRemote key) {</span> |
| <span class="source-line-no">196</span><span id="line-196"> final BufferNode node = nodeMap.remove(key);</span> |
| <span class="source-line-no">197</span><span id="line-197"> if (node == null) {</span> |
| <span class="source-line-no">198</span><span id="line-198"> return false;</span> |
| <span class="source-line-no">199</span><span id="line-199"> }</span> |
| <span class="source-line-no">200</span><span id="line-200"></span> |
| <span class="source-line-no">201</span><span id="line-201"> node.abortOperationsInQueue();</span> |
| <span class="source-line-no">202</span><span id="line-202"> return true;</span> |
| <span class="source-line-no">203</span><span id="line-203"> }</span> |
| <span class="source-line-no">204</span><span id="line-204"></span> |
| <span class="source-line-no">205</span><span id="line-205"> // ============================================================================================</span> |
| <span class="source-line-no">206</span><span id="line-206"> // Task Helpers</span> |
| <span class="source-line-no">207</span><span id="line-207"> // ============================================================================================</span> |
| <span class="source-line-no">208</span><span id="line-208"> protected final void submitTask(Runnable task) {</span> |
| <span class="source-line-no">209</span><span id="line-209"> threadPool.execute(task);</span> |
| <span class="source-line-no">210</span><span id="line-210"> }</span> |
| <span class="source-line-no">211</span><span id="line-211"></span> |
| <span class="source-line-no">212</span><span id="line-212"> protected final void submitTask(Runnable task, long delay, TimeUnit unit) {</span> |
| <span class="source-line-no">213</span><span id="line-213"> timeoutExecutor.add(new DelayedTask(task, delay, unit));</span> |
| <span class="source-line-no">214</span><span id="line-214"> }</span> |
| <span class="source-line-no">215</span><span id="line-215"></span> |
| <span class="source-line-no">216</span><span id="line-216"> protected abstract void remoteDispatch(TRemote key, Set<RemoteProcedure> operations);</span> |
| <span class="source-line-no">217</span><span id="line-217"></span> |
| <span class="source-line-no">218</span><span id="line-218"> protected abstract void abortPendingOperations(TRemote key, Set<RemoteProcedure> operations);</span> |
| <span class="source-line-no">219</span><span id="line-219"></span> |
| <span class="source-line-no">220</span><span id="line-220"> /**</span> |
| <span class="source-line-no">221</span><span id="line-221"> * Data structure with reference to remote operation.</span> |
| <span class="source-line-no">222</span><span id="line-222"> */</span> |
| <span class="source-line-no">223</span><span id="line-223"> public static abstract class RemoteOperation {</span> |
| <span class="source-line-no">224</span><span id="line-224"> private final RemoteProcedure remoteProcedure;</span> |
| <span class="source-line-no">225</span><span id="line-225"></span> |
| <span class="source-line-no">226</span><span id="line-226"> protected RemoteOperation(final RemoteProcedure remoteProcedure) {</span> |
| <span class="source-line-no">227</span><span id="line-227"> this.remoteProcedure = remoteProcedure;</span> |
| <span class="source-line-no">228</span><span id="line-228"> }</span> |
| <span class="source-line-no">229</span><span id="line-229"></span> |
| <span class="source-line-no">230</span><span id="line-230"> public RemoteProcedure getRemoteProcedure() {</span> |
| <span class="source-line-no">231</span><span id="line-231"> return remoteProcedure;</span> |
| <span class="source-line-no">232</span><span id="line-232"> }</span> |
| <span class="source-line-no">233</span><span id="line-233"> }</span> |
| <span class="source-line-no">234</span><span id="line-234"></span> |
| <span class="source-line-no">235</span><span id="line-235"> /**</span> |
| <span class="source-line-no">236</span><span id="line-236"> * Remote procedure reference.</span> |
| <span class="source-line-no">237</span><span id="line-237"> */</span> |
| <span class="source-line-no">238</span><span id="line-238"> public interface RemoteProcedure<TEnv, TRemote> {</span> |
| <span class="source-line-no">239</span><span id="line-239"> /**</span> |
| <span class="source-line-no">240</span><span id="line-240"> * For building the remote operation. May be empty if no need to send remote call. Usually, this</span> |
| <span class="source-line-no">241</span><span id="line-241"> * means the RemoteProcedure has been finished already. This is possible, as we may have already</span> |
| <span class="source-line-no">242</span><span id="line-242"> * sent the procedure to RS but then the rpc connection is broken so the executeProcedures call</span> |
| <span class="source-line-no">243</span><span id="line-243"> * fails, but the RS does receive the procedure and execute it and then report back, before we</span> |
| <span class="source-line-no">244</span><span id="line-244"> * retry again.</span> |
| <span class="source-line-no">245</span><span id="line-245"> */</span> |
| <span class="source-line-no">246</span><span id="line-246"> Optional<RemoteOperation> remoteCallBuild(TEnv env, TRemote remote);</span> |
| <span class="source-line-no">247</span><span id="line-247"></span> |
| <span class="source-line-no">248</span><span id="line-248"> /**</span> |
| <span class="source-line-no">249</span><span id="line-249"> * Called when the executeProcedure call is failed.</span> |
| <span class="source-line-no">250</span><span id="line-250"> */</span> |
| <span class="source-line-no">251</span><span id="line-251"> void remoteCallFailed(TEnv env, TRemote remote, IOException exception);</span> |
| <span class="source-line-no">252</span><span id="line-252"></span> |
| <span class="source-line-no">253</span><span id="line-253"> /**</span> |
| <span class="source-line-no">254</span><span id="line-254"> * Called when RS tells the remote procedure is succeeded through the</span> |
| <span class="source-line-no">255</span><span id="line-255"> * {@code reportProcedureDone} method.</span> |
| <span class="source-line-no">256</span><span id="line-256"> */</span> |
| <span class="source-line-no">257</span><span id="line-257"> void remoteOperationCompleted(TEnv env);</span> |
| <span class="source-line-no">258</span><span id="line-258"></span> |
| <span class="source-line-no">259</span><span id="line-259"> /**</span> |
| <span class="source-line-no">260</span><span id="line-260"> * Called when RS tells the remote procedure is failed through the {@code reportProcedureDone}</span> |
| <span class="source-line-no">261</span><span id="line-261"> * method.</span> |
| <span class="source-line-no">262</span><span id="line-262"> */</span> |
| <span class="source-line-no">263</span><span id="line-263"> void remoteOperationFailed(TEnv env, RemoteProcedureException error);</span> |
| <span class="source-line-no">264</span><span id="line-264"></span> |
| <span class="source-line-no">265</span><span id="line-265"> /**</span> |
| <span class="source-line-no">266</span><span id="line-266"> * Whether store this remote procedure in dispatched queue only OpenRegionProcedure and</span> |
| <span class="source-line-no">267</span><span id="line-267"> * CloseRegionProcedure return false since they are not fully controlled by dispatcher</span> |
| <span class="source-line-no">268</span><span id="line-268"> */</span> |
| <span class="source-line-no">269</span><span id="line-269"> default boolean storeInDispatchedQueue() {</span> |
| <span class="source-line-no">270</span><span id="line-270"> return true;</span> |
| <span class="source-line-no">271</span><span id="line-271"> }</span> |
| <span class="source-line-no">272</span><span id="line-272"> }</span> |
| <span class="source-line-no">273</span><span id="line-273"></span> |
| <span class="source-line-no">274</span><span id="line-274"> /**</span> |
| <span class="source-line-no">275</span><span id="line-275"> * Account of what procedures are running on remote node.</span> |
| <span class="source-line-no">276</span><span id="line-276"> */</span> |
| <span class="source-line-no">277</span><span id="line-277"> public interface RemoteNode<TEnv, TRemote> {</span> |
| <span class="source-line-no">278</span><span id="line-278"> TRemote getKey();</span> |
| <span class="source-line-no">279</span><span id="line-279"></span> |
| <span class="source-line-no">280</span><span id="line-280"> void add(RemoteProcedure<TEnv, TRemote> operation);</span> |
| <span class="source-line-no">281</span><span id="line-281"></span> |
| <span class="source-line-no">282</span><span id="line-282"> void dispatch();</span> |
| <span class="source-line-no">283</span><span id="line-283"> }</span> |
| <span class="source-line-no">284</span><span id="line-284"></span> |
| <span class="source-line-no">285</span><span id="line-285"> protected ArrayListMultimap<Class<?>, RemoteOperation> buildAndGroupRequestByType(final TEnv env,</span> |
| <span class="source-line-no">286</span><span id="line-286"> final TRemote remote, final Set<RemoteProcedure> remoteProcedures) {</span> |
| <span class="source-line-no">287</span><span id="line-287"> final ArrayListMultimap<Class<?>, RemoteOperation> requestByType = ArrayListMultimap.create();</span> |
| <span class="source-line-no">288</span><span id="line-288"> for (RemoteProcedure proc : remoteProcedures) {</span> |
| <span class="source-line-no">289</span><span id="line-289"> Optional<RemoteOperation> operation = proc.remoteCallBuild(env, remote);</span> |
| <span class="source-line-no">290</span><span id="line-290"> operation.ifPresent(op -> requestByType.put(op.getClass(), op));</span> |
| <span class="source-line-no">291</span><span id="line-291"> }</span> |
| <span class="source-line-no">292</span><span id="line-292"> return requestByType;</span> |
| <span class="source-line-no">293</span><span id="line-293"> }</span> |
| <span class="source-line-no">294</span><span id="line-294"></span> |
| <span class="source-line-no">295</span><span id="line-295"> protected <T extends RemoteOperation> List<T> fetchType(</span> |
| <span class="source-line-no">296</span><span id="line-296"> final ArrayListMultimap<Class<?>, RemoteOperation> requestByType, final Class<T> type) {</span> |
| <span class="source-line-no">297</span><span id="line-297"> return (List<T>) requestByType.removeAll(type);</span> |
| <span class="source-line-no">298</span><span id="line-298"> }</span> |
| <span class="source-line-no">299</span><span id="line-299"></span> |
| <span class="source-line-no">300</span><span id="line-300"> @RestrictedApi(explanation = "Should only be called in tests", link = "",</span> |
| <span class="source-line-no">301</span><span id="line-301"> allowedOnPath = ".*/src/test/.*")</span> |
| <span class="source-line-no">302</span><span id="line-302"> public boolean hasNode(TRemote key) {</span> |
| <span class="source-line-no">303</span><span id="line-303"> return nodeMap.containsKey(key);</span> |
| <span class="source-line-no">304</span><span id="line-304"> }</span> |
| <span class="source-line-no">305</span><span id="line-305"></span> |
| <span class="source-line-no">306</span><span id="line-306"> // ============================================================================================</span> |
| <span class="source-line-no">307</span><span id="line-307"> // Timeout Helpers</span> |
| <span class="source-line-no">308</span><span id="line-308"> // ============================================================================================</span> |
| <span class="source-line-no">309</span><span id="line-309"> private final class TimeoutExecutorThread extends Thread {</span> |
| <span class="source-line-no">310</span><span id="line-310"> private final DelayQueue<DelayedWithTimeout> queue = new DelayQueue<DelayedWithTimeout>();</span> |
| <span class="source-line-no">311</span><span id="line-311"></span> |
| <span class="source-line-no">312</span><span id="line-312"> public TimeoutExecutorThread() {</span> |
| <span class="source-line-no">313</span><span id="line-313"> super("ProcedureDispatcherTimeoutThread");</span> |
| <span class="source-line-no">314</span><span id="line-314"> }</span> |
| <span class="source-line-no">315</span><span id="line-315"></span> |
| <span class="source-line-no">316</span><span id="line-316"> @Override</span> |
| <span class="source-line-no">317</span><span id="line-317"> public void run() {</span> |
| <span class="source-line-no">318</span><span id="line-318"> while (running.get()) {</span> |
| <span class="source-line-no">319</span><span id="line-319"> final DelayedWithTimeout task =</span> |
| <span class="source-line-no">320</span><span id="line-320"> DelayedUtil.takeWithoutInterrupt(queue, 20, TimeUnit.SECONDS);</span> |
| <span class="source-line-no">321</span><span id="line-321"> if (task == null || task == DelayedUtil.DELAYED_POISON) {</span> |
| <span class="source-line-no">322</span><span id="line-322"> if (task == null && queue.size() > 0) {</span> |
| <span class="source-line-no">323</span><span id="line-323"> LOG.error("DelayQueue for RemoteProcedureDispatcher is not empty when timed waiting"</span> |
| <span class="source-line-no">324</span><span id="line-324"> + " elapsed. If this is repeated consistently, it means no element is getting expired"</span> |
| <span class="source-line-no">325</span><span id="line-325"> + " from the queue and it might freeze the system. Queue: {}", queue);</span> |
| <span class="source-line-no">326</span><span id="line-326"> }</span> |
| <span class="source-line-no">327</span><span id="line-327"> // the executor may be shutting down, and the task is just the shutdown request</span> |
| <span class="source-line-no">328</span><span id="line-328"> continue;</span> |
| <span class="source-line-no">329</span><span id="line-329"> }</span> |
| <span class="source-line-no">330</span><span id="line-330"> if (task instanceof DelayedTask) {</span> |
| <span class="source-line-no">331</span><span id="line-331"> threadPool.execute(((DelayedTask) task).getObject());</span> |
| <span class="source-line-no">332</span><span id="line-332"> } else {</span> |
| <span class="source-line-no">333</span><span id="line-333"> ((BufferNode) task).dispatch();</span> |
| <span class="source-line-no">334</span><span id="line-334"> }</span> |
| <span class="source-line-no">335</span><span id="line-335"> }</span> |
| <span class="source-line-no">336</span><span id="line-336"> }</span> |
| <span class="source-line-no">337</span><span id="line-337"></span> |
| <span class="source-line-no">338</span><span id="line-338"> public void add(final DelayedWithTimeout delayed) {</span> |
| <span class="source-line-no">339</span><span id="line-339"> queue.add(delayed);</span> |
| <span class="source-line-no">340</span><span id="line-340"> }</span> |
| <span class="source-line-no">341</span><span id="line-341"></span> |
| <span class="source-line-no">342</span><span id="line-342"> public void remove(final DelayedWithTimeout delayed) {</span> |
| <span class="source-line-no">343</span><span id="line-343"> queue.remove(delayed);</span> |
| <span class="source-line-no">344</span><span id="line-344"> }</span> |
| <span class="source-line-no">345</span><span id="line-345"></span> |
| <span class="source-line-no">346</span><span id="line-346"> public void sendStopSignal() {</span> |
| <span class="source-line-no">347</span><span id="line-347"> queue.add(DelayedUtil.DELAYED_POISON);</span> |
| <span class="source-line-no">348</span><span id="line-348"> }</span> |
| <span class="source-line-no">349</span><span id="line-349"></span> |
| <span class="source-line-no">350</span><span id="line-350"> public void awaitTermination() {</span> |
| <span class="source-line-no">351</span><span id="line-351"> try {</span> |
| <span class="source-line-no">352</span><span id="line-352"> final long startTime = EnvironmentEdgeManager.currentTime();</span> |
| <span class="source-line-no">353</span><span id="line-353"> for (int i = 0; isAlive(); ++i) {</span> |
| <span class="source-line-no">354</span><span id="line-354"> sendStopSignal();</span> |
| <span class="source-line-no">355</span><span id="line-355"> join(250);</span> |
| <span class="source-line-no">356</span><span id="line-356"> if (i > 0 && (i % 8) == 0) {</span> |
| <span class="source-line-no">357</span><span id="line-357"> LOG.warn("Waiting termination of thread " + getName() + ", "</span> |
| <span class="source-line-no">358</span><span id="line-358"> + StringUtils.humanTimeDiff(EnvironmentEdgeManager.currentTime() - startTime));</span> |
| <span class="source-line-no">359</span><span id="line-359"> }</span> |
| <span class="source-line-no">360</span><span id="line-360"> }</span> |
| <span class="source-line-no">361</span><span id="line-361"> } catch (InterruptedException e) {</span> |
| <span class="source-line-no">362</span><span id="line-362"> LOG.warn(getName() + " join wait got interrupted", e);</span> |
| <span class="source-line-no">363</span><span id="line-363"> }</span> |
| <span class="source-line-no">364</span><span id="line-364"> }</span> |
| <span class="source-line-no">365</span><span id="line-365"> }</span> |
| <span class="source-line-no">366</span><span id="line-366"></span> |
| <span class="source-line-no">367</span><span id="line-367"> // ============================================================================================</span> |
| <span class="source-line-no">368</span><span id="line-368"> // Internals Helpers</span> |
| <span class="source-line-no">369</span><span id="line-369"> // ============================================================================================</span> |
| <span class="source-line-no">370</span><span id="line-370"></span> |
| <span class="source-line-no">371</span><span id="line-371"> /**</span> |
| <span class="source-line-no">372</span><span id="line-372"> * Node that contains a set of RemoteProcedures</span> |
| <span class="source-line-no">373</span><span id="line-373"> */</span> |
| <span class="source-line-no">374</span><span id="line-374"> protected final class BufferNode extends DelayedContainerWithTimestamp<TRemote></span> |
| <span class="source-line-no">375</span><span id="line-375"> implements RemoteNode<TEnv, TRemote> {</span> |
| <span class="source-line-no">376</span><span id="line-376"> private Set<RemoteProcedure> operations;</span> |
| <span class="source-line-no">377</span><span id="line-377"> private final Set<RemoteProcedure> dispatchedOperations = new HashSet<>();</span> |
| <span class="source-line-no">378</span><span id="line-378"></span> |
| <span class="source-line-no">379</span><span id="line-379"> protected BufferNode(final TRemote key) {</span> |
| <span class="source-line-no">380</span><span id="line-380"> super(key, 0);</span> |
| <span class="source-line-no">381</span><span id="line-381"> }</span> |
| <span class="source-line-no">382</span><span id="line-382"></span> |
| <span class="source-line-no">383</span><span id="line-383"> @Override</span> |
| <span class="source-line-no">384</span><span id="line-384"> public TRemote getKey() {</span> |
| <span class="source-line-no">385</span><span id="line-385"> return getObject();</span> |
| <span class="source-line-no">386</span><span id="line-386"> }</span> |
| <span class="source-line-no">387</span><span id="line-387"></span> |
| <span class="source-line-no">388</span><span id="line-388"> @Override</span> |
| <span class="source-line-no">389</span><span id="line-389"> public synchronized void add(final RemoteProcedure operation) {</span> |
| <span class="source-line-no">390</span><span id="line-390"> if (this.operations == null) {</span> |
| <span class="source-line-no">391</span><span id="line-391"> this.operations = new HashSet<>();</span> |
| <span class="source-line-no">392</span><span id="line-392"> setTimeout(EnvironmentEdgeManager.currentTime() + operationDelay);</span> |
| <span class="source-line-no">393</span><span id="line-393"> timeoutExecutor.add(this);</span> |
| <span class="source-line-no">394</span><span id="line-394"> }</span> |
| <span class="source-line-no">395</span><span id="line-395"> this.operations.add(operation);</span> |
| <span class="source-line-no">396</span><span id="line-396"> if (this.operations.size() > queueMaxSize) {</span> |
| <span class="source-line-no">397</span><span id="line-397"> timeoutExecutor.remove(this);</span> |
| <span class="source-line-no">398</span><span id="line-398"> dispatch();</span> |
| <span class="source-line-no">399</span><span id="line-399"> }</span> |
| <span class="source-line-no">400</span><span id="line-400"> }</span> |
| <span class="source-line-no">401</span><span id="line-401"></span> |
| <span class="source-line-no">402</span><span id="line-402"> @Override</span> |
| <span class="source-line-no">403</span><span id="line-403"> public synchronized void dispatch() {</span> |
| <span class="source-line-no">404</span><span id="line-404"> if (operations != null) {</span> |
| <span class="source-line-no">405</span><span id="line-405"> remoteDispatch(getKey(), operations);</span> |
| <span class="source-line-no">406</span><span id="line-406"> operations.stream().filter(operation -> operation.storeInDispatchedQueue())</span> |
| <span class="source-line-no">407</span><span id="line-407"> .forEach(operation -> dispatchedOperations.add(operation));</span> |
| <span class="source-line-no">408</span><span id="line-408"> this.operations = null;</span> |
| <span class="source-line-no">409</span><span id="line-409"> }</span> |
| <span class="source-line-no">410</span><span id="line-410"> }</span> |
| <span class="source-line-no">411</span><span id="line-411"></span> |
| <span class="source-line-no">412</span><span id="line-412"> public synchronized void abortOperationsInQueue() {</span> |
| <span class="source-line-no">413</span><span id="line-413"> if (operations != null) {</span> |
| <span class="source-line-no">414</span><span id="line-414"> abortPendingOperations(getKey(), operations);</span> |
| <span class="source-line-no">415</span><span id="line-415"> this.operations = null;</span> |
| <span class="source-line-no">416</span><span id="line-416"> }</span> |
| <span class="source-line-no">417</span><span id="line-417"> abortPendingOperations(getKey(), dispatchedOperations);</span> |
| <span class="source-line-no">418</span><span id="line-418"> this.dispatchedOperations.clear();</span> |
| <span class="source-line-no">419</span><span id="line-419"> }</span> |
| <span class="source-line-no">420</span><span id="line-420"></span> |
| <span class="source-line-no">421</span><span id="line-421"> public synchronized void operationCompleted(final RemoteProcedure remoteProcedure) {</span> |
| <span class="source-line-no">422</span><span id="line-422"> this.dispatchedOperations.remove(remoteProcedure);</span> |
| <span class="source-line-no">423</span><span id="line-423"> }</span> |
| <span class="source-line-no">424</span><span id="line-424"></span> |
| <span class="source-line-no">425</span><span id="line-425"> @Override</span> |
| <span class="source-line-no">426</span><span id="line-426"> public String toString() {</span> |
| <span class="source-line-no">427</span><span id="line-427"> return super.toString() + ", operations=" + this.operations;</span> |
| <span class="source-line-no">428</span><span id="line-428"> }</span> |
| <span class="source-line-no">429</span><span id="line-429"> }</span> |
| <span class="source-line-no">430</span><span id="line-430"></span> |
| <span class="source-line-no">431</span><span id="line-431"> /**</span> |
| <span class="source-line-no">432</span><span id="line-432"> * Delayed object that holds a FutureTask.</span> |
| <span class="source-line-no">433</span><span id="line-433"> * <p/></span> |
| <span class="source-line-no">434</span><span id="line-434"> * used to submit something later to the thread-pool.</span> |
| <span class="source-line-no">435</span><span id="line-435"> */</span> |
| <span class="source-line-no">436</span><span id="line-436"> private static final class DelayedTask extends DelayedContainerWithTimestamp<Runnable> {</span> |
| <span class="source-line-no">437</span><span id="line-437"> public DelayedTask(Runnable task, long delay, TimeUnit unit) {</span> |
| <span class="source-line-no">438</span><span id="line-438"> super(task, EnvironmentEdgeManager.currentTime() + unit.toMillis(delay));</span> |
| <span class="source-line-no">439</span><span id="line-439"> }</span> |
| <span class="source-line-no">440</span><span id="line-440"> }</span> |
| <span class="source-line-no">441</span><span id="line-441">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
