Google Git
Sign in
apache / hbase-site / 0ae5c74023a0abd2ad8c5adba9600704a5af3213 / . / devapidocs / src-html / org / apache / hadoop / hbase / ipc / FifoRpcScheduler.FifoCallRunner.html
blob: e8bf8866547c20a82f7be7c8ef1237ed2b6fc322 [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.ipc;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.util.HashMap;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.concurrent.ArrayBlockingQueue;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.concurrent.BlockingQueue;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.concurrent.ThreadPoolExecutor;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.concurrent.TimeUnit;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.concurrent.atomic.AtomicInteger;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.hadoop.conf.Configuration;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.util.Threads;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.slf4j.Logger;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.slf4j.LoggerFactory;<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hbase.thirdparty.com.google.common.util.concurrent.ThreadFactoryBuilder;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hbase.thirdparty.io.netty.util.internal.StringUtil;<a name="line.33"></a>
<span class="sourceLineNo">034</span><a name="line.34"></a>
<span class="sourceLineNo">035</span>/**<a name="line.35"></a>
<span class="sourceLineNo">036</span> * A very simple {@code }RpcScheduler} that serves incoming requests in order. This can be used for<a name="line.36"></a>
<span class="sourceLineNo">037</span> * HMaster, where no prioritization is needed.<a name="line.37"></a>
<span class="sourceLineNo">038</span> */<a name="line.38"></a>
<span class="sourceLineNo">039</span>@InterfaceAudience.Private<a name="line.39"></a>
<span class="sourceLineNo">040</span>public class FifoRpcScheduler extends RpcScheduler {<a name="line.40"></a>
<span class="sourceLineNo">041</span> private static final Logger LOG = LoggerFactory.getLogger(FifoRpcScheduler.class);<a name="line.41"></a>
<span class="sourceLineNo">042</span> protected final int handlerCount;<a name="line.42"></a>
<span class="sourceLineNo">043</span> protected final int maxQueueLength;<a name="line.43"></a>
<span class="sourceLineNo">044</span> protected final AtomicInteger queueSize = new AtomicInteger(0);<a name="line.44"></a>
<span class="sourceLineNo">045</span> protected ThreadPoolExecutor executor;<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span> public FifoRpcScheduler(Configuration conf, int handlerCount) {<a name="line.47"></a>
<span class="sourceLineNo">048</span> this.handlerCount = handlerCount;<a name="line.48"></a>
<span class="sourceLineNo">049</span> this.maxQueueLength = conf.getInt(RpcScheduler.IPC_SERVER_MAX_CALLQUEUE_LENGTH,<a name="line.49"></a>
<span class="sourceLineNo">050</span> handlerCount * RpcServer.DEFAULT_MAX_CALLQUEUE_LENGTH_PER_HANDLER);<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> @Override<a name="line.53"></a>
<span class="sourceLineNo">054</span> public void init(Context context) {<a name="line.54"></a>
<span class="sourceLineNo">055</span> // no-op<a name="line.55"></a>
<span class="sourceLineNo">056</span> }<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> @Override<a name="line.58"></a>
<span class="sourceLineNo">059</span> public void start() {<a name="line.59"></a>
<span class="sourceLineNo">060</span> LOG.info("Using {} as user call queue; handlerCount={}; maxQueueLength={}",<a name="line.60"></a>
<span class="sourceLineNo">061</span> this.getClass().getSimpleName(), handlerCount, maxQueueLength);<a name="line.61"></a>
<span class="sourceLineNo">062</span> this.executor = new ThreadPoolExecutor(handlerCount, handlerCount, 60, TimeUnit.SECONDS,<a name="line.62"></a>
<span class="sourceLineNo">063</span> new ArrayBlockingQueue&lt;&gt;(maxQueueLength),<a name="line.63"></a>
<span class="sourceLineNo">064</span> new ThreadFactoryBuilder().setNameFormat("FifoRpcScheduler.handler-pool-%d").setDaemon(true)<a name="line.64"></a>
<span class="sourceLineNo">065</span> .setUncaughtExceptionHandler(Threads.LOGGING_EXCEPTION_HANDLER).build(),<a name="line.65"></a>
<span class="sourceLineNo">066</span> new ThreadPoolExecutor.CallerRunsPolicy());<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> @Override<a name="line.69"></a>
<span class="sourceLineNo">070</span> public void stop() {<a name="line.70"></a>
<span class="sourceLineNo">071</span> this.executor.shutdown();<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> private static class FifoCallRunner implements Runnable {<a name="line.74"></a>
<span class="sourceLineNo">075</span> private final CallRunner callRunner;<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span> FifoCallRunner(CallRunner cr) {<a name="line.77"></a>
<span class="sourceLineNo">078</span> this.callRunner = cr;<a name="line.78"></a>
<span class="sourceLineNo">079</span> }<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span> CallRunner getCallRunner() {<a name="line.81"></a>
<span class="sourceLineNo">082</span> return callRunner;<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> @Override<a name="line.85"></a>
<span class="sourceLineNo">086</span> public void run() {<a name="line.86"></a>
<span class="sourceLineNo">087</span> callRunner.run();<a name="line.87"></a>
<span class="sourceLineNo">088</span> }<a name="line.88"></a>
<span class="sourceLineNo">089</span><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> @Override<a name="line.92"></a>
<span class="sourceLineNo">093</span> public boolean dispatch(final CallRunner task) {<a name="line.93"></a>
<span class="sourceLineNo">094</span> return executeRpcCall(executor, queueSize, task);<a name="line.94"></a>
<span class="sourceLineNo">095</span> }<a name="line.95"></a>
<span class="sourceLineNo">096</span><a name="line.96"></a>
<span class="sourceLineNo">097</span> protected boolean executeRpcCall(final ThreadPoolExecutor executor, final AtomicInteger queueSize,<a name="line.97"></a>
<span class="sourceLineNo">098</span> final CallRunner task) {<a name="line.98"></a>
<span class="sourceLineNo">099</span> // Executors provide no offer, so make our own.<a name="line.99"></a>
<span class="sourceLineNo">100</span> int queued = queueSize.getAndIncrement();<a name="line.100"></a>
<span class="sourceLineNo">101</span> if (maxQueueLength &gt; 0 &amp;&amp; queued &gt;= maxQueueLength) {<a name="line.101"></a>
<span class="sourceLineNo">102</span> queueSize.decrementAndGet();<a name="line.102"></a>
<span class="sourceLineNo">103</span> return false;<a name="line.103"></a>
<span class="sourceLineNo">104</span> }<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span> executor.execute(new FifoCallRunner(task) {<a name="line.106"></a>
<span class="sourceLineNo">107</span> @Override<a name="line.107"></a>
<span class="sourceLineNo">108</span> public void run() {<a name="line.108"></a>
<span class="sourceLineNo">109</span> task.setStatus(RpcServer.getStatus());<a name="line.109"></a>
<span class="sourceLineNo">110</span> task.run();<a name="line.110"></a>
<span class="sourceLineNo">111</span> queueSize.decrementAndGet();<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> return true;<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span> @Override<a name="line.118"></a>
<span class="sourceLineNo">119</span> public int getGeneralQueueLength() {<a name="line.119"></a>
<span class="sourceLineNo">120</span> return executor.getQueue().size();<a name="line.120"></a>
<span class="sourceLineNo">121</span> }<a name="line.121"></a>
<span class="sourceLineNo">122</span><a name="line.122"></a>
<span class="sourceLineNo">123</span> @Override<a name="line.123"></a>
<span class="sourceLineNo">124</span> public int getPriorityQueueLength() {<a name="line.124"></a>
<span class="sourceLineNo">125</span> return 0;<a name="line.125"></a>
<span class="sourceLineNo">126</span> }<a name="line.126"></a>
<span class="sourceLineNo">127</span><a name="line.127"></a>
<span class="sourceLineNo">128</span> @Override<a name="line.128"></a>
<span class="sourceLineNo">129</span> public int getReplicationQueueLength() {<a name="line.129"></a>
<span class="sourceLineNo">130</span> return 0;<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> @Override<a name="line.133"></a>
<span class="sourceLineNo">134</span> public int getBulkLoadQueueLength() {<a name="line.134"></a>
<span class="sourceLineNo">135</span> return 0;<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> @Override<a name="line.138"></a>
<span class="sourceLineNo">139</span> public int getActiveRpcHandlerCount() {<a name="line.139"></a>
<span class="sourceLineNo">140</span> return executor.getActiveCount();<a name="line.140"></a>
<span class="sourceLineNo">141</span> }<a name="line.141"></a>
<span class="sourceLineNo">142</span><a name="line.142"></a>
<span class="sourceLineNo">143</span> @Override<a name="line.143"></a>
<span class="sourceLineNo">144</span> public int getActiveGeneralRpcHandlerCount() {<a name="line.144"></a>
<span class="sourceLineNo">145</span> return getActiveRpcHandlerCount();<a name="line.145"></a>
<span class="sourceLineNo">146</span> }<a name="line.146"></a>
<span class="sourceLineNo">147</span><a name="line.147"></a>
<span class="sourceLineNo">148</span> @Override<a name="line.148"></a>
<span class="sourceLineNo">149</span> public int getActivePriorityRpcHandlerCount() {<a name="line.149"></a>
<span class="sourceLineNo">150</span> return 0;<a name="line.150"></a>
<span class="sourceLineNo">151</span> }<a name="line.151"></a>
<span class="sourceLineNo">152</span><a name="line.152"></a>
<span class="sourceLineNo">153</span> @Override<a name="line.153"></a>
<span class="sourceLineNo">154</span> public int getActiveReplicationRpcHandlerCount() {<a name="line.154"></a>
<span class="sourceLineNo">155</span> return 0;<a name="line.155"></a>
<span class="sourceLineNo">156</span> }<a name="line.156"></a>
<span class="sourceLineNo">157</span><a name="line.157"></a>
<span class="sourceLineNo">158</span> @Override<a name="line.158"></a>
<span class="sourceLineNo">159</span> public int getActiveBulkLoadRpcHandlerCount() {<a name="line.159"></a>
<span class="sourceLineNo">160</span> return 0;<a name="line.160"></a>
<span class="sourceLineNo">161</span> }<a name="line.161"></a>
<span class="sourceLineNo">162</span><a name="line.162"></a>
<span class="sourceLineNo">163</span> @Override<a name="line.163"></a>
<span class="sourceLineNo">164</span> public int getActiveMetaPriorityRpcHandlerCount() {<a name="line.164"></a>
<span class="sourceLineNo">165</span> return 0;<a name="line.165"></a>
<span class="sourceLineNo">166</span> }<a name="line.166"></a>
<span class="sourceLineNo">167</span><a name="line.167"></a>
<span class="sourceLineNo">168</span> @Override<a name="line.168"></a>
<span class="sourceLineNo">169</span> public long getNumGeneralCallsDropped() {<a name="line.169"></a>
<span class="sourceLineNo">170</span> return 0;<a name="line.170"></a>
<span class="sourceLineNo">171</span> }<a name="line.171"></a>
<span class="sourceLineNo">172</span><a name="line.172"></a>
<span class="sourceLineNo">173</span> @Override<a name="line.173"></a>
<span class="sourceLineNo">174</span> public long getNumLifoModeSwitches() {<a name="line.174"></a>
<span class="sourceLineNo">175</span> return 0;<a name="line.175"></a>
<span class="sourceLineNo">176</span> }<a name="line.176"></a>
<span class="sourceLineNo">177</span><a name="line.177"></a>
<span class="sourceLineNo">178</span> @Override<a name="line.178"></a>
<span class="sourceLineNo">179</span> public int getWriteQueueLength() {<a name="line.179"></a>
<span class="sourceLineNo">180</span> return 0;<a name="line.180"></a>
<span class="sourceLineNo">181</span> }<a name="line.181"></a>
<span class="sourceLineNo">182</span><a name="line.182"></a>
<span class="sourceLineNo">183</span> @Override<a name="line.183"></a>
<span class="sourceLineNo">184</span> public int getReadQueueLength() {<a name="line.184"></a>
<span class="sourceLineNo">185</span> return 0;<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> @Override<a name="line.188"></a>
<span class="sourceLineNo">189</span> public int getScanQueueLength() {<a name="line.189"></a>
<span class="sourceLineNo">190</span> return 0;<a name="line.190"></a>
<span class="sourceLineNo">191</span> }<a name="line.191"></a>
<span class="sourceLineNo">192</span><a name="line.192"></a>
<span class="sourceLineNo">193</span> @Override<a name="line.193"></a>
<span class="sourceLineNo">194</span> public int getActiveWriteRpcHandlerCount() {<a name="line.194"></a>
<span class="sourceLineNo">195</span> return 0;<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> @Override<a name="line.198"></a>
<span class="sourceLineNo">199</span> public int getActiveReadRpcHandlerCount() {<a name="line.199"></a>
<span class="sourceLineNo">200</span> return 0;<a name="line.200"></a>
<span class="sourceLineNo">201</span> }<a name="line.201"></a>
<span class="sourceLineNo">202</span><a name="line.202"></a>
<span class="sourceLineNo">203</span> @Override<a name="line.203"></a>
<span class="sourceLineNo">204</span> public int getActiveScanRpcHandlerCount() {<a name="line.204"></a>
<span class="sourceLineNo">205</span> return 0;<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> @Override<a name="line.208"></a>
<span class="sourceLineNo">209</span> public int getMetaPriorityQueueLength() {<a name="line.209"></a>
<span class="sourceLineNo">210</span> return 0;<a name="line.210"></a>
<span class="sourceLineNo">211</span> }<a name="line.211"></a>
<span class="sourceLineNo">212</span><a name="line.212"></a>
<span class="sourceLineNo">213</span> @Override<a name="line.213"></a>
<span class="sourceLineNo">214</span> public CallQueueInfo getCallQueueInfo() {<a name="line.214"></a>
<span class="sourceLineNo">215</span> String queueName = "Fifo Queue";<a name="line.215"></a>
<span class="sourceLineNo">216</span><a name="line.216"></a>
<span class="sourceLineNo">217</span> HashMap&lt;String, Long&gt; methodCount = new HashMap&lt;&gt;();<a name="line.217"></a>
<span class="sourceLineNo">218</span> HashMap&lt;String, Long&gt; methodSize = new HashMap&lt;&gt;();<a name="line.218"></a>
<span class="sourceLineNo">219</span><a name="line.219"></a>
<span class="sourceLineNo">220</span> CallQueueInfo callQueueInfo = new CallQueueInfo();<a name="line.220"></a>
<span class="sourceLineNo">221</span> callQueueInfo.setCallMethodCount(queueName, methodCount);<a name="line.221"></a>
<span class="sourceLineNo">222</span> callQueueInfo.setCallMethodSize(queueName, methodSize);<a name="line.222"></a>
<span class="sourceLineNo">223</span><a name="line.223"></a>
<span class="sourceLineNo">224</span> updateMethodCountAndSizeByQueue(executor.getQueue(), methodCount, methodSize);<a name="line.224"></a>
<span class="sourceLineNo">225</span><a name="line.225"></a>
<span class="sourceLineNo">226</span> return callQueueInfo;<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> protected void updateMethodCountAndSizeByQueue(BlockingQueue&lt;Runnable&gt; queue,<a name="line.229"></a>
<span class="sourceLineNo">230</span> HashMap&lt;String, Long&gt; methodCount, HashMap&lt;String, Long&gt; methodSize) {<a name="line.230"></a>
<span class="sourceLineNo">231</span> for (Runnable r : queue) {<a name="line.231"></a>
<span class="sourceLineNo">232</span> FifoCallRunner mcr = (FifoCallRunner) r;<a name="line.232"></a>
<span class="sourceLineNo">233</span> RpcCall rpcCall = mcr.getCallRunner().getRpcCall();<a name="line.233"></a>
<span class="sourceLineNo">234</span><a name="line.234"></a>
<span class="sourceLineNo">235</span> String method = getCallMethod(mcr.getCallRunner());<a name="line.235"></a>
<span class="sourceLineNo">236</span> if (StringUtil.isNullOrEmpty(method)) {<a name="line.236"></a>
<span class="sourceLineNo">237</span> method = "Unknown";<a name="line.237"></a>
<span class="sourceLineNo">238</span> }<a name="line.238"></a>
<span class="sourceLineNo">239</span><a name="line.239"></a>
<span class="sourceLineNo">240</span> long size = rpcCall.getSize();<a name="line.240"></a>
<span class="sourceLineNo">241</span><a name="line.241"></a>
<span class="sourceLineNo">242</span> methodCount.put(method, 1 + methodCount.getOrDefault(method, 0L));<a name="line.242"></a>
<span class="sourceLineNo">243</span> methodSize.put(method, size + methodSize.getOrDefault(method, 0L));<a name="line.243"></a>
<span class="sourceLineNo">244</span> }<a name="line.244"></a>
<span class="sourceLineNo">245</span> }<a name="line.245"></a>
<span class="sourceLineNo">246</span><a name="line.246"></a>
<span class="sourceLineNo">247</span> protected String getCallMethod(final CallRunner task) {<a name="line.247"></a>
<span class="sourceLineNo">248</span> RpcCall call = task.getRpcCall();<a name="line.248"></a>
<span class="sourceLineNo">249</span> if (call != null &amp;&amp; call.getMethod() != null) {<a name="line.249"></a>
<span class="sourceLineNo">250</span> return call.getMethod().getName();<a name="line.250"></a>
<span class="sourceLineNo">251</span> }<a name="line.251"></a>
<span class="sourceLineNo">252</span> return null;<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>
</pre>
</div>
</body>
</html>