http://git-wip-us.apache.org/repos/asf/hbase-site/blob/4f94a4c5/devapidocs/src-html/org/apache/hadoop/hbase/ipc/RpcServer.BlockingServiceAndInterface.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/ipc/RpcServer.BlockingServiceAndInterface.html b/devapidocs/src-html/org/apache/hadoop/hbase/ipc/RpcServer.BlockingServiceAndInterface.html index 68df449..5e45072 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/ipc/RpcServer.BlockingServiceAndInterface.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/ipc/RpcServer.BlockingServiceAndInterface.html @@ -6,7 +6,7 @@ </head> <body> <div class="sourceContainer"> -<pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a> +<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> @@ -32,775 +32,772 @@ <span class="sourceLineNo">024</span>import java.net.InetAddress;<a name="line.24"></a> <span class="sourceLineNo">025</span>import java.net.InetSocketAddress;<a name="line.25"></a> <span class="sourceLineNo">026</span>import java.nio.ByteBuffer;<a name="line.26"></a> -<span class="sourceLineNo">027</span>import java.nio.channels.GatheringByteChannel;<a name="line.27"></a> -<span class="sourceLineNo">028</span>import java.nio.channels.ReadableByteChannel;<a name="line.28"></a> -<span class="sourceLineNo">029</span>import java.nio.channels.WritableByteChannel;<a name="line.29"></a> -<span class="sourceLineNo">030</span>import java.util.ArrayList;<a name="line.30"></a> -<span class="sourceLineNo">031</span>import java.util.Collections;<a name="line.31"></a> -<span class="sourceLineNo">032</span>import java.util.HashMap;<a name="line.32"></a> -<span class="sourceLineNo">033</span>import java.util.List;<a name="line.33"></a> -<span class="sourceLineNo">034</span>import java.util.Locale;<a name="line.34"></a> -<span class="sourceLineNo">035</span>import java.util.Map;<a name="line.35"></a> -<span class="sourceLineNo">036</span>import java.util.Optional;<a name="line.36"></a> -<span class="sourceLineNo">037</span>import java.util.concurrent.atomic.LongAdder;<a name="line.37"></a> -<span class="sourceLineNo">038</span><a name="line.38"></a> -<span class="sourceLineNo">039</span>import com.fasterxml.jackson.databind.ObjectMapper;<a name="line.39"></a> -<span class="sourceLineNo">040</span>import org.apache.commons.logging.Log;<a name="line.40"></a> -<span class="sourceLineNo">041</span>import org.apache.commons.logging.LogFactory;<a name="line.41"></a> -<span class="sourceLineNo">042</span>import org.apache.hadoop.conf.Configuration;<a name="line.42"></a> -<span class="sourceLineNo">043</span>import org.apache.hadoop.hbase.CallQueueTooBigException;<a name="line.43"></a> -<span class="sourceLineNo">044</span>import org.apache.hadoop.hbase.CellScanner;<a name="line.44"></a> -<span class="sourceLineNo">045</span>import org.apache.hadoop.hbase.DoNotRetryIOException;<a name="line.45"></a> -<span class="sourceLineNo">046</span>import org.apache.hadoop.hbase.HBaseInterfaceAudience;<a name="line.46"></a> -<span class="sourceLineNo">047</span>import org.apache.hadoop.hbase.HConstants;<a name="line.47"></a> -<span class="sourceLineNo">048</span>import org.apache.hadoop.hbase.Server;<a name="line.48"></a> -<span class="sourceLineNo">049</span>import org.apache.hadoop.hbase.conf.ConfigurationObserver;<a name="line.49"></a> -<span class="sourceLineNo">050</span>import org.apache.hadoop.hbase.exceptions.RequestTooBigException;<a name="line.50"></a> -<span class="sourceLineNo">051</span>import org.apache.hadoop.hbase.io.ByteBufferPool;<a name="line.51"></a> -<span class="sourceLineNo">052</span>import org.apache.hadoop.hbase.monitoring.MonitoredRPCHandler;<a name="line.52"></a> -<span class="sourceLineNo">053</span>import org.apache.hadoop.hbase.monitoring.TaskMonitor;<a name="line.53"></a> -<span class="sourceLineNo">054</span>import org.apache.hadoop.hbase.nio.ByteBuff;<a name="line.54"></a> -<span class="sourceLineNo">055</span>import org.apache.hadoop.hbase.nio.MultiByteBuff;<a name="line.55"></a> -<span class="sourceLineNo">056</span>import org.apache.hadoop.hbase.nio.SingleByteBuff;<a name="line.56"></a> -<span class="sourceLineNo">057</span>import org.apache.hadoop.hbase.regionserver.RSRpcServices;<a name="line.57"></a> -<span class="sourceLineNo">058</span>import org.apache.hadoop.hbase.security.SaslUtil;<a name="line.58"></a> -<span class="sourceLineNo">059</span>import org.apache.hadoop.hbase.security.SaslUtil.QualityOfProtection;<a name="line.59"></a> -<span class="sourceLineNo">060</span>import org.apache.hadoop.hbase.security.User;<a name="line.60"></a> -<span class="sourceLineNo">061</span>import org.apache.hadoop.hbase.security.UserProvider;<a name="line.61"></a> -<span class="sourceLineNo">062</span>import org.apache.hadoop.hbase.security.token.AuthenticationTokenSecretManager;<a name="line.62"></a> -<span class="sourceLineNo">063</span>import org.apache.hadoop.hbase.util.Pair;<a name="line.63"></a> -<span class="sourceLineNo">064</span>import org.apache.hadoop.security.UserGroupInformation;<a name="line.64"></a> -<span class="sourceLineNo">065</span>import org.apache.hadoop.security.authorize.AuthorizationException;<a name="line.65"></a> -<span class="sourceLineNo">066</span>import org.apache.hadoop.security.authorize.PolicyProvider;<a name="line.66"></a> -<span class="sourceLineNo">067</span>import org.apache.hadoop.security.authorize.ServiceAuthorizationManager;<a name="line.67"></a> -<span class="sourceLineNo">068</span>import org.apache.hadoop.security.token.SecretManager;<a name="line.68"></a> -<span class="sourceLineNo">069</span>import org.apache.hadoop.security.token.TokenIdentifier;<a name="line.69"></a> -<span class="sourceLineNo">070</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.70"></a> -<span class="sourceLineNo">071</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.71"></a> -<span class="sourceLineNo">072</span><a name="line.72"></a> -<span class="sourceLineNo">073</span>import org.apache.hadoop.hbase.shaded.com.google.common.annotations.VisibleForTesting;<a name="line.73"></a> -<span class="sourceLineNo">074</span>import org.apache.hadoop.hbase.shaded.com.google.protobuf.BlockingService;<a name="line.74"></a> -<span class="sourceLineNo">075</span>import org.apache.hadoop.hbase.shaded.com.google.protobuf.Descriptors.MethodDescriptor;<a name="line.75"></a> -<span class="sourceLineNo">076</span>import org.apache.hadoop.hbase.shaded.com.google.protobuf.Message;<a name="line.76"></a> -<span class="sourceLineNo">077</span>import org.apache.hadoop.hbase.shaded.com.google.protobuf.ServiceException;<a name="line.77"></a> -<span class="sourceLineNo">078</span>import org.apache.hadoop.hbase.shaded.com.google.protobuf.TextFormat;<a name="line.78"></a> -<span class="sourceLineNo">079</span>import org.apache.hadoop.hbase.shaded.protobuf.ProtobufUtil;<a name="line.79"></a> -<span class="sourceLineNo">080</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos;<a name="line.80"></a> -<span class="sourceLineNo">081</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.ConnectionHeader;<a name="line.81"></a> -<span class="sourceLineNo">082</span><a name="line.82"></a> -<span class="sourceLineNo">083</span>/**<a name="line.83"></a> -<span class="sourceLineNo">084</span> * An RPC server that hosts protobuf described Services.<a name="line.84"></a> -<span class="sourceLineNo">085</span> *<a name="line.85"></a> -<span class="sourceLineNo">086</span> */<a name="line.86"></a> -<span class="sourceLineNo">087</span>@InterfaceAudience.LimitedPrivate({HBaseInterfaceAudience.COPROC, HBaseInterfaceAudience.PHOENIX})<a name="line.87"></a> -<span class="sourceLineNo">088</span>@InterfaceStability.Evolving<a name="line.88"></a> -<span class="sourceLineNo">089</span>public abstract class RpcServer implements RpcServerInterface,<a name="line.89"></a> -<span class="sourceLineNo">090</span> ConfigurationObserver {<a name="line.90"></a> -<span class="sourceLineNo">091</span> // LOG is being used in CallRunner and the log level is being changed in tests<a name="line.91"></a> -<span class="sourceLineNo">092</span> public static final Log LOG = LogFactory.getLog(RpcServer.class);<a name="line.92"></a> -<span class="sourceLineNo">093</span> protected static final CallQueueTooBigException CALL_QUEUE_TOO_BIG_EXCEPTION<a name="line.93"></a> -<span class="sourceLineNo">094</span> = new CallQueueTooBigException();<a name="line.94"></a> -<span class="sourceLineNo">095</span><a name="line.95"></a> -<span class="sourceLineNo">096</span> private final boolean authorize;<a name="line.96"></a> -<span class="sourceLineNo">097</span> protected boolean isSecurityEnabled;<a name="line.97"></a> -<span class="sourceLineNo">098</span><a name="line.98"></a> -<span class="sourceLineNo">099</span> public static final byte CURRENT_VERSION = 0;<a name="line.99"></a> -<span class="sourceLineNo">100</span><a name="line.100"></a> -<span class="sourceLineNo">101</span> /**<a name="line.101"></a> -<span class="sourceLineNo">102</span> * Whether we allow a fallback to SIMPLE auth for insecure clients when security is enabled.<a name="line.102"></a> -<span class="sourceLineNo">103</span> */<a name="line.103"></a> -<span class="sourceLineNo">104</span> public static final String FALLBACK_TO_INSECURE_CLIENT_AUTH =<a name="line.104"></a> -<span class="sourceLineNo">105</span> "hbase.ipc.server.fallback-to-simple-auth-allowed";<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> * How many calls/handler are allowed in the queue.<a name="line.108"></a> -<span class="sourceLineNo">109</span> */<a name="line.109"></a> -<span class="sourceLineNo">110</span> protected static final int DEFAULT_MAX_CALLQUEUE_LENGTH_PER_HANDLER = 10;<a name="line.110"></a> -<span class="sourceLineNo">111</span><a name="line.111"></a> -<span class="sourceLineNo">112</span> protected final CellBlockBuilder cellBlockBuilder;<a name="line.112"></a> -<span class="sourceLineNo">113</span><a name="line.113"></a> -<span class="sourceLineNo">114</span> protected static final String AUTH_FAILED_FOR = "Auth failed for ";<a name="line.114"></a> -<span class="sourceLineNo">115</span> protected static final String AUTH_SUCCESSFUL_FOR = "Auth successful for ";<a name="line.115"></a> -<span class="sourceLineNo">116</span> protected static final Log AUDITLOG = LogFactory.getLog("SecurityLogger."<a name="line.116"></a> -<span class="sourceLineNo">117</span> + Server.class.getName());<a name="line.117"></a> -<span class="sourceLineNo">118</span> protected SecretManager<TokenIdentifier> secretManager;<a name="line.118"></a> -<span class="sourceLineNo">119</span> protected final Map<String, String> saslProps;<a name="line.119"></a> -<span class="sourceLineNo">120</span> protected ServiceAuthorizationManager authManager;<a name="line.120"></a> -<span class="sourceLineNo">121</span><a name="line.121"></a> -<span class="sourceLineNo">122</span> /** This is set to Call object before Handler invokes an RPC and ybdie<a name="line.122"></a> -<span class="sourceLineNo">123</span> * after the call returns.<a name="line.123"></a> -<span class="sourceLineNo">124</span> */<a name="line.124"></a> -<span class="sourceLineNo">125</span> protected static final ThreadLocal<RpcCall> CurCall = new ThreadLocal<>();<a name="line.125"></a> -<span class="sourceLineNo">126</span><a name="line.126"></a> -<span class="sourceLineNo">127</span> /** Keeps MonitoredRPCHandler per handler thread. */<a name="line.127"></a> -<span class="sourceLineNo">128</span> protected static final ThreadLocal<MonitoredRPCHandler> MONITORED_RPC = new ThreadLocal<>();<a name="line.128"></a> -<span class="sourceLineNo">129</span><a name="line.129"></a> -<span class="sourceLineNo">130</span> protected final InetSocketAddress bindAddress;<a name="line.130"></a> -<span class="sourceLineNo">131</span><a name="line.131"></a> -<span class="sourceLineNo">132</span> protected MetricsHBaseServer metrics;<a name="line.132"></a> -<span class="sourceLineNo">133</span><a name="line.133"></a> -<span class="sourceLineNo">134</span> protected final Configuration conf;<a name="line.134"></a> -<span class="sourceLineNo">135</span><a name="line.135"></a> -<span class="sourceLineNo">136</span> /**<a name="line.136"></a> -<span class="sourceLineNo">137</span> * Maximum size in bytes of the currently queued and running Calls. If a new Call puts us over<a name="line.137"></a> -<span class="sourceLineNo">138</span> * this size, then we will reject the call (after parsing it though). It will go back to the<a name="line.138"></a> -<span class="sourceLineNo">139</span> * client and client will retry. Set this size with "hbase.ipc.server.max.callqueue.size". The<a name="line.139"></a> -<span class="sourceLineNo">140</span> * call queue size gets incremented after we parse a call and before we add it to the queue of<a name="line.140"></a> -<span class="sourceLineNo">141</span> * calls for the scheduler to use. It get decremented after we have 'run' the Call. The current<a name="line.141"></a> -<span class="sourceLineNo">142</span> * size is kept in {@link #callQueueSizeInBytes}.<a name="line.142"></a> -<span class="sourceLineNo">143</span> * @see #callQueueSizeInBytes<a name="line.143"></a> -<span class="sourceLineNo">144</span> * @see #DEFAULT_MAX_CALLQUEUE_SIZE<a name="line.144"></a> -<span class="sourceLineNo">145</span> */<a name="line.145"></a> -<span class="sourceLineNo">146</span> protected final long maxQueueSizeInBytes;<a name="line.146"></a> -<span class="sourceLineNo">147</span> protected static final int DEFAULT_MAX_CALLQUEUE_SIZE = 1024 * 1024 * 1024;<a name="line.147"></a> -<span class="sourceLineNo">148</span><a name="line.148"></a> -<span class="sourceLineNo">149</span> /**<a name="line.149"></a> -<span class="sourceLineNo">150</span> * This is a running count of the size in bytes of all outstanding calls whether currently<a name="line.150"></a> -<span class="sourceLineNo">151</span> * executing or queued waiting to be run.<a name="line.151"></a> -<span class="sourceLineNo">152</span> */<a name="line.152"></a> -<span class="sourceLineNo">153</span> protected final LongAdder callQueueSizeInBytes = new LongAdder();<a name="line.153"></a> -<span class="sourceLineNo">154</span><a name="line.154"></a> -<span class="sourceLineNo">155</span> protected final boolean tcpNoDelay; // if T then disable Nagle's Algorithm<a name="line.155"></a> -<span class="sourceLineNo">156</span> protected final boolean tcpKeepAlive; // if T then use keepalives<a name="line.156"></a> -<span class="sourceLineNo">157</span><a name="line.157"></a> -<span class="sourceLineNo">158</span> /**<a name="line.158"></a> -<span class="sourceLineNo">159</span> * This flag is used to indicate to sub threads when they should go down. When we call<a name="line.159"></a> -<span class="sourceLineNo">160</span> * {@link #start()}, all threads started will consult this flag on whether they should<a name="line.160"></a> -<span class="sourceLineNo">161</span> * keep going. It is set to false when {@link #stop()} is called.<a name="line.161"></a> -<span class="sourceLineNo">162</span> */<a name="line.162"></a> -<span class="sourceLineNo">163</span> volatile boolean running = true;<a name="line.163"></a> -<span class="sourceLineNo">164</span><a name="line.164"></a> -<span class="sourceLineNo">165</span> /**<a name="line.165"></a> -<span class="sourceLineNo">166</span> * This flag is set to true after all threads are up and 'running' and the server is then opened<a name="line.166"></a> -<span class="sourceLineNo">167</span> * for business by the call to {@link #start()}.<a name="line.167"></a> -<span class="sourceLineNo">168</span> */<a name="line.168"></a> -<span class="sourceLineNo">169</span> volatile boolean started = false;<a name="line.169"></a> -<span class="sourceLineNo">170</span><a name="line.170"></a> -<span class="sourceLineNo">171</span> protected AuthenticationTokenSecretManager authTokenSecretMgr = null;<a name="line.171"></a> -<span class="sourceLineNo">172</span><a name="line.172"></a> -<span class="sourceLineNo">173</span> protected HBaseRPCErrorHandler errorHandler = null;<a name="line.173"></a> -<span class="sourceLineNo">174</span><a name="line.174"></a> -<span class="sourceLineNo">175</span> public static final String MAX_REQUEST_SIZE = "hbase.ipc.max.request.size";<a name="line.175"></a> -<span class="sourceLineNo">176</span> protected static final RequestTooBigException REQUEST_TOO_BIG_EXCEPTION =<a name="line.176"></a> -<span class="sourceLineNo">177</span> new RequestTooBigException();<a name="line.177"></a> -<span class="sourceLineNo">178</span><a name="line.178"></a> -<span class="sourceLineNo">179</span> protected static final String WARN_RESPONSE_TIME = "hbase.ipc.warn.response.time";<a name="line.179"></a> -<span class="sourceLineNo">180</span> protected static final String WARN_RESPONSE_SIZE = "hbase.ipc.warn.response.size";<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> * Minimum allowable timeout (in milliseconds) in rpc request's header. This<a name="line.183"></a> -<span class="sourceLineNo">184</span> * configuration exists to prevent the rpc service regarding this request as timeout immediately.<a name="line.184"></a> -<span class="sourceLineNo">185</span> */<a name="line.185"></a> -<span class="sourceLineNo">186</span> protected static final String MIN_CLIENT_REQUEST_TIMEOUT = "hbase.ipc.min.client.request.timeout";<a name="line.186"></a> -<span class="sourceLineNo">187</span> protected static final int DEFAULT_MIN_CLIENT_REQUEST_TIMEOUT = 20;<a name="line.187"></a> -<span class="sourceLineNo">188</span><a name="line.188"></a> -<span class="sourceLineNo">189</span> /** Default value for above params */<a name="line.189"></a> -<span class="sourceLineNo">190</span> public static final int DEFAULT_MAX_REQUEST_SIZE = DEFAULT_MAX_CALLQUEUE_SIZE / 4; // 256M<a name="line.190"></a> -<span class="sourceLineNo">191</span> protected static final int DEFAULT_WARN_RESPONSE_TIME = 10000; // milliseconds<a name="line.191"></a> -<span class="sourceLineNo">192</span> protected static final int DEFAULT_WARN_RESPONSE_SIZE = 100 * 1024 * 1024;<a name="line.192"></a> -<span class="sourceLineNo">193</span><a name="line.193"></a> -<span class="sourceLineNo">194</span> protected static final ObjectMapper MAPPER = new ObjectMapper();<a name="line.194"></a> -<span class="sourceLineNo">195</span><a name="line.195"></a> -<span class="sourceLineNo">196</span> protected final int maxRequestSize;<a name="line.196"></a> -<span class="sourceLineNo">197</span> protected final int warnResponseTime;<a name="line.197"></a> -<span class="sourceLineNo">198</span> protected final int warnResponseSize;<a name="line.198"></a> -<span class="sourceLineNo">199</span><a name="line.199"></a> -<span class="sourceLineNo">200</span> protected final int minClientRequestTimeout;<a name="line.200"></a> -<span class="sourceLineNo">201</span><a name="line.201"></a> -<span class="sourceLineNo">202</span> protected final Server server;<a name="line.202"></a> -<span class="sourceLineNo">203</span> protected final List<BlockingServiceAndInterface> services;<a name="line.203"></a> -<span class="sourceLineNo">204</span><a name="line.204"></a> -<span class="sourceLineNo">205</span> protected final RpcScheduler scheduler;<a name="line.205"></a> -<span class="sourceLineNo">206</span><a name="line.206"></a> -<span class="sourceLineNo">207</span> protected UserProvider userProvider;<a name="line.207"></a> -<span class="sourceLineNo">208</span><a name="line.208"></a> -<span class="sourceLineNo">209</span> protected final ByteBufferPool reservoir;<a name="line.209"></a> -<span class="sourceLineNo">210</span> // The requests and response will use buffers from ByteBufferPool, when the size of the<a name="line.210"></a> -<span class="sourceLineNo">211</span> // request/response is at least this size.<a name="line.211"></a> -<span class="sourceLineNo">212</span> // We make this to be 1/6th of the pool buffer size.<a name="line.212"></a> -<span class="sourceLineNo">213</span> protected final int minSizeForReservoirUse;<a name="line.213"></a> -<span class="sourceLineNo">214</span><a name="line.214"></a> -<span class="sourceLineNo">215</span> protected volatile boolean allowFallbackToSimpleAuth;<a name="line.215"></a> -<span class="sourceLineNo">216</span><a name="line.216"></a> -<span class="sourceLineNo">217</span> /**<a name="line.217"></a> -<span class="sourceLineNo">218</span> * Used to get details for scan with a scanner_id<br/><a name="line.218"></a> -<span class="sourceLineNo">219</span> * TODO try to figure out a better way and remove reference from regionserver package later.<a name="line.219"></a> -<span class="sourceLineNo">220</span> */<a name="line.220"></a> -<span class="sourceLineNo">221</span> private RSRpcServices rsRpcServices;<a name="line.221"></a> -<span class="sourceLineNo">222</span><a name="line.222"></a> -<span class="sourceLineNo">223</span> @FunctionalInterface<a name="line.223"></a> -<span class="sourceLineNo">224</span> protected static interface CallCleanup {<a name="line.224"></a> -<span class="sourceLineNo">225</span> void run();<a name="line.225"></a> -<span class="sourceLineNo">226</span> }<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> * Datastructure for passing a {@link BlockingService} and its associated class of<a name="line.229"></a> -<span class="sourceLineNo">230</span> * protobuf service interface. For example, a server that fielded what is defined<a name="line.230"></a> -<span class="sourceLineNo">231</span> * in the client protobuf service would pass in an implementation of the client blocking service<a name="line.231"></a> -<span class="sourceLineNo">232</span> * and then its ClientService.BlockingInterface.class. Used checking connection setup.<a name="line.232"></a> -<span class="sourceLineNo">233</span> */<a name="line.233"></a> -<span class="sourceLineNo">234</span> public static class BlockingServiceAndInterface {<a name="line.234"></a> -<span class="sourceLineNo">235</span> private final BlockingService service;<a name="line.235"></a> -<span class="sourceLineNo">236</span> private final Class<?> serviceInterface;<a name="line.236"></a> -<span class="sourceLineNo">237</span> public BlockingServiceAndInterface(final BlockingService service,<a name="line.237"></a> -<span class="sourceLineNo">238</span> final Class<?> serviceInterface) {<a name="line.238"></a> -<span class="sourceLineNo">239</span> this.service = service;<a name="line.239"></a> -<span class="sourceLineNo">240</span> this.serviceInterface = serviceInterface;<a name="line.240"></a> -<span class="sourceLineNo">241</span> }<a name="line.241"></a> -<span class="sourceLineNo">242</span> public Class<?> getServiceInterface() {<a name="line.242"></a> -<span class="sourceLineNo">243</span> return this.serviceInterface;<a name="line.243"></a> -<span class="sourceLineNo">244</span> }<a name="line.244"></a> -<span class="sourceLineNo">245</span> public BlockingService getBlockingService() {<a name="line.245"></a> -<span class="sourceLineNo">246</span> return this.service;<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><a name="line.249"></a> -<span class="sourceLineNo">250</span> /**<a name="line.250"></a> -<span class="sourceLineNo">251</span> * Constructs a server listening on the named port and address.<a name="line.251"></a> -<span class="sourceLineNo">252</span> * @param server hosting instance of {@link Server}. We will do authentications if an<a name="line.252"></a> -<span class="sourceLineNo">253</span> * instance else pass null for no authentication check.<a name="line.253"></a> -<span class="sourceLineNo">254</span> * @param name Used keying this rpc servers' metrics and for naming the Listener thread.<a name="line.254"></a> -<span class="sourceLineNo">255</span> * @param services A list of services.<a name="line.255"></a> -<span class="sourceLineNo">256</span> * @param bindAddress Where to listen<a name="line.256"></a> -<span class="sourceLineNo">257</span> * @param conf<a name="line.257"></a> -<span class="sourceLineNo">258</span> * @param scheduler<a name="line.258"></a> -<span class="sourceLineNo">259</span> */<a name="line.259"></a> -<span class="sourceLineNo">260</span> public RpcServer(final Server server, final String name,<a name="line.260"></a> -<span class="sourceLineNo">261</span> final List<BlockingServiceAndInterface> services,<a name="line.261"></a> -<span class="sourceLineNo">262</span> final InetSocketAddress bindAddress, Configuration conf,<a name="line.262"></a> -<span class="sourceLineNo">263</span> RpcScheduler scheduler)<a name="line.263"></a> -<span class="sourceLineNo">264</span> throws IOException {<a name="line.264"></a> -<span class="sourceLineNo">265</span> if (conf.getBoolean("hbase.ipc.server.reservoir.enabled", true)) {<a name="line.265"></a> -<span class="sourceLineNo">266</span> int poolBufSize = conf.getInt(ByteBufferPool.BUFFER_SIZE_KEY,<a name="line.266"></a> -<span class="sourceLineNo">267</span> ByteBufferPool.DEFAULT_BUFFER_SIZE);<a name="line.267"></a> -<span class="sourceLineNo">268</span> // The max number of buffers to be pooled in the ByteBufferPool. The default value been<a name="line.268"></a> -<span class="sourceLineNo">269</span> // selected based on the #handlers configured. When it is read request, 2 MB is the max size<a name="line.269"></a> -<span class="sourceLineNo">270</span> // at which we will send back one RPC request. Means max we need 2 MB for creating the<a name="line.270"></a> -<span class="sourceLineNo">271</span> // response cell block. (Well it might be much lesser than this because in 2 MB size calc, we<a name="line.271"></a> -<span class="sourceLineNo">272</span> // include the heap size overhead of each cells also.) Considering 2 MB, we will need<a name="line.272"></a> -<span class="sourceLineNo">273</span> // (2 * 1024 * 1024) / poolBufSize buffers to make the response cell block. Pool buffer size<a name="line.273"></a> -<span class="sourceLineNo">274</span> // is by default 64 KB.<a name="line.274"></a> -<span class="sourceLineNo">275</span> // In case of read request, at the end of the handler process, we will make the response<a name="line.275"></a> -<span class="sourceLineNo">276</span> // cellblock and add the Call to connection's response Q and a single Responder thread takes<a name="line.276"></a> -<span class="sourceLineNo">277</span> // connections and responses from that one by one and do the socket write. So there is chances<a name="line.277"></a> -<span class="sourceLineNo">278</span> // that by the time a handler originated response is actually done writing to socket and so<a name="line.278"></a> -<span class="sourceLineNo">279</span> // released the BBs it used, the handler might have processed one more read req. On an avg 2x<a name="line.279"></a> -<span class="sourceLineNo">280</span> // we consider and consider that also for the max buffers to pool<a name="line.280"></a> -<span class="sourceLineNo">281</span> int bufsForTwoMB = (2 * 1024 * 1024) / poolBufSize;<a name="line.281"></a> -<span class="sourceLineNo">282</span> int maxPoolSize = conf.getInt(ByteBufferPool.MAX_POOL_SIZE_KEY,<a name="line.282"></a> -<span class="sourceLineNo">283</span> conf.getInt(HConstants.REGION_SERVER_HANDLER_COUNT,<a name="line.283"></a> -<span class="sourceLineNo">284</span> HConstants.DEFAULT_REGION_SERVER_HANDLER_COUNT) * bufsForTwoMB * 2);<a name="line.284"></a> -<span class="sourceLineNo">285</span> this.reservoir = new ByteBufferPool(poolBufSize, maxPoolSize);<a name="line.285"></a> -<span class="sourceLineNo">286</span> this.minSizeForReservoirUse = getMinSizeForReservoirUse(this.reservoir);<a name="line.286"></a> -<span class="sourceLineNo">287</span> } else {<a name="line.287"></a> -<span class="sourceLineNo">288</span> reservoir = null;<a name="line.288"></a> -<span class="sourceLineNo">289</span> this.minSizeForReservoirUse = Integer.MAX_VALUE;// reservoir itself not in place.<a name="line.289"></a> -<span class="sourceLineNo">290</span> }<a name="line.290"></a> -<span class="sourceLineNo">291</span> this.server = server;<a name="line.291"></a> -<span class="sourceLineNo">292</span> this.services = services;<a name="line.292"></a> -<span class="sourceLineNo">293</span> this.bindAddress = bindAddress;<a name="line.293"></a> -<span class="sourceLineNo">294</span> this.conf = conf;<a name="line.294"></a> -<span class="sourceLineNo">295</span> // See declaration above for documentation on what this size is.<a name="line.295"></a> -<span class="sourceLineNo">296</span> this.maxQueueSizeInBytes =<a name="line.296"></a> -<span class="sourceLineNo">297</span> this.conf.getLong("hbase.ipc.server.max.callqueue.size", DEFAULT_MAX_CALLQUEUE_SIZE);<a name="line.297"></a> -<span class="sourceLineNo">298</span><a name="line.298"></a> -<span class="sourceLineNo">299</span> this.warnResponseTime = conf.getInt(WARN_RESPONSE_TIME, DEFAULT_WARN_RESPONSE_TIME);<a name="line.299"></a> -<span class="sourceLineNo">300</span> this.warnResponseSize = conf.getInt(WARN_RESPONSE_SIZE, DEFAULT_WARN_RESPONSE_SIZE);<a name="line.300"></a> -<span class="sourceLineNo">301</span> this.minClientRequestTimeout = conf.getInt(MIN_CLIENT_REQUEST_TIMEOUT,<a name="line.301"></a> -<span class="sourceLineNo">302</span> DEFAULT_MIN_CLIENT_REQUEST_TIMEOUT);<a name="line.302"></a> -<span class="sourceLineNo">303</span> this.maxRequestSize = conf.getInt(MAX_REQUEST_SIZE, DEFAULT_MAX_REQUEST_SIZE);<a name="line.303"></a> -<span class="sourceLineNo">304</span><a name="line.304"></a> -<span class="sourceLineNo">305</span> this.metrics = new MetricsHBaseServer(name, new MetricsHBaseServerWrapperImpl(this));<a name="line.305"></a> -<span class="sourceLineNo">306</span> this.tcpNoDelay = conf.getBoolean("hbase.ipc.server.tcpnodelay", true);<a name="line.306"></a> -<span class="sourceLineNo">307</span> this.tcpKeepAlive = conf.getBoolean("hbase.ipc.server.tcpkeepalive", true);<a name="line.307"></a> -<span class="sourceLineNo">308</span><a name="line.308"></a> -<span class="sourceLineNo">309</span> this.cellBlockBuilder = new CellBlockBuilder(conf);<a name="line.309"></a> -<span class="sourceLineNo">310</span><a name="line.310"></a> -<span class="sourceLineNo">311</span> this.authorize = conf.getBoolean(HADOOP_SECURITY_AUTHORIZATION, false);<a name="line.311"></a> -<span class="sourceLineNo">312</span> this.userProvider = UserProvider.instantiate(conf);<a name="line.312"></a> -<span class="sourceLineNo">313</span> this.isSecurityEnabled = userProvider.isHBaseSecurityEnabled();<a name="line.313"></a> -<span class="sourceLineNo">314</span> if (isSecurityEnabled) {<a name="line.314"></a> -<span class="sourceLineNo">315</span> saslProps = SaslUtil.initSaslProperties(conf.get("hbase.rpc.protection",<a name="line.315"></a> -<span class="sourceLineNo">316</span> QualityOfProtection.AUTHENTICATION.name().toLowerCase(Locale.ROOT)));<a name="line.316"></a> -<span class="sourceLineNo">317</span> } else {<a name="line.317"></a> -<span class="sourceLineNo">318</span> saslProps = Collections.emptyMap();<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> this.scheduler = scheduler;<a name="line.321"></a> -<span class="sourceLineNo">322</span> }<a name="line.322"></a> -<span class="sourceLineNo">323</span><a name="line.323"></a> -<span class="sourceLineNo">324</span> @VisibleForTesting<a name="line.324"></a> -<span class="sourceLineNo">325</span> static int getMinSizeForReservoirUse(ByteBufferPool pool) {<a name="line.325"></a> -<span class="sourceLineNo">326</span> return pool.getBufferSize() / 6;<a name="line.326"></a> -<span class="sourceLineNo">327</span> }<a name="line.327"></a> -<span class="sourceLineNo">328</span><a name="line.328"></a> -<span class="sourceLineNo">329</span> @Override<a name="line.329"></a> -<span class="sourceLineNo">330</span> public void onConfigurationChange(Configuration newConf) {<a name="line.330"></a> -<span class="sourceLineNo">331</span> initReconfigurable(newConf);<a name="line.331"></a> -<span class="sourceLineNo">332</span> if (scheduler instanceof ConfigurationObserver) {<a name="line.332"></a> -<span class="sourceLineNo">333</span> ((ConfigurationObserver) scheduler).onConfigurationChange(newConf);<a name="line.333"></a> -<span class="sourceLineNo">334</span> }<a name="line.334"></a> -<span class="sourceLineNo">335</span> }<a name="line.335"></a> -<span class="sourceLineNo">336</span><a name="line.336"></a> -<span class="sourceLineNo">337</span> protected void initReconfigurable(Configuration confToLoad) {<a name="line.337"></a> -<span class="sourceLineNo">338</span> this.allowFallbackToSimpleAuth = confToLoad.getBoolean(FALLBACK_TO_INSECURE_CLIENT_AUTH, false);<a name="line.338"></a> -<span class="sourceLineNo">339</span> if (isSecurityEnabled && allowFallbackToSimpleAuth) {<a name="line.339"></a> -<span class="sourceLineNo">340</span> LOG.warn("********* WARNING! *********");<a name="line.340"></a> -<span class="sourceLineNo">341</span> LOG.warn("This server is configured to allow connections from INSECURE clients");<a name="line.341"></a> -<span class="sourceLineNo">342</span> LOG.warn("(" + FALLBACK_TO_INSECURE_CLIENT_AUTH + " = true).");<a name="line.342"></a> -<span class="sourceLineNo">343</span> LOG.warn("While this option is enabled, client identities cannot be secured, and user");<a name="line.343"></a> -<span class="sourceLineNo">344</span> LOG.warn("impersonation is possible!");<a name="line.344"></a> -<span class="sourceLineNo">345</span> LOG.warn("For secure operation, please disable SIMPLE authentication as soon as possible,");<a name="line.345"></a> -<span class="sourceLineNo">346</span> LOG.warn("by setting " + FALLBACK_TO_INSECURE_CLIENT_AUTH + " = false in hbase-site.xml");<a name="line.346"></a> -<span class="sourceLineNo">347</span> LOG.warn("****************************");<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> Configuration getConf() {<a name="line.351"></a> -<span class="sourceLineNo">352</span> return conf;<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> @Override<a name="line.355"></a> -<span class="sourceLineNo">356</span> public boolean isStarted() {<a name="line.356"></a> -<span class="sourceLineNo">357</span> return this.started;<a name="line.357"></a> -<span class="sourceLineNo">358</span> }<a name="line.358"></a> -<span class="sourceLineNo">359</span><a name="line.359"></a> -<span class="sourceLineNo">360</span> @Override<a name="line.360"></a> -<span class="sourceLineNo">361</span> public synchronized void refreshAuthManager(PolicyProvider pp) {<a name="line.361"></a> -<span class="sourceLineNo">362</span> // Ignore warnings that this should be accessed in a static way instead of via an instance;<a name="line.362"></a> -<span class="sourceLineNo">363</span> // it'll break if you go via static route.<a name="line.363"></a> -<span class="sourceLineNo">364</span> this.authManager.refresh(this.conf, pp);<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> protected AuthenticationTokenSecretManager createSecretManager() {<a name="line.367"></a> -<span class="sourceLineNo">368</span> if (!isSecurityEnabled) return null;<a name="line.368"></a> -<span class="sourceLineNo">369</span> if (server == null) return null;<a name="line.369"></a> -<span class="sourceLineNo">370</span> Configuration conf = server.getConfiguration();<a name="line.370"></a> -<span class="sourceLineNo">371</span> long keyUpdateInterval =<a name="line.371"></a> -<span class="sourceLineNo">372</span> conf.getLong("hbase.auth.key.update.interval", 24*60*60*1000);<a name="line.372"></a> -<span class="sourceLineNo">373</span> long maxAge =<a name="line.373"></a> -<span class="sourceLineNo">374</span> conf.getLong("hbase.auth.token.max.lifetime", 7*24*60*60*1000);<a name="line.374"></a> -<span class="sourceLineNo">375</span> return new AuthenticationTokenSecretManager(conf, server.getZooKeeper(),<a name="line.375"></a> -<span class="sourceLineNo">376</span> server.getServerName().toString(), keyUpdateInterval, maxAge);<a name="line.376"></a> -<span class="sourceLineNo">377</span> }<a name="line.377"></a> -<span class="sourceLineNo">378</span><a name="line.378"></a> -<span class="sourceLineNo">379</span> public SecretManager<? extends TokenIdentifier> getSecretManager() {<a name="line.379"></a> -<span class="sourceLineNo">380</span> return this.secretManager;<a name="line.380"></a> -<span class="sourceLineNo">381</span> }<a name="line.381"></a> -<span class="sourceLineNo">382</span><a name="line.382"></a> -<span class="sourceLineNo">383</span> @SuppressWarnings("unchecked")<a name="line.383"></a> -<span class="sourceLineNo">384</span> public void setSecretManager(SecretManager<? extends TokenIdentifier> secretManager) {<a name="line.384"></a> -<span class="sourceLineNo">385</span> this.secretManager = (SecretManager<TokenIdentifier>) secretManager;<a name="line.385"></a> -<span class="sourceLineNo">386</span> }<a name="line.386"></a> -<span class="sourceLineNo">387</span><a name="line.387"></a> -<span class="sourceLineNo">388</span> /**<a name="line.388"></a> -<span class="sourceLineNo">389</span> * This is a server side method, which is invoked over RPC. On success<a name="line.389"></a> -<span class="sourceLineNo">390</span> * the return response has protobuf response payload. On failure, the<a name="line.390"></a> -<span class="sourceLineNo">391</span> * exception name and the stack trace are returned in the protobuf response.<a name="line.391"></a> -<span class="sourceLineNo">392</span> */<a name="line.392"></a> -<span class="sourceLineNo">393</span> @Override<a name="line.393"></a> -<span class="sourceLineNo">394</span> public Pair<Message, CellScanner> call(RpcCall call,<a name="line.394"></a> -<span class="sourceLineNo">395</span> MonitoredRPCHandler status) throws IOException {<a name="line.395"></a> -<span class="sourceLineNo">396</span> try {<a name="line.396"></a> -<span class="sourceLineNo">397</span> MethodDescriptor md = call.getMethod();<a name="line.397"></a> -<span class="sourceLineNo">398</span> Message param = call.getParam();<a name="line.398"></a> -<span class="sourceLineNo">399</span> status.setRPC(md.getName(), new Object[]{param},<a name="line.399"></a> -<span class="sourceLineNo">400</span> call.getReceiveTime());<a name="line.400"></a> -<span class="sourceLineNo">401</span> // TODO: Review after we add in encoded data blocks.<a name="line.401"></a> -<span class="sourceLineNo">402</span> status.setRPCPacket(param);<a name="line.402"></a> -<span class="sourceLineNo">403</span> status.resume("Servicing call");<a name="line.403"></a> -<span class="sourceLineNo">404</span> //get an instance of the method arg type<a name="line.404"></a> -<span class="sourceLineNo">405</span> HBaseRpcController controller = new HBaseRpcControllerImpl(call.getCellScanner());<a name="line.405"></a> -<span class="sourceLineNo">406</span> controller.setCallTimeout(call.getTimeout());<a name="line.406"></a> -<span class="sourceLineNo">407</span> Message result = call.getService().callBlockingMethod(md, controller, param);<a name="line.407"></a> -<span class="sourceLineNo">408</span> long receiveTime = call.getReceiveTime();<a name="line.408"></a> -<span class="sourceLineNo">409</span> long startTime = call.getStartTime();<a name="line.409"></a> -<span class="sourceLineNo">410</span> long endTime = System.currentTimeMillis();<a name="line.410"></a> -<span class="sourceLineNo">411</span> int processingTime = (int) (endTime - startTime);<a name="line.411"></a> -<span class="sourceLineNo">412</span> int qTime = (int) (startTime - receiveTime);<a name="line.412"></a> -<span class="sourceLineNo">413</span> int totalTime = (int) (endTime - receiveTime);<a name="line.413"></a> -<span class="sourceLineNo">414</span> if (LOG.isTraceEnabled()) {<a name="line.414"></a> -<span class="sourceLineNo">415</span> LOG.trace(CurCall.get().toString() +<a name="line.415"></a> -<span class="sourceLineNo">416</span> ", response " + TextFormat.shortDebugString(result) +<a name="line.416"></a> -<span class="sourceLineNo">417</span> " queueTime: " + qTime +<a name="line.417"></a> -<span class="sourceLineNo">418</span> " processingTime: " + processingTime +<a name="line.418"></a> -<span class="sourceLineNo">419</span> " totalTime: " + totalTime);<a name="line.419"></a> -<span class="sourceLineNo">420</span> }<a name="line.420"></a> -<span class="sourceLineNo">421</span> // Use the raw request call size for now.<a name="line.421"></a> -<span class="sourceLineNo">422</span> long requestSize = call.getSize();<a name="line.422"></a> -<span class="sourceLineNo">423</span> long responseSize = result.getSerializedSize();<a name="line.423"></a> -<span class="sourceLineNo">424</span> if (call.isClientCellBlockSupported()) {<a name="line.424"></a> -<span class="sourceLineNo">425</span> // Include the payload size in HBaseRpcController<a name="line.425"></a> -<span class="sourceLineNo">426</span> responseSize += call.getResponseCellSize();<a name="line.426"></a> -<span class="sourceLineNo">427</span> }<a name="line.427"></a> -<span class="sourceLineNo">428</span><a name="line.428"></a> -<span class="sourceLineNo">429</span> metrics.dequeuedCall(qTime);<a name="line.429"></a> -<span class="sourceLineNo">430</span> metrics.processedCall(processingTime);<a name="line.430"></a> -<span class="sourceLineNo">431</span> metrics.totalCall(totalTime);<a name="line.431"></a> -<span class="sourceLineNo">432</span> metrics.receivedRequest(requestSize);<a name="line.432"></a> -<span class="sourceLineNo">433</span> metrics.sentResponse(responseSize);<a name="line.433"></a> -<span class="sourceLineNo">434</span> // log any RPC responses that are slower than the configured warn<a name="line.434"></a> -<span class="sourceLineNo">435</span> // response time or larger than configured warning size<a name="line.435"></a> -<span class="sourceLineNo">436</span> boolean tooSlow = (processingTime > warnResponseTime && warnResponseTime > -1);<a name="line.436"></a> -<span class="sourceLineNo">437</span> boolean tooLarge = (responseSize > warnResponseSize && warnResponseSize > -1);<a name="line.437"></a> -<span class="sourceLineNo">438</span> if (tooSlow || tooLarge) {<a name="line.438"></a> -<span class="sourceLineNo">439</span> // when tagging, we let TooLarge trump TooSmall to keep output simple<a name="line.439"></a> -<span class="sourceLineNo">440</span> // note that large responses will often also be slow.<a name="line.440"></a> -<span class="sourceLineNo">441</span> logResponse(param,<a name="line.441"></a> -<span class="sourceLineNo">442</span> md.getName(), md.getName() + "(" + param.getClass().getName() + ")",<a name="line.442"></a> -<span class="sourceLineNo">443</span> (tooLarge ? "TooLarge" : "TooSlow"),<a name="line.443"></a> -<span class="sourceLineNo">444</span> status.getClient(), startTime, processingTime, qTime,<a name="line.444"></a> -<span class="sourceLineNo">445</span> responseSize);<a name="line.445"></a> -<span class="sourceLineNo">446</span> }<a name="line.446"></a> -<span class="sourceLineNo">447</span> return new Pair<>(result, controller.cellScanner());<a name="line.447"></a> -<span class="sourceLineNo">448</span> } catch (Throwable e) {<a name="line.448"></a> -<span class="sourceLineNo">449</span> // The above callBlockingMethod will always return a SE. Strip the SE wrapper before<a name="line.449"></a> -<span class="sourceLineNo">450</span> // putting it on the wire. Its needed to adhere to the pb Service Interface but we don't<a name="line.450"></a> -<span class="sourceLineNo">451</span> // need to pass it over the wire.<a name="line.451"></a> -<span class="sourceLineNo">452</span> if (e instanceof ServiceException) {<a name="line.452"></a> -<span class="sourceLineNo">453</span> if (e.getCause() == null) {<a name="line.453"></a> -<span class="sourceLineNo">454</span> LOG.debug("Caught a ServiceException with null cause", e);<a name="line.454"></a> -<span class="sourceLineNo">455</span> } else {<a name="line.455"></a> -<span class="sourceLineNo">456</span> e = e.getCause();<a name="line.456"></a> -<span class="sourceLineNo">457</span> }<a name="line.457"></a> -<span class="sourceLineNo">458</span> }<a name="line.458"></a> -<span class="sourceLineNo">459</span><a name="line.459"></a> -<span class="sourceLineNo">460</span> // increment the number of requests that were exceptions.<a name="line.460"></a> -<span class="sourceLineNo">461</span> metrics.exception(e);<a name="line.461"></a> -<span class="sourceLineNo">462</span><a name="line.462"></a> -<span class="sourceLineNo">463</span> if (e instanceof LinkageError) throw new DoNotRetryIOException(e);<a name="line.463"></a> -<span class="sourceLineNo">464</span> if (e instanceof IOException) throw (IOException)e;<a name="line.464"></a> -<span class="sourceLineNo">465</span> LOG.error("Unexpected throwable object ", e);<a name="line.465"></a> -<span class="sourceLineNo">466</span> throw new IOException(e.getMessage(), e);<a name="line.466"></a> -<span class="sourceLineNo">467</span> }<a name="line.467"></a> -<span class="sourceLineNo">468</span> }<a name="line.468"></a> -<span class="sourceLineNo">469</span><a name="line.469"></a> -<span class="sourceLineNo">470</span> /**<a name="line.470"></a> -<span class="sourceLineNo">471</span> * Logs an RPC response to the LOG file, producing valid JSON objects for<a name="line.471"></a> -<span class="sourceLineNo">472</span> * client Operations.<a name="line.472"></a> -<span class="sourceLineNo">473</span> * @param param The parameters received in the call.<a name="line.473"></a> -<span class="sourceLineNo">474</span> * @param methodName The name of the method invoked<a name="line.474"></a> -<span class="sourceLineNo">475</span> * @param call The string representation of the call<a name="line.475"></a> -<span class="sourceLineNo">476</span> * @param tag The tag that will be used to indicate this event in the log.<a name="line.476"></a> -<span class="sourceLineNo">477</span> * @param clientAddress The address of the client who made this call.<a name="line.477"></a> -<span class="sourceLineNo">478</span> * @param startTime The time that the call was initiated, in ms.<a name="line.478"></a> -<span class="sourceLineNo">479</span> * @param processingTime The duration that the call took to run, in ms.<a name="line.479"></a> -<span class="sourceLineNo">480</span> * @param qTime The duration that the call spent on the queue<a name="line.480"></a> -<span class="sourceLineNo">481</span> * prior to being initiated, in ms.<a name="line.481"></a> -<span class="sourceLineNo">482</span> * @param responseSize The size in bytes of the response buffer.<a name="line.482"></a> -<span class="sourceLineNo">483</span> */<a name="line.483"></a> -<span class="sourceLineNo">484</span> void logResponse(Message param, String methodName, String call, String tag,<a name="line.484"></a> -<span class="sourceLineNo">485</span> String clientAddress, long startTime, int processingTime, int qTime,<a name="line.485"></a> -<span class="sourceLineNo">486</span> long responseSize) throws IOException {<a name="line.486"></a> -<span class="sourceLineNo">487</span> // base information that is reported regardless of type of call<a name="line.487"></a> -<span class="sourceLineNo">488</span> Map<String, Object> responseInfo = new HashMap<>();<a name="line.488"></a> -<span class="sourceLineNo">489</span> responseInfo.put("starttimems", startTime);<a name="line.489"></a> -<span class="sourceLineNo">490</span> responseInfo.put("processingtimems", processingTime);<a name="line.490"></a> -<span class="sourceLineNo">491</span> responseInfo.put("queuetimems", qTime);<a name="line.491"></a> -<span class="sourceLineNo">492</span> responseInfo.put("responsesize", responseSize);<a name="line.492"></a> -<span class="sourceLineNo">493</span> responseInfo.put("client", clientAddress);<a name="line.493"></a> -<span class="sourceLineNo">494</span> responseInfo.put("class", server == null? "": server.getClass().getSimpleName());<a name="line.494"></a> -<span class="sourceLineNo">495</span> responseInfo.put("method", methodName);<a name="line.495"></a> -<span class="sourceLineNo">496</span> responseInfo.put("call", call);<a name="line.496"></a> -<span class="sourceLineNo">497</span> responseInfo.put("param", ProtobufUtil.getShortTextFormat(param));<a name="line.497"></a> -<span class="sourceLineNo">498</span> if (param instanceof ClientProtos.ScanRequest && rsRpcServices != null) {<a name="line.498"></a> -<span class="sourceLineNo">499</span> ClientProtos.ScanRequest request = ((ClientProtos.ScanRequest) param);<a name="line.499"></a> -<span class="sourceLineNo">500</span> if (request.hasScannerId()) {<a name="line.500"></a> -<span class="sourceLineNo">501</span> long scannerId = request.getScannerId();<a name="line.501"></a> -<span class="sourceLineNo">502</span> String scanDetails = rsRpcServices.getScanDetailsWithId(scannerId);<a name="line.502"></a> -<span class="sourceLineNo">503</span> if (scanDetails != null) {<a name="line.503"></a> -<span class="sourceLineNo">504</span> responseInfo.put("scandetails", scanDetails);<a name="line.504"></a> -<span class="sourceLineNo">505</span> }<a name="line.505"></a> -<span class="sourceLineNo">506</span> }<a name="line.506"></a> -<span class="sourceLineNo">507</span> }<a name="line.507"></a> -<span class="sourceLineNo">508</span> LOG.warn("(response" + tag + "): " + MAPPER.writeValueAsString(responseInfo));<a name="line.508"></a> -<span class="sourceLineNo">509</span> }<a name="line.509"></a> -<span class="sourceLineNo">510</span><a name="line.510"></a> -<span class="sourceLineNo">511</span> /**<a name="line.511"></a> -<span class="sourceLineNo">512</span> * Set the handler for calling out of RPC for error conditions.<a name="line.512"></a> -<span class="sourceLineNo">513</span> * @param handler the handler implementation<a name="line.513"></a> -<span class="sourceLineNo">514</span> */<a name="line.514"></a> -<span class="sourceLineNo">515</span> @Override<a name="line.515"></a> -<span class="sourceLineNo">516</span> public void setErrorHandler(HBaseRPCErrorHandler handler) {<a name="line.516"></a> -<span class="sourceLineNo">517</span> this.errorHandler = handler;<a name="line.517"></a> -<span class="sourceLineNo">518</span> }<a name="line.518"></a> -<span class="sourceLineNo">519</span><a name="line.519"></a> -<span class="sourceLineNo">520</span> @Override<a name="line.520"></a> -<span class="sourceLineNo">521</span> public HBaseRPCErrorHandler getErrorHandler() {<a name="line.521"></a> -<span class="sourceLineNo">522</span> return this.errorHandler;<a name="line.522"></a> -<span class="sourceLineNo">523</span> }<a name="line.523"></a> -<span class="sourceLineNo">524</span><a name="line.524"></a> -<span class="sourceLineNo">525</span> /**<a name="line.525"></a> -<span class="sourceLineNo">526</span> * Returns the metrics instance for reporting RPC call statistics<a name="line.526"></a> -<span class="sourceLineNo">527</span> */<a name="line.527"></a> -<span class="sourceLineNo">528</span> @Override<a name="line.528"></a> -<span class="sourceLineNo">529</span> public MetricsHBaseServer getMetrics() {<a name="line.529"></a> -<span class="sourceLineNo">530</span> return metrics;<a name="line.530"></a> -<span class="sourceLineNo">531</span> }<a name="line.531"></a> -<span class="sourceLineNo">532</span><a name="line.532"></a> -<span class="sourceLineNo">533</span> @Override<a name="line.533"></a> -<span class="sourceLineNo">534</span> public void addCallSize(final long diff) {<a name="line.534"></a> -<span class="sourceLineNo">535</span> this.callQueueSizeInBytes.add(diff);<a name="line.535"></a> -<span class="sourceLineNo">536</span> }<a name="line.536"></a> -<span class="sourceLineNo">537</span><a name="line.537"></a> -<span class="sourceLineNo">538</span> /**<a name="line.538"></a> -<span class="sourceLineNo">539</span> * Authorize the incoming client connection.<a name="line.539"></a> -<span class="sourceLineNo">540</span> *<a name="line.540"></a> -<span class="sourceLineNo">541</span> * @param user client user<a name="line.541"></a> -<span class="sourceLineNo">542</span> * @param connection incoming connection<a name="line.542"></a> -<span class="sourceLineNo">543</span> * @param addr InetAddress of incoming connection<a name="line.543"></a> -<span class="sourceLineNo">544</span> * @throws org.apache.hadoop.security.authorize.AuthorizationException<a name="line.544"></a> -<span class="sourceLineNo">545</span> * when the client isn't authorized to talk the protocol<a name="line.545"></a> -<span class="sourceLineNo">546</span> */<a name="line.546"></a> -<span class="sourceLineNo">547</span> public synchronized void authorize(UserGroupInformation user,<a name="line.547"></a> -<span class="sourceLineNo">548</span> ConnectionHeader connection, InetAddress addr)<a name="line.548"></a> -<span class="sourceLineNo">549</span> throws AuthorizationException {<a name="line.549"></a> -<span class="sourceLineNo">550</span> if (authorize) {<a name="line.550"></a> -<span class="sourceLineNo">551</span> Class<?> c = getServiceInterface(services, connection.getServiceName());<a name="line.551"></a> -<span class="sourceLineNo">552</span> this.authManager.authorize(user != null ? user : null, c, getConf(), addr);<a name="line.552"></a> -<span class="sourceLineNo">553</span> }<a name="line.553"></a> -<span class="sourceLineNo">554</span> }<a name="line.554"></a> -<span class="sourceLineNo">555</span><a name="line.555"></a> -<span class="sourceLineNo">556</span> /**<a name="line.556"></a> -<span class="sourceLineNo">557</span> * When the read or write buffer size is larger than this limit, i/o will be<a name="line.557"></a> -<span class="sourceLineNo">558</span> * done in chunks of this size. Most RPC requests and responses would be<a name="line.558"></a> -<span class="sourceLineNo">559</span> * be smaller.<a name="line.559"></a> -<span class="sourceLineNo">560</span> */<a name="line.560"></a> -<span class="sourceLineNo">561</span> protected static final int NIO_BUFFER_LIMIT = 64 * 1024; //should not be more than 64KB.<a name="line.561"></a> -<span class="sourceLineNo">562</span><a name="line.562"></a> -<span class="sourceLineNo">563</span> /**<a name="line.563"></a> -<span class="sourceLineNo">564</span> * This is a wrapper around {@link java.nio.channels.ReadableByteChannel#read(java.nio.ByteBuffer)}.<a name="line.564"></a> -<span class="sourceLineNo">565</span> * If the amount of data is large, it writes to channel in smaller chunks.<a name="line.565"></a> -<span class="sourceLineNo">566</span> * This is to avoid jdk from creating many direct buffers as the size of<a name="line.566"></a> -<span class="sourceLineNo">567</span> * ByteBuffer increases. There should not be any performance degredation.<a name="line.567"></a> -<span class="sourceLineNo">568</span> *<a name="line.568"></a> -<span class="sourceLineNo">569</span> * @param channel writable byte channel to write on<a name="line.569"></a> -<span class="sourceLineNo">570</span> * @param buffer buffer to write<a name="line.570"></a> -<span class="sourceLineNo">571</span> * @return number of bytes written<a name="line.571"></a> -<span class="sourceLineNo">572</span> * @throws java.io.IOException e<a name="line.572"></a> -<span class="sourceLineNo">573</span> * @see java.nio.channels.ReadableByteChannel#read(java.nio.ByteBuffer)<a name="line.573"></a> -<span class="sourceLineNo">574</span> */<a name="line.574"></a> -<span class="sourceLineNo">575</span> protected int channelRead(ReadableByteChannel channel,<a name="line.575"></a> -<span class="sourceLineNo">576</span> ByteBuffer buffer) throws IOException {<a name="line.576"></a> -<span class="sourceLineNo">577</span><a name="line.577"></a> -<span class="sourceLineNo">578</span> int count = (buffer.remaining() <= NIO_BUFFER_LIMIT) ?<a name="line.578"></a> -<span class="sourceLineNo">579</span> channel.read(buffer) : channelIO(channel, null, buffer);<a name="line.579"></a> -<span class="sourceLineNo">580</span> if (count > 0) {<a name="line.580"></a> -<span class="sourceLineNo">581</span> metrics.receivedBytes(count);<a name="line.581"></a> -<span class="sourceLineNo">582</span> }<a name="line.582"></a> -<span class="sourceLineNo">583</span> return count;<a name="line.583"></a> -<span class="sourceLineNo">584</span> }<a name="line.584"></a> -<span class="sourceLineNo">585</span><a name="line.585"></a> -<span class="sourceLineNo">586</span> /**<a name="line.586"></a> -<span class="sourceLineNo">587</span> * Helper for {@link #channelRead(java.nio.channels.ReadableByteChannel, java.nio.ByteBuffer)}<a name="line.587"></a> -<span class="sourceLineNo">588</span> * and {@link #channelWrite(GatheringByteChannel, BufferChain)}. Only<a name="line.588"></a> -<span class="sourceLineNo">589</span> * one of readCh or writeCh should be non-null.<a name="line.589"></a> -<span class="sourceLineNo">590</span> *<a name="line.590"></a> -<span class="sourceLineNo">591</span> * @param readCh read channel<a name="line.591"></a> -<span class="sourceLineNo">592</span> * @param writeCh write channel<a name="line.592"></a> -<span class="sourceLineNo">593</span> * @param buf buffer to read or write into/out of<a name="line.593"></a> -<span class="sourceLineNo">594</span> * @return bytes written<a name="line.594"></a> -<span class="sourceLineNo">595</span> * @throws java.io.IOException e<a name="line.595"></a> -<span class="sourceLineNo">596</span> * @see #channelRead(java.nio.channels.ReadableByteChannel, java.nio.ByteBuffer)<a name="line.596"></a> -<span class="sourceLineNo">597</span> * @see #channelWrite(GatheringByteChannel, BufferChain)<a name="line.597"></a> -<span class="sourceLineNo">598</span> */<a name="line.598"></a> -<span class="sourceLineNo">599</span> private static int channelIO(ReadableByteChannel readCh,<a name="line.599"></a> -<span class="sourceLineNo">600</span> WritableByteChannel writeCh,<a name="line.600"></a> -<span class="sourceLineNo">601</span> ByteBuffer buf) throws IOException {<a name="line.601"></a> -<span class="sourceLineNo">602</span><a name="line.602"></a> -<span class="sourceLineNo">603</span> int originalLimit = buf.limit();<a name="line.603"></a> -<span class="sourceLineNo">604</span> int initialRemaining = buf.remaining();<a name="line.604"></a> -<span class="sourceLineNo">605</span> int ret = 0;<a name="line.605"></a> -<span class="sourceLineNo">606</span><a name="line.606"></a> -<span class="sourceLineNo">607</span> while (buf.remaining() > 0) {<a name="line.607"></a> -<span class="sourceLineNo">608</span> try {<a name="line.608"></a> -<span class="sourceLineNo">609</span> int ioSize = Math.min(buf.remaining(), NIO_BUFFER_LIMIT);<a name="line.609"></a> -<span class="sourceLineNo">610</span> buf.limit(buf.position() + ioSize);<a name="line.610"></a> -<span class="sourceLineNo">611</span><a name="line.611"></a> -<span class="sourceLineNo">612</span> ret = (readCh == null) ? writeCh.write(buf) : readCh.read(buf);<a name="line.612"></a> -<span class="sourceLineNo">613</span><a name="line.613"></a> -<span class="sourceLineNo">614</span> if (ret < ioSize) {<a name="line.614"></a> -<span class="sourceLineNo">615</span> break;<a name="line.615"></a> -<span class="sourceLineNo">616</span> }<a name="line.616"></a> -<span class="sourceLineNo">617</span><a name="line.617"></a> -<span class="sourceLineNo">618</span> } finally {<a name="line.618"></a> -<span class="sourceLineNo">619</span> buf.limit(originalLimit);<a name="line.619"></a> -<span class="sourceLineNo">620</span> }<a name="line.620"></a> -<span class="sourceLineNo">621</span> }<a name="line.621"></a> -<span class="sourceLineNo">622</span><a name="line.622"></a> -<span class="sourceLineNo">623</span> int nBytes = initialRemaining - buf.remaining();<a name="line.623"></a> -<span class="sourceLineNo">624</span> return (nBytes > 0) ? nBytes : ret;<a name="line.624"></a> -<span class="sourceLineNo">625</span> }<a name="line.625"></a> -<span class="sourceLineNo">626</span><a name="line.626"></a> -<span class="sourceLineNo">627</span> /**<a name="line.627"></a> -<span class="sourceLineNo">628</span> * This is extracted to a static method for better unit testing. We try to get buffer(s) from pool<a name="line.628"></a> -<span class="sourceLineNo">629</span> * as much as possible.<a name="line.629"></a> -<span class="sourceLineNo">630</span> *<a name="line.630"></a> -<span class="sourceLineNo">631</span> * @param pool The ByteBufferPool to use<a name="line.631"></a> -<span class="sourceLineNo">632</span> * @param minSizeForPoolUse Only for buffer size above this, we will try to use pool. Any buffer<a name="line.632"></a> -<span class="sourceLineNo">633</span> * need of size below this, create on heap ByteBuffer.<a name="line.633"></a> -<span class="sourceLineNo">634</span> * @param reqLen Bytes count in request<a name="line.634"></a> -<span class="sourceLineNo">635</span> */<a name="line.635"></a> -<span class="sourceLineNo">636</span> @VisibleForTesting<a name="line.636"></a> -<span class="sourceLineNo">637</span> static Pair<ByteBuff, CallCleanup> allocateByteBuffToReadInto(ByteBufferPool pool,<a name="line.637"></a> -<span class="sourceLineNo">638</span> int minSizeForPoolUse, int reqLen) {<a name="line.638"></a> -<span class="sourceLineNo">639</span> ByteBuff resultBuf;<a name="line.639"></a> -<span class="sourceLineNo">640</span> List<ByteBuffer> bbs = new ArrayList<>((reqLen / pool.getBufferSize()) + 1);<a name="line.640"></a> -<span class="sourceLineNo">641</span> int remain = reqLen;<a name="line.641"></a> -<span class="sourceLineNo">642</span> ByteBuffer buf = null;<a name="line.642"></a> -<span class="sourceLineNo">643</span> while (remain >= minSizeForPoolUse && (buf = pool.getBuffer()) != null) {<a name="line.643"></a> -<span class="sourceLineNo">644</span> bbs.add(buf);<a name="line.644"></a> -<span class="sourceLineNo">645</span> remain -= pool.getBufferSize();<a name="line.645"></a> -<span class="sourceLineNo">646</span> }<a name="line.646"></a> -<span class="sourceLineNo">647</span> ByteBuffer[] bufsFromPool = null;<a name="line.647"></a> -<span class="sourceLineNo">648</span> if (bbs.size() > 0) {<a name="line.648"></a> -<span class="sourceLineNo">649</span> bufsFromPool = new ByteBuffer[bbs.size()];<a name="line.649"></a> -<span class="sourceLineNo">650</span> bbs.toArray(bufsFromPool);<a name="line.650"></a> +<span class="sourceLineNo">027</span>import java.nio.channels.ReadableByteChannel;<a name="line.27"></a> +<span class="sourceLineNo">028</span>import java.nio.channels.WritableByteChannel;<a name="line.28"></a> +<span class="sourceLineNo">029</span>import java.util.ArrayList;<a name="line.29"></a> +<span class="sourceLineNo">030</span>import java.util.Collections;<a name="line.30"></a> +<span class="sourceLineNo">031</span>import java.util.HashMap;<a name="line.31"></a> +<span class="sourceLineNo">032</span>import java.util.List;<a name="line.32"></a> +<span class="sourceLineNo">033</span>import java.util.Locale;<a name="line.33"></a> +<span class="sourceLineNo">034</span>import java.util.Map;<a name="line.34"></a> +<span class="sourceLineNo">035</span>import java.util.Optional;<a name="line.35"></a> +<span class="sourceLineNo">036</span>import java.util.concurrent.atomic.LongAdder;<a name="line.36"></a> +<span class="sourceLineNo">037</span><a name="line.37"></a> +<span class="sourceLineNo">038</span>import com.fasterxml.jackson.databind.ObjectMapper;<a name="line.38"></a> +<span class="sourceLineNo">039</span>import org.apache.commons.logging.Log;<a name="line.39"></a> +<span class="sourceLineNo">040</span>import org.apache.commons.logging.LogFactory;<a name="line.40"></a> +<span class="sourceLineNo">041</span>import org.apache.hadoop.conf.Configuration;<a name="line.41"></a> +<span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.CallQueueTooBigException;<a name="line.42"></a> +<span class="sourceLineNo">043</span>import org.apache.hadoop.hbase.CellScanner;<a name="line.43"></a> +<span class="sourceLineNo">044</span>import org.apache.hadoop.hbase.DoNotRetryIOException;<a name="line.44"></a> +<span class="sourceLineNo">045</span>import org.apache.hadoop.hbase.HBaseInterfaceAudience;<a name="line.45"></a> +<span class="sourceLineNo">046</span>import org.apache.hadoop.hbase.HConstants;<a name="line.46"></a> +<span class="sourceLineNo">047</span>import org.apache.hadoop.hbase.Server;<a name="line.47"></a> +<span class="sourceLineNo">048</span>import org.apache.hadoop.hbase.conf.ConfigurationObserver;<a name="line.48"></a> +<span class="sourceLineNo">049</span>import org.apache.hadoop.hbase.exceptions.RequestTooBigException;<a name="line.49"></a> +<span class="sourceLineNo">050</span>import org.apache.hadoop.hbase.io.ByteBufferPool;<a name="line.50"></a> +<span class="sourceLineNo">051</span>import org.apache.hadoop.hbase.monitoring.MonitoredRPCHandler;<a name="line.51"></a> +<span class="sourceLineNo">052</span>import org.apache.hadoop.hbase.monitoring.TaskMonitor;<a name="line.52"></a> +<span class="sourceLineNo">053</span>import org.apache.hadoop.hbase.nio.ByteBuff;<a name="line.53"></a> +<span class="sourceLineNo">054</span>import org.apache.hadoop.hbase.nio.MultiByteBuff;<a name="line.54"></a> +<span class="sourceLineNo">055</span>import org.apache.hadoop.hbase.nio.SingleByteBuff;<a name="line.55"></a> +<span class="sourceLineNo">056</span>import org.apache.hadoop.hbase.regionserver.RSRpcServices;<a name="line.56"></a> +<span class="sourceLineNo">057</span>import org.apache.hadoop.hbase.security.SaslUtil;<a name="line.57"></a> +<span class="sourceLineNo">058</span>import org.apache.hadoop.hbase.security.SaslUtil.QualityOfProtection;<a name="line.58"></a> +<span class="sourceLineNo">059</span>import org.apache.hadoop.hbase.security.User;<a name="line.59"></a> +<span class="sourceLineNo">060</span>import org.apache.hadoop.hbase.security.UserProvider;<a name="line.60"></a> +<span class="sourceLineNo">061</span>import org.apache.hadoop.hbase.security.token.AuthenticationTokenSecretManager;<a name="line.61"></a> +<span class="sourceLineNo">062</span>import org.apache.hadoop.hbase.util.Pair;<a name="line.62"></a> +<span class="sourceLineNo">063</span>import org.apache.hadoop.security.UserGroupInformation;<a name="line.63"></a> +<span class="sourceLineNo">064</span>import org.apache.hadoop.security.authorize.AuthorizationException;<a name="line.64"></a> +<span class="sourceLineNo">065</span>import org.apache.hadoop.security.authorize.PolicyProvider;<a name="line.65"></a> +<span class="sourceLineNo">066</span>import org.apache.hadoop.security.authorize.ServiceAuthorizationManager;<a name="line.66"></a> +<span class="sourceLineNo">067</span>import org.apache.hadoop.security.token.SecretManager;<a name="line.67"></a> +<span class="sourceLineNo">068</span>import org.apache.hadoop.security.token.TokenIdentifier;<a name="line.68"></a> +<span class="sourceLineNo">069</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.69"></a> +<span class="sourceLineNo">070</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.70"></a> +<span class="sourceLineNo">071</span><a name="line.71"></a> +<span class="sourceLineNo">072</span>import org.apache.hadoop.hbase.shaded.com.google.common.annotations.VisibleForTesting;<a name="line.72"></a> +<span class="sourceLineNo">073</span>import org.apache.hadoop.hbase.shaded.com.google.protobuf.BlockingService;<a name="line.73"></a> +<span class="sourceLineNo">074</span>import org.apache.hadoop.hbase.shaded.com.google.protobuf.Descriptors.MethodDescriptor;<a name="line.74"></a> +<span class="sourceLineNo">075</span>import org.apache.hadoop.hbase.shaded.com.google.protobuf.Message;<a name="line.75"></a> +<span class="sourceLineNo">076</span>import org.apache.hadoop.hbase.shaded.com.google.protobuf.ServiceException;<a name="line.76"></a> +<span class="sourceLineNo">077</span>import org.apache.hadoop.hbase.shaded.com.google.protobuf.TextFormat;<a name="line.77"></a> +<span class="sourceLineNo">078</span>import org.apache.hadoop.hbase.shaded.protobuf.ProtobufUtil;<a name="line.78"></a> +<span class="sourceLineNo">079</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos;<a name="line.79"></a> +<span class="sourceLineNo">080</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.ConnectionHeader;<a name="line.80"></a> +<span class="sourceLineNo">081</span><a name="line.81"></a> +<span class="sourceLineNo">082</span>/**<a name="line.82"></a> +<span class="sourceLineNo">083</span> * An RPC server that hosts protobuf described Services.<a name="line.83"></a> +<span class="sourceLineNo">084</span> *<a name="line.84"></a> +<span class="sourceLineNo">085</span> */<a name="line.85"></a> +<span class="sourceLineNo">086</span>@InterfaceAudience.LimitedPrivate({HBaseInterfaceAudience.COPROC, HBaseInterfaceAudience.PHOENIX})<a name="line.86"></a> +<span class="sourceLineNo">087</span>@InterfaceStability.Evolving<a name="line.87"></a> +<span class="sourceLineNo">088</span>public abstract class RpcServer implements RpcServerInterface,<a name="line.88"></a> +<span class="sourceLineNo">089</span> ConfigurationObserver {<a name="line.89"></a> +<span class="sourceLineNo">090</span> // LOG is being used in CallRunner and the log level is being changed in tests<a name="line.90"></a> +<span class="sourceLineNo">091</span> public static final Log LOG = LogFactory.getLog(RpcServer.class);<a name="line.91"></a> +<span class="sourceLineNo">092</span> protected static final CallQueueTooBigException CALL_QUEUE_TOO_BIG_EXCEPTION<a name="line.92"></a> +<span class="sourceLineNo">093</span> = new CallQueueTooBigException();<a name="line.93"></a> +<span class="sourceLineNo">094</span><a name="line.94"></a> +<span class="sourceLineNo">095</span> private final boolean authorize;<a name="line.95"></a> +<span class="sourceLineNo">096</span> protected boolean isSecurityEnabled;<a name="line.96"></a> +<span class="sourceLineNo">097</span><a name="line.97"></a> +<span class="sourceLineNo">098</span> public static final byte CURRENT_VERSION = 0;<a name="line.98"></a> +<span class="sourceLineNo">099</span><a name="line.99"></a> +<span class="sourceLineNo">100</span> /**<a name="line.100"></a> +<span class="sourceLineNo">101</span> * Whether we allow a fallback to SIMPLE auth for insecure clients when security is enabled.<a name="line.101"></a> +<span class="sourceLineNo">102</span> */<a name="line.102"></a> +<span class="sourceLineNo">103</span> public static final String FALLBACK_TO_INSECURE_CLIENT_AUTH =<a name="line.103"></a> +<span class="sourceLineNo">104</span> "hbase.ipc.server.fallback-to-simple-auth-allowed";<a name="line.104"></a> +<span class="sourceLineNo">105</span><a name="line.105"></a> +<span class="sourceLineNo">106</span> /**<a name="line.106"></a> +<span class="sourceLineNo">107</span> * How many calls/handler are allowed in the queue.<a name="line.107"></a> +<span class="sourceLineNo">108</span> */<a name="line.108"></a> +<span class="sourceLineNo">109</span> protected static final int DEFAULT_MAX_CALLQUEUE_LENGTH_PER_HANDLER = 10;<a name="line.109"></a> +<span class="sourceLineNo">110</span><a name="line.110"></a> +<span class="sourceLineNo">111</span> protected final CellBlockBuilder cellBlockBuilder;<a name="line.111"></a> +<span class="sourceLineNo">112</span><a name="line.112"></a> +<span class="sourceLineNo">113</span> protected static final String AUTH_FAILED_FOR = "Auth failed for ";<a name="line.113"></a> +<span class="sourceLineNo">114</span> protected static final String AUTH_SUCCESSFUL_FOR = "Auth successful for ";<a name="line.114"></a> +<span class="sourceLineNo">115</span> protected static final Log AUDITLOG = LogFactory.getLog("SecurityLogger."<a name="line.115"></a> +<span class="sourceLineNo">116</span> + Server.class.getName());<a name="line.116"></a> +<span class="sourceLineNo">117</span> protected SecretManager<TokenIdentifier> secretManager;<a name="line.117"></a> +<span class="sourceLineNo">118</span> protected final Map<String, String> saslProps;<a name="line.118"></a> +<span class="sourceLineNo">119</span> protected ServiceAuthorizationManager authManager;<a name="line.119"></a> +<span class="sourceLineNo">120</span><a name="line.120"></a> +<span class="sourceLineNo">121</span> /** This is set to Call object before Handler invokes an RPC and ybdie<a name="line.121"></a> +<span class="sourceLineNo">122</span> * after the call returns.<a name="line.122"></a> +<span class="sourceLineNo">123</span> */<a name="line.123"></a> +<span class="sourceLineNo">124</span> protected static final ThreadLocal<RpcCall> CurCall = new ThreadLocal<>();<a name="line.124"></a> +<span class="sourceLineNo">125</span><a name="line.125"></a> +<span class="sourceLineNo">126</span> /** Keeps MonitoredRPCHandler per handler thread. */<a name="line.126"></a> +<span class="sourceLineNo">127</span> protected static final ThreadLocal<MonitoredRPCHandler> MONITORED_RPC = new ThreadLocal<>();<a name="line.127"></a> +<span class="sourceLineNo">128</span><a name="line.128"></a> +<span class="sourceLineNo">129</span> protected final InetSocketAddress bindAddress;<a name="line.129"></a> +<span class="sourceLineNo">130</span><a name="line.130"></a> +<span class="sourceLineNo">131</span> protected MetricsHBaseServer metrics;<a name="line.131"></a> +<span class="sourceLineNo">132</span><a name="line.132"></a> +<span class="sourceLineNo">133</span> protected final Configuration conf;<a name="line.133"></a> +<span class="sourceLineNo">134</span><a name="line.134"></a> +<span class="sourceLineNo">135</span> /**<a name="line.135"></a> +<span class="sourceLineNo">136</span> * Maximum size in bytes of the currently queued and running Calls. If a new Call puts us over<a name="line.136"></a> +<span class="sourceLineNo">137</span> * this size, then we will reject the call (after parsing it though). It will go back to the<a name="line.137"></a> +<span class="sourceLineNo">138</span> * client and client will retry. Set this size with "hbase.ipc.server.max.callqueue.size". The<a name="line.138"></a> +<span class="sourceLineNo">139</span> * call queue size gets incremented after we parse a call and before we add it to the queue of<a name="line.139"></a> +<span class="sourceLineNo">140</span> * calls for the scheduler to use. It get decremented after we have 'run' the Call. The current<a name="line.140"></a> +<span class="sourceLineNo">141</span> * size is kept in {@link #callQueueSizeInBytes}.<a name="line.141"></a> +<span class="sourceLineNo">142</span> * @see #callQueueSizeInBytes<a name="line.142"></a> +<span class="sourceLineNo">143</span> * @see #DEFAULT_MAX_CALLQUEUE_SIZE<a name="line.143"></a> +<span class="sourceLineNo">144</span> */<a name="line.144"></a> +<span class="sourceLineNo">145</span> protected final long maxQueueSizeInBytes;<a name="line.145"></a> +<span class="sourceLineNo">146</span> protected static final int DEFAULT_MAX_CALLQUEUE_SIZE = 1024 * 1024 * 1024;<a name="line.146"></a> +<span class="sourceLineNo">147</span><a name="line.147"></a> +<span class="sourceLineNo">148</span> /**<a name="line.148"></a> +<span class="sourceLineNo">149</span> * This is a running count of the size in bytes of all outstanding calls whether currently<a name="line.149"></a> +<span class="sourceLineNo">150</span> * executing or queued waiting to be run.<a name="line.150"></a> +<span class="sourceLineNo">151</span> */<a name="line.151"></a> +<span class="sourceLineNo">152</span> protected final LongAdder callQueueSizeInBytes = new LongAdder();<a name="line.152"></a> +<span class="sourceLineNo">153</span><a name="line.153"></a> +<span class="sourceLineNo">154</span> protected final boolean tcpNoDelay; // if T then disable Nagle's Algorithm<a name="line.154"></a> +<span class="sourceLineNo">155</span> protected final boolean tcpKeepAlive; // if T then use keepalives<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> * This flag is used to indicate to sub threads when they should go down. When we call<a name="line.158"></a> +<span class="sourceLineNo">159</span> * {@link #start()}, all threads started will consult this flag on whether they should<a name="line.159"></a> +<span class="sourceLineNo">160</span> * keep going. It is set to false when {@link #stop()} is called.<a name="line.160"></a> +<span class="sourceLineNo">161</span> */<a name="line.161"></a> +<span class="sourceLineNo">162</span> volatile boolean running = true;<a name="line.162"></a> +<span class="sourceLineNo">163</span><a name="line.163"></a> +<span class="sourceLineNo">164</span> /**<a name="line.164"></a> +<span class="sourceLineNo">165</span> * This flag is set to true after all threads are up and 'running' and the server is then opened<a name="line.165"></a> +<span class="sourceLineNo">166</span> * for business by the call to {@link #start()}.<a name="line.166"></a> +<span class="sourceLineNo">167</span> */<a name="line.167"></a> +<span class="sourceLineNo">168</span> volatile boolean started = false;<a name="line.168"></a> +<span class="sourceLineNo">169</span><a name="line.169"></a> +<span class="sourceLineNo">170</span> protected AuthenticationTokenSecretManager authTokenSecretMgr = null;<a name="line.170"></a> +<span class="sourceLineNo">171</span><a name="line.171"></a> +<span class="sourceLineNo">172</span> protected HBaseRPCErrorHandler errorHandler = null;<a name="line.172"></a> +<span class="sourceLineNo">173</span><a name="line.173"></a> +<span class="sourceLineNo">174</span> public static final String MAX_REQUEST_SIZE = "hbase.ipc.max.request.size";<a name="line.174"></a> +<span class="sourceLineNo">175</span> protected static final RequestTooBigException REQUEST_TOO_BIG_EXCEPTION =<a name="line.175"></a> +<span class="sourceLineNo">176</span> new RequestTooBigException();<a name="line.176"></a> +<span class="sourceLineNo">177</span><a name="line.177"></a> +<span class="sourceLineNo">178</span> protected static final String WARN_RESPONSE_TIME = "hbase.ipc.warn.response.time";<a name="line.178"></a> +<span class="sourceLineNo">179</span> protected static final String WARN_RESPONSE_SIZE = "hbase.ipc.warn.response.size";<a name="line.179"></a> +<span class="sourceLineNo">180</span><a name="line.180"></a> +<span class="sourceLineNo">181</span> /**<a name="line.181"></a> +<span class="sourceLineNo">182</span> * Minimum allowable timeout (in milliseconds) in rpc request's header. This<a name="line.182"></a> +<span class="sourceLineNo">183</span> * configuration exists to prevent the rpc service regarding this request as timeout immediately.<a name="line.183"></a> +<span class="sourceLineNo">184</span> */<a name="line.184"></a> +<span class="sourceLineNo">185</span> protected static final String MIN_CLIENT_REQUEST_TIMEOUT = "hbase.ipc.min.client.request.timeout";<a name="line.185"></a> +<span class="sourceLineNo">186</span> protected static final int DEFAULT_MIN_CLIENT_REQUEST_TIMEOUT = 20;<a name="line.186"></a> +<span class="sourceLineNo">187</span><a name="line.187"></a> +<span class="sourceLineNo">188</span> /** Default value for above params */<a name="line.188"></a> +<span class="sourceLineNo">189</span> public static final int DEFAULT_MAX_REQUEST_SIZE = DEFAULT_MAX_CALLQUEUE_SIZE / 4; // 256M<a name="line.189"></a> +<span class="sourceLineNo">190</span> protected static final int DEFAULT_WARN_RESPONSE_TIME = 10000; // milliseconds<a name="line.190"></a> +<span class="sourceLineNo">191</span> protected static final int DEFAULT_WARN_RESPONSE_SIZE = 100 * 1024 * 1024;<a name="line.191"></a> +<span class="sourceLineNo">192</span><a name="line.192"></a> +<span class="sourceLineNo">193</span> protected static final ObjectMapper MAPPER = new ObjectMapper();<a name="line.193"></a> +<span class="sourceLineNo">194</span><a name="line.194"></a> +<span class="sourceLineNo">195</span> protected final int maxRequestSize;<a name="line.195"></a> +<span class="sourceLineNo">196</span> protected final int warnResponseTime;<a name="line.196"></a> +<span class="sourceLineNo">197</span> protected final int warnResponseSize;<a name="line.197"></a> +<span class="sourceLineNo">198</span><a name="line.198"></a> +<span class="sourceLineNo">199</span> protected final int minClientRequestTimeout;<a name="line.199"></a> +<span class="sourceLineNo">200</span><a name="line.200"></a> +<span class="sourceLineNo">201</span> protected final Server server;<a name="line.201"></a> +<span class="sourceLineNo">202</span> protected final List<BlockingServiceAndInterface> services;<a name="line.202"></a> +<span class="sourceLineNo">203</span><a name="line.203"></a> +<span class="sourceLineNo">204</span> protected final RpcScheduler scheduler;<a name="line.204"></a> +<span class="sourceLineNo">205</span><a name="line.205"></a> +<span class="sourceLineNo">206</span> protected UserProvider userProvider;<a name="line.206"></a> +<span class="sourceLineNo">207</span><a name="line.207"></a> +<span class="sourceLineNo">208</span> protected final ByteBufferPool reservoir;<a name="line.208"></a> +<span class="sourceLineNo">209</span> // The requests and response will use buffers from ByteBufferPool, when the size of the<a name="line.209"></a> +<span class="sourceLineNo">210</span> // request/response is at least this size.<a name="line.210"></a> +<span class="sourceLineNo">211</span> // We make this to be 1/6th of the pool buffer size.<a name="line.211"></a> +<span class="sourceLineNo">212</span> protected final int minSizeForReservoirUse;<a name="line.212"></a> +<span class="sourceLineNo">213</span><a name="line.213"></a> +<span class="sourceLineNo">214</span> protected volatile boolean allowFallbackToSimpleAuth;<a name="line.214"></a> +<span class="sourceLineNo">215</span><a name="line.215"></a> +<span class="sourceLineNo">216</span> /**<a name="line.216"></a> +<span class="sourceLineNo">217</span> * Used to get details for scan with a scanner_id<br/><a name="line.217"></a> +<span class="sourceLineNo">218</span> * TODO try to figure out a better way and remove reference from regionserver package later.<a name="line.218"></a> +<span class="sourceLineNo">219</span> */<a name="line.219"></a> +<span class="sourceLineNo">220</span> private RSRpcServices rsRpcServices;<a name="line.220"></a> +<span class="sourceLineNo">221</span><a name="line.221"></a> +<span class="sourceLineNo">222</span> @FunctionalInterface<a name="line.222"></a> +<span class="sourceLineNo">223</span> protected static interface CallCleanup {<a name="line.223"></a> +<span class="sourceLineNo">224</span> void run();<a name="line.224"></a> +<span class="sourceLineNo">225</span> }<a name="line.225"></a> +<span class="sourceLineNo">226</span><a name="line.226"></a> +<span class="sourceLineNo">227</span> /**<a name="line.227"></a> +<span class="sourceLineNo">228</span> * Datastructure for passing a {@link BlockingService} and its associated class of<a name="line.228"></a> +<span class="sourceLineNo">229</span> * protobuf service interface. For example, a server that fielded what is defined<a name="line.229"></a> +<span class="sourceLineNo">230</span> * in the client protobuf service would pass in an implementation of the client blocking service<a name="line.230"></a> +<span class="sourceLineNo">231</span> * and then its ClientService.BlockingInterface.class. Used checking connection setup.<a name="line.231"></a> +<span class="sourceLineNo">232</span> */<a name="line.232"></a> +<span class="sourceLineNo">233</span> public static class BlockingServiceAndInterface {<a name="line.233"></a> +<span class="sourceLineNo">234</span> private final BlockingService service;<a name="line.234"></a> +<span class="sourceLineNo">235</span> private final Class<?> serviceInterface;<a name="line.235"></a> +<span class="sourceLineNo">236</span> public BlockingServiceAndInterface(final BlockingService service,<a name="line.236"></a> +<span class="sourceLineNo">237</span> final Class<?> serviceInterface) {<a name="line.237"></a> +<span class="sourceLineNo">238</span> this.service = service;<a name="line.238"></a> +<span class="sourceLineNo">239</span> this.serviceInterface = serviceInterface;<a name="line.239"></a> +<span class="sourceLineNo">240</span> }<a name="line.240"></a> +<span class="sourceLineNo">241</span> public Class<?> getServiceInterface() {<a name="line.241"></a> +<span class="sourceLineNo">242</span> return this.serviceInterface;<a name="line.242"></a> +<span class="sourceLineNo">243</span> }<a name="line.243"></a> +<span class="sourceLineNo">244</span> public BlockingService getBlockingService() {<a name="line.244"></a> +<span class="sourceLineNo">245</span> return this.service;<a name="line.245"></a> +<span class="sourceLineNo">246</span> }<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> /**<a name="line.249"></a> +<span class="sourceLineNo">250</span> * Constructs a server listening on the named port and address.<a name="line.250"></a> +<span class="sourceLineNo">251</span> * @param server hosting instance of {@link Server}. W
<TRUNCATED>
