| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.hadoop.hbase.ipc, class: RpcServer, class: BlockingServiceAndInterface"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.ipc;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import static org.apache.hadoop.fs.CommonConfigurationKeysPublic.HADOOP_SECURITY_AUTHORIZATION;</span> |
| <span class="source-line-no">021</span><span id="line-21"></span> |
| <span class="source-line-no">022</span><span id="line-22">import com.google.errorprone.annotations.RestrictedApi;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.io.IOException;</span> |
| <span class="source-line-no">024</span><span id="line-24">import java.net.InetAddress;</span> |
| <span class="source-line-no">025</span><span id="line-25">import java.net.InetSocketAddress;</span> |
| <span class="source-line-no">026</span><span id="line-26">import java.nio.ByteBuffer;</span> |
| <span class="source-line-no">027</span><span id="line-27">import java.nio.channels.ReadableByteChannel;</span> |
| <span class="source-line-no">028</span><span id="line-28">import java.nio.channels.WritableByteChannel;</span> |
| <span class="source-line-no">029</span><span id="line-29">import java.util.Collections;</span> |
| <span class="source-line-no">030</span><span id="line-30">import java.util.HashMap;</span> |
| <span class="source-line-no">031</span><span id="line-31">import java.util.List;</span> |
| <span class="source-line-no">032</span><span id="line-32">import java.util.Locale;</span> |
| <span class="source-line-no">033</span><span id="line-33">import java.util.Map;</span> |
| <span class="source-line-no">034</span><span id="line-34">import java.util.Optional;</span> |
| <span class="source-line-no">035</span><span id="line-35">import java.util.concurrent.atomic.LongAdder;</span> |
| <span class="source-line-no">036</span><span id="line-36">import org.apache.commons.lang3.StringUtils;</span> |
| <span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.CallQueueTooBigException;</span> |
| <span class="source-line-no">039</span><span id="line-39">import org.apache.hadoop.hbase.CellScanner;</span> |
| <span class="source-line-no">040</span><span id="line-40">import org.apache.hadoop.hbase.DoNotRetryIOException;</span> |
| <span class="source-line-no">041</span><span id="line-41">import org.apache.hadoop.hbase.ExtendedCellScanner;</span> |
| <span class="source-line-no">042</span><span id="line-42">import org.apache.hadoop.hbase.HConstants;</span> |
| <span class="source-line-no">043</span><span id="line-43">import org.apache.hadoop.hbase.Server;</span> |
| <span class="source-line-no">044</span><span id="line-44">import org.apache.hadoop.hbase.conf.ConfigurationObserver;</span> |
| <span class="source-line-no">045</span><span id="line-45">import org.apache.hadoop.hbase.io.ByteBuffAllocator;</span> |
| <span class="source-line-no">046</span><span id="line-46">import org.apache.hadoop.hbase.monitoring.MonitoredRPCHandler;</span> |
| <span class="source-line-no">047</span><span id="line-47">import org.apache.hadoop.hbase.monitoring.TaskMonitor;</span> |
| <span class="source-line-no">048</span><span id="line-48">import org.apache.hadoop.hbase.namequeues.NamedQueueRecorder;</span> |
| <span class="source-line-no">049</span><span id="line-49">import org.apache.hadoop.hbase.namequeues.RpcLogDetails;</span> |
| <span class="source-line-no">050</span><span id="line-50">import org.apache.hadoop.hbase.regionserver.RSRpcServices;</span> |
| <span class="source-line-no">051</span><span id="line-51">import org.apache.hadoop.hbase.security.HBasePolicyProvider;</span> |
| <span class="source-line-no">052</span><span id="line-52">import org.apache.hadoop.hbase.security.SaslUtil;</span> |
| <span class="source-line-no">053</span><span id="line-53">import org.apache.hadoop.hbase.security.SaslUtil.QualityOfProtection;</span> |
| <span class="source-line-no">054</span><span id="line-54">import org.apache.hadoop.hbase.security.User;</span> |
| <span class="source-line-no">055</span><span id="line-55">import org.apache.hadoop.hbase.security.UserProvider;</span> |
| <span class="source-line-no">056</span><span id="line-56">import org.apache.hadoop.hbase.security.token.AuthenticationTokenSecretManager;</span> |
| <span class="source-line-no">057</span><span id="line-57">import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;</span> |
| <span class="source-line-no">058</span><span id="line-58">import org.apache.hadoop.hbase.util.GsonUtil;</span> |
| <span class="source-line-no">059</span><span id="line-59">import org.apache.hadoop.hbase.util.Pair;</span> |
| <span class="source-line-no">060</span><span id="line-60">import org.apache.hadoop.security.UserGroupInformation;</span> |
| <span class="source-line-no">061</span><span id="line-61">import org.apache.hadoop.security.authorize.AuthorizationException;</span> |
| <span class="source-line-no">062</span><span id="line-62">import org.apache.hadoop.security.authorize.PolicyProvider;</span> |
| <span class="source-line-no">063</span><span id="line-63">import org.apache.hadoop.security.authorize.ProxyUsers;</span> |
| <span class="source-line-no">064</span><span id="line-64">import org.apache.hadoop.security.authorize.ServiceAuthorizationManager;</span> |
| <span class="source-line-no">065</span><span id="line-65">import org.apache.hadoop.security.token.SecretManager;</span> |
| <span class="source-line-no">066</span><span id="line-66">import org.apache.hadoop.security.token.TokenIdentifier;</span> |
| <span class="source-line-no">067</span><span id="line-67">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">068</span><span id="line-68">import org.slf4j.Logger;</span> |
| <span class="source-line-no">069</span><span id="line-69">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">070</span><span id="line-70"></span> |
| <span class="source-line-no">071</span><span id="line-71">import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;</span> |
| <span class="source-line-no">072</span><span id="line-72">import org.apache.hbase.thirdparty.com.google.gson.Gson;</span> |
| <span class="source-line-no">073</span><span id="line-73">import org.apache.hbase.thirdparty.com.google.protobuf.BlockingService;</span> |
| <span class="source-line-no">074</span><span id="line-74">import org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor;</span> |
| <span class="source-line-no">075</span><span id="line-75">import org.apache.hbase.thirdparty.com.google.protobuf.Message;</span> |
| <span class="source-line-no">076</span><span id="line-76">import org.apache.hbase.thirdparty.com.google.protobuf.ServiceException;</span> |
| <span class="source-line-no">077</span><span id="line-77">import org.apache.hbase.thirdparty.com.google.protobuf.TextFormat;</span> |
| <span class="source-line-no">078</span><span id="line-78"></span> |
| <span class="source-line-no">079</span><span id="line-79">import org.apache.hadoop.hbase.shaded.protobuf.ProtobufUtil;</span> |
| <span class="source-line-no">080</span><span id="line-80">import org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos;</span> |
| <span class="source-line-no">081</span><span id="line-81">import org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.ConnectionHeader;</span> |
| <span class="source-line-no">082</span><span id="line-82"></span> |
| <span class="source-line-no">083</span><span id="line-83">/**</span> |
| <span class="source-line-no">084</span><span id="line-84"> * An RPC server that hosts protobuf described Services.</span> |
| <span class="source-line-no">085</span><span id="line-85"> */</span> |
| <span class="source-line-no">086</span><span id="line-86">@InterfaceAudience.Private</span> |
| <span class="source-line-no">087</span><span id="line-87">public abstract class RpcServer implements RpcServerInterface, ConfigurationObserver {</span> |
| <span class="source-line-no">088</span><span id="line-88"> // LOG is being used in CallRunner and the log level is being changed in tests</span> |
| <span class="source-line-no">089</span><span id="line-89"> public static final Logger LOG = LoggerFactory.getLogger(RpcServer.class);</span> |
| <span class="source-line-no">090</span><span id="line-90"> protected static final CallQueueTooBigException CALL_QUEUE_TOO_BIG_EXCEPTION =</span> |
| <span class="source-line-no">091</span><span id="line-91"> new CallQueueTooBigException();</span> |
| <span class="source-line-no">092</span><span id="line-92"></span> |
| <span class="source-line-no">093</span><span id="line-93"> private static final String MULTI_GETS = "multi.gets";</span> |
| <span class="source-line-no">094</span><span id="line-94"> private static final String MULTI_MUTATIONS = "multi.mutations";</span> |
| <span class="source-line-no">095</span><span id="line-95"> private static final String MULTI_SERVICE_CALLS = "multi.service_calls";</span> |
| <span class="source-line-no">096</span><span id="line-96"></span> |
| <span class="source-line-no">097</span><span id="line-97"> private final boolean authorize;</span> |
| <span class="source-line-no">098</span><span id="line-98"> private volatile boolean isOnlineLogProviderEnabled;</span> |
| <span class="source-line-no">099</span><span id="line-99"> protected boolean isSecurityEnabled;</span> |
| <span class="source-line-no">100</span><span id="line-100"></span> |
| <span class="source-line-no">101</span><span id="line-101"> public static final byte CURRENT_VERSION = 0;</span> |
| <span class="source-line-no">102</span><span id="line-102"></span> |
| <span class="source-line-no">103</span><span id="line-103"> /**</span> |
| <span class="source-line-no">104</span><span id="line-104"> * Whether we allow a fallback to SIMPLE auth for insecure clients when security is enabled.</span> |
| <span class="source-line-no">105</span><span id="line-105"> */</span> |
| <span class="source-line-no">106</span><span id="line-106"> public static final String FALLBACK_TO_INSECURE_CLIENT_AUTH =</span> |
| <span class="source-line-no">107</span><span id="line-107"> "hbase.ipc.server.fallback-to-simple-auth-allowed";</span> |
| <span class="source-line-no">108</span><span id="line-108"></span> |
| <span class="source-line-no">109</span><span id="line-109"> /**</span> |
| <span class="source-line-no">110</span><span id="line-110"> * How many calls/handler are allowed in the queue.</span> |
| <span class="source-line-no">111</span><span id="line-111"> */</span> |
| <span class="source-line-no">112</span><span id="line-112"> protected static final int DEFAULT_MAX_CALLQUEUE_LENGTH_PER_HANDLER = 10;</span> |
| <span class="source-line-no">113</span><span id="line-113"></span> |
| <span class="source-line-no">114</span><span id="line-114"> protected final CellBlockBuilder cellBlockBuilder;</span> |
| <span class="source-line-no">115</span><span id="line-115"></span> |
| <span class="source-line-no">116</span><span id="line-116"> protected static final String AUTH_FAILED_FOR = "Auth failed for ";</span> |
| <span class="source-line-no">117</span><span id="line-117"> protected static final String AUTH_SUCCESSFUL_FOR = "Auth successful for ";</span> |
| <span class="source-line-no">118</span><span id="line-118"> protected static final Logger AUDITLOG =</span> |
| <span class="source-line-no">119</span><span id="line-119"> LoggerFactory.getLogger("SecurityLogger." + Server.class.getName());</span> |
| <span class="source-line-no">120</span><span id="line-120"> protected SecretManager<TokenIdentifier> secretManager;</span> |
| <span class="source-line-no">121</span><span id="line-121"> protected final Map<String, String> saslProps;</span> |
| <span class="source-line-no">122</span><span id="line-122"> protected final String serverPrincipal;</span> |
| <span class="source-line-no">123</span><span id="line-123"></span> |
| <span class="source-line-no">124</span><span id="line-124"> protected ServiceAuthorizationManager authManager;</span> |
| <span class="source-line-no">125</span><span id="line-125"></span> |
| <span class="source-line-no">126</span><span id="line-126"> /**</span> |
| <span class="source-line-no">127</span><span id="line-127"> * This is set to Call object before Handler invokes an RPC and ybdie after the call returns.</span> |
| <span class="source-line-no">128</span><span id="line-128"> */</span> |
| <span class="source-line-no">129</span><span id="line-129"> protected static final ThreadLocal<RpcCall> CurCall = new ThreadLocal<>();</span> |
| <span class="source-line-no">130</span><span id="line-130"></span> |
| <span class="source-line-no">131</span><span id="line-131"> /** Keeps MonitoredRPCHandler per handler thread. */</span> |
| <span class="source-line-no">132</span><span id="line-132"> protected static final ThreadLocal<MonitoredRPCHandler> MONITORED_RPC = new ThreadLocal<>();</span> |
| <span class="source-line-no">133</span><span id="line-133"></span> |
| <span class="source-line-no">134</span><span id="line-134"> protected final InetSocketAddress bindAddress;</span> |
| <span class="source-line-no">135</span><span id="line-135"></span> |
| <span class="source-line-no">136</span><span id="line-136"> protected MetricsHBaseServer metrics;</span> |
| <span class="source-line-no">137</span><span id="line-137"></span> |
| <span class="source-line-no">138</span><span id="line-138"> protected final Configuration conf;</span> |
| <span class="source-line-no">139</span><span id="line-139"></span> |
| <span class="source-line-no">140</span><span id="line-140"> /**</span> |
| <span class="source-line-no">141</span><span id="line-141"> * Maximum size in bytes of the currently queued and running Calls. If a new Call puts us over</span> |
| <span class="source-line-no">142</span><span id="line-142"> * this size, then we will reject the call (after parsing it though). It will go back to the</span> |
| <span class="source-line-no">143</span><span id="line-143"> * client and client will retry. Set this size with "hbase.ipc.server.max.callqueue.size". The</span> |
| <span class="source-line-no">144</span><span id="line-144"> * call queue size gets incremented after we parse a call and before we add it to the queue of</span> |
| <span class="source-line-no">145</span><span id="line-145"> * calls for the scheduler to use. It get decremented after we have 'run' the Call. The current</span> |
| <span class="source-line-no">146</span><span id="line-146"> * size is kept in {@link #callQueueSizeInBytes}.</span> |
| <span class="source-line-no">147</span><span id="line-147"> * @see #callQueueSizeInBytes</span> |
| <span class="source-line-no">148</span><span id="line-148"> * @see #DEFAULT_MAX_CALLQUEUE_SIZE</span> |
| <span class="source-line-no">149</span><span id="line-149"> */</span> |
| <span class="source-line-no">150</span><span id="line-150"> protected final long maxQueueSizeInBytes;</span> |
| <span class="source-line-no">151</span><span id="line-151"> protected static final int DEFAULT_MAX_CALLQUEUE_SIZE = 1024 * 1024 * 1024;</span> |
| <span class="source-line-no">152</span><span id="line-152"></span> |
| <span class="source-line-no">153</span><span id="line-153"> /**</span> |
| <span class="source-line-no">154</span><span id="line-154"> * This is a running count of the size in bytes of all outstanding calls whether currently</span> |
| <span class="source-line-no">155</span><span id="line-155"> * executing or queued waiting to be run.</span> |
| <span class="source-line-no">156</span><span id="line-156"> */</span> |
| <span class="source-line-no">157</span><span id="line-157"> protected final LongAdder callQueueSizeInBytes = new LongAdder();</span> |
| <span class="source-line-no">158</span><span id="line-158"></span> |
| <span class="source-line-no">159</span><span id="line-159"> protected final boolean tcpNoDelay; // if T then disable Nagle's Algorithm</span> |
| <span class="source-line-no">160</span><span id="line-160"> protected final boolean tcpKeepAlive; // if T then use keepalives</span> |
| <span class="source-line-no">161</span><span id="line-161"></span> |
| <span class="source-line-no">162</span><span id="line-162"> /**</span> |
| <span class="source-line-no">163</span><span id="line-163"> * This flag is used to indicate to sub threads when they should go down. When we call</span> |
| <span class="source-line-no">164</span><span id="line-164"> * {@link #start()}, all threads started will consult this flag on whether they should keep going.</span> |
| <span class="source-line-no">165</span><span id="line-165"> * It is set to false when {@link #stop()} is called.</span> |
| <span class="source-line-no">166</span><span id="line-166"> */</span> |
| <span class="source-line-no">167</span><span id="line-167"> volatile boolean running = true;</span> |
| <span class="source-line-no">168</span><span id="line-168"></span> |
| <span class="source-line-no">169</span><span id="line-169"> /**</span> |
| <span class="source-line-no">170</span><span id="line-170"> * This flag is set to true after all threads are up and 'running' and the server is then opened</span> |
| <span class="source-line-no">171</span><span id="line-171"> * for business by the call to {@link #start()}.</span> |
| <span class="source-line-no">172</span><span id="line-172"> */</span> |
| <span class="source-line-no">173</span><span id="line-173"> volatile boolean started = false;</span> |
| <span class="source-line-no">174</span><span id="line-174"></span> |
| <span class="source-line-no">175</span><span id="line-175"> protected AuthenticationTokenSecretManager authTokenSecretMgr = null;</span> |
| <span class="source-line-no">176</span><span id="line-176"></span> |
| <span class="source-line-no">177</span><span id="line-177"> protected HBaseRPCErrorHandler errorHandler = null;</span> |
| <span class="source-line-no">178</span><span id="line-178"></span> |
| <span class="source-line-no">179</span><span id="line-179"> public static final String MAX_REQUEST_SIZE = "hbase.ipc.max.request.size";</span> |
| <span class="source-line-no">180</span><span id="line-180"></span> |
| <span class="source-line-no">181</span><span id="line-181"> protected static final String WARN_RESPONSE_TIME = "hbase.ipc.warn.response.time";</span> |
| <span class="source-line-no">182</span><span id="line-182"> protected static final String WARN_RESPONSE_SIZE = "hbase.ipc.warn.response.size";</span> |
| <span class="source-line-no">183</span><span id="line-183"> protected static final String WARN_SCAN_RESPONSE_TIME = "hbase.ipc.warn.response.time.scan";</span> |
| <span class="source-line-no">184</span><span id="line-184"> protected static final String WARN_SCAN_RESPONSE_SIZE = "hbase.ipc.warn.response.size.scan";</span> |
| <span class="source-line-no">185</span><span id="line-185"></span> |
| <span class="source-line-no">186</span><span id="line-186"> /**</span> |
| <span class="source-line-no">187</span><span id="line-187"> * Minimum allowable timeout (in milliseconds) in rpc request's header. This configuration exists</span> |
| <span class="source-line-no">188</span><span id="line-188"> * to prevent the rpc service regarding this request as timeout immediately.</span> |
| <span class="source-line-no">189</span><span id="line-189"> */</span> |
| <span class="source-line-no">190</span><span id="line-190"> protected static final String MIN_CLIENT_REQUEST_TIMEOUT = "hbase.ipc.min.client.request.timeout";</span> |
| <span class="source-line-no">191</span><span id="line-191"> protected static final int DEFAULT_MIN_CLIENT_REQUEST_TIMEOUT = 20;</span> |
| <span class="source-line-no">192</span><span id="line-192"></span> |
| <span class="source-line-no">193</span><span id="line-193"> /** Default value for above params */</span> |
| <span class="source-line-no">194</span><span id="line-194"> public static final int DEFAULT_MAX_REQUEST_SIZE = DEFAULT_MAX_CALLQUEUE_SIZE / 4; // 256M</span> |
| <span class="source-line-no">195</span><span id="line-195"> protected static final int DEFAULT_WARN_RESPONSE_TIME = 10000; // milliseconds</span> |
| <span class="source-line-no">196</span><span id="line-196"> protected static final int DEFAULT_WARN_RESPONSE_SIZE = 100 * 1024 * 1024;</span> |
| <span class="source-line-no">197</span><span id="line-197"></span> |
| <span class="source-line-no">198</span><span id="line-198"> protected static final int DEFAULT_TRACE_LOG_MAX_LENGTH = 1000;</span> |
| <span class="source-line-no">199</span><span id="line-199"> protected static final String TRACE_LOG_MAX_LENGTH = "hbase.ipc.trace.log.max.length";</span> |
| <span class="source-line-no">200</span><span id="line-200"> protected static final String KEY_WORD_TRUNCATED = " <TRUNCATED>";</span> |
| <span class="source-line-no">201</span><span id="line-201"></span> |
| <span class="source-line-no">202</span><span id="line-202"> protected static final Gson GSON = GsonUtil.createGsonWithDisableHtmlEscaping().create();</span> |
| <span class="source-line-no">203</span><span id="line-203"></span> |
| <span class="source-line-no">204</span><span id="line-204"> protected final int maxRequestSize;</span> |
| <span class="source-line-no">205</span><span id="line-205"> protected volatile int warnResponseTime;</span> |
| <span class="source-line-no">206</span><span id="line-206"> protected volatile int warnResponseSize;</span> |
| <span class="source-line-no">207</span><span id="line-207"> protected volatile int warnScanResponseTime;</span> |
| <span class="source-line-no">208</span><span id="line-208"> protected volatile int warnScanResponseSize;</span> |
| <span class="source-line-no">209</span><span id="line-209"></span> |
| <span class="source-line-no">210</span><span id="line-210"> protected final int minClientRequestTimeout;</span> |
| <span class="source-line-no">211</span><span id="line-211"></span> |
| <span class="source-line-no">212</span><span id="line-212"> protected final Server server;</span> |
| <span class="source-line-no">213</span><span id="line-213"> protected final List<BlockingServiceAndInterface> services;</span> |
| <span class="source-line-no">214</span><span id="line-214"></span> |
| <span class="source-line-no">215</span><span id="line-215"> protected final RpcScheduler scheduler;</span> |
| <span class="source-line-no">216</span><span id="line-216"></span> |
| <span class="source-line-no">217</span><span id="line-217"> protected final UserProvider userProvider;</span> |
| <span class="source-line-no">218</span><span id="line-218"></span> |
| <span class="source-line-no">219</span><span id="line-219"> protected final ByteBuffAllocator bbAllocator;</span> |
| <span class="source-line-no">220</span><span id="line-220"></span> |
| <span class="source-line-no">221</span><span id="line-221"> protected volatile boolean allowFallbackToSimpleAuth;</span> |
| <span class="source-line-no">222</span><span id="line-222"></span> |
| <span class="source-line-no">223</span><span id="line-223"> /**</span> |
| <span class="source-line-no">224</span><span id="line-224"> * Used to get details for scan with a scanner_id<br/></span> |
| <span class="source-line-no">225</span><span id="line-225"> * TODO try to figure out a better way and remove reference from regionserver package later.</span> |
| <span class="source-line-no">226</span><span id="line-226"> */</span> |
| <span class="source-line-no">227</span><span id="line-227"> private RSRpcServices rsRpcServices;</span> |
| <span class="source-line-no">228</span><span id="line-228"></span> |
| <span class="source-line-no">229</span><span id="line-229"> /**</span> |
| <span class="source-line-no">230</span><span id="line-230"> * Use to add online slowlog responses</span> |
| <span class="source-line-no">231</span><span id="line-231"> */</span> |
| <span class="source-line-no">232</span><span id="line-232"> private NamedQueueRecorder namedQueueRecorder;</span> |
| <span class="source-line-no">233</span><span id="line-233"></span> |
| <span class="source-line-no">234</span><span id="line-234"> @FunctionalInterface</span> |
| <span class="source-line-no">235</span><span id="line-235"> protected interface CallCleanup {</span> |
| <span class="source-line-no">236</span><span id="line-236"> void run();</span> |
| <span class="source-line-no">237</span><span id="line-237"> }</span> |
| <span class="source-line-no">238</span><span id="line-238"></span> |
| <span class="source-line-no">239</span><span id="line-239"> /**</span> |
| <span class="source-line-no">240</span><span id="line-240"> * Datastructure for passing a {@link BlockingService} and its associated class of protobuf</span> |
| <span class="source-line-no">241</span><span id="line-241"> * service interface. For example, a server that fielded what is defined in the client protobuf</span> |
| <span class="source-line-no">242</span><span id="line-242"> * service would pass in an implementation of the client blocking service and then its</span> |
| <span class="source-line-no">243</span><span id="line-243"> * ClientService.BlockingInterface.class. Used checking connection setup.</span> |
| <span class="source-line-no">244</span><span id="line-244"> */</span> |
| <span class="source-line-no">245</span><span id="line-245"> public static class BlockingServiceAndInterface {</span> |
| <span class="source-line-no">246</span><span id="line-246"> private final BlockingService service;</span> |
| <span class="source-line-no">247</span><span id="line-247"> private final Class<?> serviceInterface;</span> |
| <span class="source-line-no">248</span><span id="line-248"></span> |
| <span class="source-line-no">249</span><span id="line-249"> public BlockingServiceAndInterface(final BlockingService service,</span> |
| <span class="source-line-no">250</span><span id="line-250"> final Class<?> serviceInterface) {</span> |
| <span class="source-line-no">251</span><span id="line-251"> this.service = service;</span> |
| <span class="source-line-no">252</span><span id="line-252"> this.serviceInterface = serviceInterface;</span> |
| <span class="source-line-no">253</span><span id="line-253"> }</span> |
| <span class="source-line-no">254</span><span id="line-254"></span> |
| <span class="source-line-no">255</span><span id="line-255"> public Class<?> getServiceInterface() {</span> |
| <span class="source-line-no">256</span><span id="line-256"> return this.serviceInterface;</span> |
| <span class="source-line-no">257</span><span id="line-257"> }</span> |
| <span class="source-line-no">258</span><span id="line-258"></span> |
| <span class="source-line-no">259</span><span id="line-259"> public BlockingService getBlockingService() {</span> |
| <span class="source-line-no">260</span><span id="line-260"> return this.service;</span> |
| <span class="source-line-no">261</span><span id="line-261"> }</span> |
| <span class="source-line-no">262</span><span id="line-262"> }</span> |
| <span class="source-line-no">263</span><span id="line-263"></span> |
| <span class="source-line-no">264</span><span id="line-264"> /**</span> |
| <span class="source-line-no">265</span><span id="line-265"> * Constructs a server listening on the named port and address.</span> |
| <span class="source-line-no">266</span><span id="line-266"> * @param server hosting instance of {@link Server}. We will do authentications if an</span> |
| <span class="source-line-no">267</span><span id="line-267"> * instance else pass null for no authentication check.</span> |
| <span class="source-line-no">268</span><span id="line-268"> * @param name Used keying this rpc servers' metrics and for naming the Listener</span> |
| <span class="source-line-no">269</span><span id="line-269"> * thread.</span> |
| <span class="source-line-no">270</span><span id="line-270"> * @param services A list of services.</span> |
| <span class="source-line-no">271</span><span id="line-271"> * @param bindAddress Where to listen</span> |
| <span class="source-line-no">272</span><span id="line-272"> * @param reservoirEnabled Enable ByteBufferPool or not.</span> |
| <span class="source-line-no">273</span><span id="line-273"> */</span> |
| <span class="source-line-no">274</span><span id="line-274"> public RpcServer(final Server server, final String name,</span> |
| <span class="source-line-no">275</span><span id="line-275"> final List<BlockingServiceAndInterface> services, final InetSocketAddress bindAddress,</span> |
| <span class="source-line-no">276</span><span id="line-276"> Configuration conf, RpcScheduler scheduler, boolean reservoirEnabled) throws IOException {</span> |
| <span class="source-line-no">277</span><span id="line-277"> this.bbAllocator = ByteBuffAllocator.create(conf, reservoirEnabled);</span> |
| <span class="source-line-no">278</span><span id="line-278"> this.server = server;</span> |
| <span class="source-line-no">279</span><span id="line-279"> this.services = services;</span> |
| <span class="source-line-no">280</span><span id="line-280"> this.bindAddress = bindAddress;</span> |
| <span class="source-line-no">281</span><span id="line-281"> this.conf = conf;</span> |
| <span class="source-line-no">282</span><span id="line-282"> // See declaration above for documentation on what this size is.</span> |
| <span class="source-line-no">283</span><span id="line-283"> this.maxQueueSizeInBytes =</span> |
| <span class="source-line-no">284</span><span id="line-284"> this.conf.getLong("hbase.ipc.server.max.callqueue.size", DEFAULT_MAX_CALLQUEUE_SIZE);</span> |
| <span class="source-line-no">285</span><span id="line-285"></span> |
| <span class="source-line-no">286</span><span id="line-286"> this.warnResponseTime = getWarnResponseTime(conf);</span> |
| <span class="source-line-no">287</span><span id="line-287"> this.warnResponseSize = getWarnResponseSize(conf);</span> |
| <span class="source-line-no">288</span><span id="line-288"> this.warnScanResponseTime = getWarnScanResponseTime(conf);</span> |
| <span class="source-line-no">289</span><span id="line-289"> this.warnScanResponseSize = getWarnScanResponseSize(conf);</span> |
| <span class="source-line-no">290</span><span id="line-290"> this.minClientRequestTimeout =</span> |
| <span class="source-line-no">291</span><span id="line-291"> conf.getInt(MIN_CLIENT_REQUEST_TIMEOUT, DEFAULT_MIN_CLIENT_REQUEST_TIMEOUT);</span> |
| <span class="source-line-no">292</span><span id="line-292"> this.maxRequestSize = conf.getInt(MAX_REQUEST_SIZE, DEFAULT_MAX_REQUEST_SIZE);</span> |
| <span class="source-line-no">293</span><span id="line-293"></span> |
| <span class="source-line-no">294</span><span id="line-294"> this.metrics = new MetricsHBaseServer(name, new MetricsHBaseServerWrapperImpl(this));</span> |
| <span class="source-line-no">295</span><span id="line-295"> this.tcpNoDelay = conf.getBoolean("hbase.ipc.server.tcpnodelay", true);</span> |
| <span class="source-line-no">296</span><span id="line-296"> this.tcpKeepAlive = conf.getBoolean("hbase.ipc.server.tcpkeepalive", true);</span> |
| <span class="source-line-no">297</span><span id="line-297"></span> |
| <span class="source-line-no">298</span><span id="line-298"> this.cellBlockBuilder = new CellBlockBuilder(conf);</span> |
| <span class="source-line-no">299</span><span id="line-299"></span> |
| <span class="source-line-no">300</span><span id="line-300"> this.authorize = conf.getBoolean(HADOOP_SECURITY_AUTHORIZATION, false);</span> |
| <span class="source-line-no">301</span><span id="line-301"> this.userProvider = UserProvider.instantiate(conf);</span> |
| <span class="source-line-no">302</span><span id="line-302"> this.isSecurityEnabled = userProvider.isHBaseSecurityEnabled();</span> |
| <span class="source-line-no">303</span><span id="line-303"> if (isSecurityEnabled) {</span> |
| <span class="source-line-no">304</span><span id="line-304"> saslProps = SaslUtil.initSaslProperties(conf.get("hbase.rpc.protection",</span> |
| <span class="source-line-no">305</span><span id="line-305"> QualityOfProtection.AUTHENTICATION.name().toLowerCase(Locale.ROOT)));</span> |
| <span class="source-line-no">306</span><span id="line-306"> serverPrincipal = Preconditions.checkNotNull(userProvider.getCurrentUserName(),</span> |
| <span class="source-line-no">307</span><span id="line-307"> "can not get current user name when security is enabled");</span> |
| <span class="source-line-no">308</span><span id="line-308"> } else {</span> |
| <span class="source-line-no">309</span><span id="line-309"> saslProps = Collections.emptyMap();</span> |
| <span class="source-line-no">310</span><span id="line-310"> serverPrincipal = HConstants.EMPTY_STRING;</span> |
| <span class="source-line-no">311</span><span id="line-311"> }</span> |
| <span class="source-line-no">312</span><span id="line-312"></span> |
| <span class="source-line-no">313</span><span id="line-313"> this.isOnlineLogProviderEnabled = getIsOnlineLogProviderEnabled(conf);</span> |
| <span class="source-line-no">314</span><span id="line-314"> this.scheduler = scheduler;</span> |
| <span class="source-line-no">315</span><span id="line-315"> }</span> |
| <span class="source-line-no">316</span><span id="line-316"></span> |
| <span class="source-line-no">317</span><span id="line-317"> @Override</span> |
| <span class="source-line-no">318</span><span id="line-318"> public void onConfigurationChange(Configuration newConf) {</span> |
| <span class="source-line-no">319</span><span id="line-319"> initReconfigurable(newConf);</span> |
| <span class="source-line-no">320</span><span id="line-320"> if (scheduler instanceof ConfigurationObserver) {</span> |
| <span class="source-line-no">321</span><span id="line-321"> ((ConfigurationObserver) scheduler).onConfigurationChange(newConf);</span> |
| <span class="source-line-no">322</span><span id="line-322"> }</span> |
| <span class="source-line-no">323</span><span id="line-323"> if (authorize) {</span> |
| <span class="source-line-no">324</span><span id="line-324"> refreshAuthManager(newConf, new HBasePolicyProvider());</span> |
| <span class="source-line-no">325</span><span id="line-325"> }</span> |
| <span class="source-line-no">326</span><span id="line-326"> refreshSlowLogConfiguration(newConf);</span> |
| <span class="source-line-no">327</span><span id="line-327"> }</span> |
| <span class="source-line-no">328</span><span id="line-328"></span> |
| <span class="source-line-no">329</span><span id="line-329"> private void refreshSlowLogConfiguration(Configuration newConf) {</span> |
| <span class="source-line-no">330</span><span id="line-330"> boolean newIsOnlineLogProviderEnabled = getIsOnlineLogProviderEnabled(newConf);</span> |
| <span class="source-line-no">331</span><span id="line-331"> if (isOnlineLogProviderEnabled != newIsOnlineLogProviderEnabled) {</span> |
| <span class="source-line-no">332</span><span id="line-332"> isOnlineLogProviderEnabled = newIsOnlineLogProviderEnabled;</span> |
| <span class="source-line-no">333</span><span id="line-333"> }</span> |
| <span class="source-line-no">334</span><span id="line-334"> int newWarnResponseTime = getWarnResponseTime(newConf);</span> |
| <span class="source-line-no">335</span><span id="line-335"> if (warnResponseTime != newWarnResponseTime) {</span> |
| <span class="source-line-no">336</span><span id="line-336"> warnResponseTime = newWarnResponseTime;</span> |
| <span class="source-line-no">337</span><span id="line-337"> }</span> |
| <span class="source-line-no">338</span><span id="line-338"> int newWarnResponseSize = getWarnResponseSize(newConf);</span> |
| <span class="source-line-no">339</span><span id="line-339"> if (warnResponseSize != newWarnResponseSize) {</span> |
| <span class="source-line-no">340</span><span id="line-340"> warnResponseSize = newWarnResponseSize;</span> |
| <span class="source-line-no">341</span><span id="line-341"> }</span> |
| <span class="source-line-no">342</span><span id="line-342"> int newWarnResponseTimeScan = getWarnScanResponseTime(newConf);</span> |
| <span class="source-line-no">343</span><span id="line-343"> if (warnScanResponseTime != newWarnResponseTimeScan) {</span> |
| <span class="source-line-no">344</span><span id="line-344"> warnScanResponseTime = newWarnResponseTimeScan;</span> |
| <span class="source-line-no">345</span><span id="line-345"> }</span> |
| <span class="source-line-no">346</span><span id="line-346"> int newWarnScanResponseSize = getWarnScanResponseSize(newConf);</span> |
| <span class="source-line-no">347</span><span id="line-347"> if (warnScanResponseSize != newWarnScanResponseSize) {</span> |
| <span class="source-line-no">348</span><span id="line-348"> warnScanResponseSize = newWarnScanResponseSize;</span> |
| <span class="source-line-no">349</span><span id="line-349"> }</span> |
| <span class="source-line-no">350</span><span id="line-350"> }</span> |
| <span class="source-line-no">351</span><span id="line-351"></span> |
| <span class="source-line-no">352</span><span id="line-352"> private static boolean getIsOnlineLogProviderEnabled(Configuration conf) {</span> |
| <span class="source-line-no">353</span><span id="line-353"> return conf.getBoolean(HConstants.SLOW_LOG_BUFFER_ENABLED_KEY,</span> |
| <span class="source-line-no">354</span><span id="line-354"> HConstants.DEFAULT_ONLINE_LOG_PROVIDER_ENABLED);</span> |
| <span class="source-line-no">355</span><span id="line-355"> }</span> |
| <span class="source-line-no">356</span><span id="line-356"></span> |
| <span class="source-line-no">357</span><span id="line-357"> private static int getWarnResponseTime(Configuration conf) {</span> |
| <span class="source-line-no">358</span><span id="line-358"> return conf.getInt(WARN_RESPONSE_TIME, DEFAULT_WARN_RESPONSE_TIME);</span> |
| <span class="source-line-no">359</span><span id="line-359"> }</span> |
| <span class="source-line-no">360</span><span id="line-360"></span> |
| <span class="source-line-no">361</span><span id="line-361"> private static int getWarnResponseSize(Configuration conf) {</span> |
| <span class="source-line-no">362</span><span id="line-362"> return conf.getInt(WARN_RESPONSE_SIZE, DEFAULT_WARN_RESPONSE_SIZE);</span> |
| <span class="source-line-no">363</span><span id="line-363"> }</span> |
| <span class="source-line-no">364</span><span id="line-364"></span> |
| <span class="source-line-no">365</span><span id="line-365"> private static int getWarnScanResponseTime(Configuration conf) {</span> |
| <span class="source-line-no">366</span><span id="line-366"> return conf.getInt(WARN_SCAN_RESPONSE_TIME, getWarnResponseTime(conf));</span> |
| <span class="source-line-no">367</span><span id="line-367"> }</span> |
| <span class="source-line-no">368</span><span id="line-368"></span> |
| <span class="source-line-no">369</span><span id="line-369"> private static int getWarnScanResponseSize(Configuration conf) {</span> |
| <span class="source-line-no">370</span><span id="line-370"> return conf.getInt(WARN_SCAN_RESPONSE_SIZE, getWarnResponseSize(conf));</span> |
| <span class="source-line-no">371</span><span id="line-371"> }</span> |
| <span class="source-line-no">372</span><span id="line-372"></span> |
| <span class="source-line-no">373</span><span id="line-373"> protected void initReconfigurable(Configuration confToLoad) {</span> |
| <span class="source-line-no">374</span><span id="line-374"> this.allowFallbackToSimpleAuth = confToLoad.getBoolean(FALLBACK_TO_INSECURE_CLIENT_AUTH, false);</span> |
| <span class="source-line-no">375</span><span id="line-375"> if (isSecurityEnabled && allowFallbackToSimpleAuth) {</span> |
| <span class="source-line-no">376</span><span id="line-376"> LOG.warn("********* WARNING! *********");</span> |
| <span class="source-line-no">377</span><span id="line-377"> LOG.warn("This server is configured to allow connections from INSECURE clients");</span> |
| <span class="source-line-no">378</span><span id="line-378"> LOG.warn("(" + FALLBACK_TO_INSECURE_CLIENT_AUTH + " = true).");</span> |
| <span class="source-line-no">379</span><span id="line-379"> LOG.warn("While this option is enabled, client identities cannot be secured, and user");</span> |
| <span class="source-line-no">380</span><span id="line-380"> LOG.warn("impersonation is possible!");</span> |
| <span class="source-line-no">381</span><span id="line-381"> LOG.warn("For secure operation, please disable SIMPLE authentication as soon as possible,");</span> |
| <span class="source-line-no">382</span><span id="line-382"> LOG.warn("by setting " + FALLBACK_TO_INSECURE_CLIENT_AUTH + " = false in hbase-site.xml");</span> |
| <span class="source-line-no">383</span><span id="line-383"> LOG.warn("****************************");</span> |
| <span class="source-line-no">384</span><span id="line-384"> }</span> |
| <span class="source-line-no">385</span><span id="line-385"> }</span> |
| <span class="source-line-no">386</span><span id="line-386"></span> |
| <span class="source-line-no">387</span><span id="line-387"> Configuration getConf() {</span> |
| <span class="source-line-no">388</span><span id="line-388"> return conf;</span> |
| <span class="source-line-no">389</span><span id="line-389"> }</span> |
| <span class="source-line-no">390</span><span id="line-390"></span> |
| <span class="source-line-no">391</span><span id="line-391"> @Override</span> |
| <span class="source-line-no">392</span><span id="line-392"> public boolean isStarted() {</span> |
| <span class="source-line-no">393</span><span id="line-393"> return this.started;</span> |
| <span class="source-line-no">394</span><span id="line-394"> }</span> |
| <span class="source-line-no">395</span><span id="line-395"></span> |
| <span class="source-line-no">396</span><span id="line-396"> @Override</span> |
| <span class="source-line-no">397</span><span id="line-397"> public synchronized void refreshAuthManager(Configuration conf, PolicyProvider pp) {</span> |
| <span class="source-line-no">398</span><span id="line-398"> // Ignore warnings that this should be accessed in a static way instead of via an instance;</span> |
| <span class="source-line-no">399</span><span id="line-399"> // it'll break if you go via static route.</span> |
| <span class="source-line-no">400</span><span id="line-400"> System.setProperty("hadoop.policy.file", "hbase-policy.xml");</span> |
| <span class="source-line-no">401</span><span id="line-401"> this.authManager.refresh(conf, pp);</span> |
| <span class="source-line-no">402</span><span id="line-402"> LOG.info("Refreshed hbase-policy.xml successfully");</span> |
| <span class="source-line-no">403</span><span id="line-403"> ProxyUsers.refreshSuperUserGroupsConfiguration(conf);</span> |
| <span class="source-line-no">404</span><span id="line-404"> LOG.info("Refreshed super and proxy users successfully");</span> |
| <span class="source-line-no">405</span><span id="line-405"> }</span> |
| <span class="source-line-no">406</span><span id="line-406"></span> |
| <span class="source-line-no">407</span><span id="line-407"> protected AuthenticationTokenSecretManager createSecretManager() {</span> |
| <span class="source-line-no">408</span><span id="line-408"> if (!isSecurityEnabled) return null;</span> |
| <span class="source-line-no">409</span><span id="line-409"> if (server == null) return null;</span> |
| <span class="source-line-no">410</span><span id="line-410"> Configuration conf = server.getConfiguration();</span> |
| <span class="source-line-no">411</span><span id="line-411"> long keyUpdateInterval = conf.getLong("hbase.auth.key.update.interval", 24 * 60 * 60 * 1000);</span> |
| <span class="source-line-no">412</span><span id="line-412"> long maxAge = conf.getLong("hbase.auth.token.max.lifetime", 7 * 24 * 60 * 60 * 1000);</span> |
| <span class="source-line-no">413</span><span id="line-413"> return new AuthenticationTokenSecretManager(conf, server.getZooKeeper(),</span> |
| <span class="source-line-no">414</span><span id="line-414"> server.getServerName().toString(), keyUpdateInterval, maxAge);</span> |
| <span class="source-line-no">415</span><span id="line-415"> }</span> |
| <span class="source-line-no">416</span><span id="line-416"></span> |
| <span class="source-line-no">417</span><span id="line-417"> public SecretManager<? extends TokenIdentifier> getSecretManager() {</span> |
| <span class="source-line-no">418</span><span id="line-418"> return this.secretManager;</span> |
| <span class="source-line-no">419</span><span id="line-419"> }</span> |
| <span class="source-line-no">420</span><span id="line-420"></span> |
| <span class="source-line-no">421</span><span id="line-421"> @SuppressWarnings("unchecked")</span> |
| <span class="source-line-no">422</span><span id="line-422"> public void setSecretManager(SecretManager<? extends TokenIdentifier> secretManager) {</span> |
| <span class="source-line-no">423</span><span id="line-423"> this.secretManager = (SecretManager<TokenIdentifier>) secretManager;</span> |
| <span class="source-line-no">424</span><span id="line-424"> }</span> |
| <span class="source-line-no">425</span><span id="line-425"></span> |
| <span class="source-line-no">426</span><span id="line-426"> /**</span> |
| <span class="source-line-no">427</span><span id="line-427"> * This is a server side method, which is invoked over RPC. On success the return response has</span> |
| <span class="source-line-no">428</span><span id="line-428"> * protobuf response payload. On failure, the exception name and the stack trace are returned in</span> |
| <span class="source-line-no">429</span><span id="line-429"> * the protobuf response.</span> |
| <span class="source-line-no">430</span><span id="line-430"> */</span> |
| <span class="source-line-no">431</span><span id="line-431"> @Override</span> |
| <span class="source-line-no">432</span><span id="line-432"> public Pair<Message, ExtendedCellScanner> call(RpcCall call, MonitoredRPCHandler status)</span> |
| <span class="source-line-no">433</span><span id="line-433"> throws IOException {</span> |
| <span class="source-line-no">434</span><span id="line-434"> try {</span> |
| <span class="source-line-no">435</span><span id="line-435"> MethodDescriptor md = call.getMethod();</span> |
| <span class="source-line-no">436</span><span id="line-436"> Message param = call.getParam();</span> |
| <span class="source-line-no">437</span><span id="line-437"> status.setRPC(md.getName(), new Object[] { param }, call.getReceiveTime());</span> |
| <span class="source-line-no">438</span><span id="line-438"> // TODO: Review after we add in encoded data blocks.</span> |
| <span class="source-line-no">439</span><span id="line-439"> status.setRPCPacket(param);</span> |
| <span class="source-line-no">440</span><span id="line-440"> status.resume("Servicing call");</span> |
| <span class="source-line-no">441</span><span id="line-441"> // get an instance of the method arg type</span> |
| <span class="source-line-no">442</span><span id="line-442"> HBaseRpcController controller = new HBaseRpcControllerImpl(call.getCellScanner());</span> |
| <span class="source-line-no">443</span><span id="line-443"> controller.setCallTimeout(call.getTimeout());</span> |
| <span class="source-line-no">444</span><span id="line-444"> Message result = call.getService().callBlockingMethod(md, controller, param);</span> |
| <span class="source-line-no">445</span><span id="line-445"> long receiveTime = call.getReceiveTime();</span> |
| <span class="source-line-no">446</span><span id="line-446"> long startTime = call.getStartTime();</span> |
| <span class="source-line-no">447</span><span id="line-447"> long endTime = EnvironmentEdgeManager.currentTime();</span> |
| <span class="source-line-no">448</span><span id="line-448"> int processingTime = (int) (endTime - startTime);</span> |
| <span class="source-line-no">449</span><span id="line-449"> int qTime = (int) (startTime - receiveTime);</span> |
| <span class="source-line-no">450</span><span id="line-450"> int totalTime = (int) (endTime - receiveTime);</span> |
| <span class="source-line-no">451</span><span id="line-451"> if (LOG.isTraceEnabled()) {</span> |
| <span class="source-line-no">452</span><span id="line-452"> LOG.trace(</span> |
| <span class="source-line-no">453</span><span id="line-453"> "{}, response: {}, receiveTime: {}, queueTime: {}, processingTime: {}, "</span> |
| <span class="source-line-no">454</span><span id="line-454"> + "totalTime: {}, fsReadTime: {}",</span> |
| <span class="source-line-no">455</span><span id="line-455"> CurCall.get().toString(), TextFormat.shortDebugString(result),</span> |
| <span class="source-line-no">456</span><span id="line-456"> CurCall.get().getReceiveTime(), qTime, processingTime, totalTime,</span> |
| <span class="source-line-no">457</span><span id="line-457"> CurCall.get().getFsReadTime());</span> |
| <span class="source-line-no">458</span><span id="line-458"> }</span> |
| <span class="source-line-no">459</span><span id="line-459"> // Use the raw request call size for now.</span> |
| <span class="source-line-no">460</span><span id="line-460"> long requestSize = call.getSize();</span> |
| <span class="source-line-no">461</span><span id="line-461"> long responseSize = result.getSerializedSize();</span> |
| <span class="source-line-no">462</span><span id="line-462"> long responseBlockSize = call.getBlockBytesScanned();</span> |
| <span class="source-line-no">463</span><span id="line-463"> long fsReadTime = call.getFsReadTime();</span> |
| <span class="source-line-no">464</span><span id="line-464"> if (call.isClientCellBlockSupported()) {</span> |
| <span class="source-line-no">465</span><span id="line-465"> // Include the payload size in HBaseRpcController</span> |
| <span class="source-line-no">466</span><span id="line-466"> responseSize += call.getResponseCellSize();</span> |
| <span class="source-line-no">467</span><span id="line-467"> }</span> |
| <span class="source-line-no">468</span><span id="line-468"></span> |
| <span class="source-line-no">469</span><span id="line-469"> metrics.dequeuedCall(qTime);</span> |
| <span class="source-line-no">470</span><span id="line-470"> metrics.processedCall(processingTime);</span> |
| <span class="source-line-no">471</span><span id="line-471"> metrics.totalCall(totalTime);</span> |
| <span class="source-line-no">472</span><span id="line-472"> metrics.receivedRequest(requestSize);</span> |
| <span class="source-line-no">473</span><span id="line-473"> metrics.sentResponse(responseSize);</span> |
| <span class="source-line-no">474</span><span id="line-474"> // log any RPC responses that are slower than the configured warn</span> |
| <span class="source-line-no">475</span><span id="line-475"> // response time or larger than configured warning size</span> |
| <span class="source-line-no">476</span><span id="line-476"> boolean tooSlow = isTooSlow(call, processingTime);</span> |
| <span class="source-line-no">477</span><span id="line-477"> boolean tooLarge = isTooLarge(call, responseSize, responseBlockSize);</span> |
| <span class="source-line-no">478</span><span id="line-478"> if (tooSlow || tooLarge) {</span> |
| <span class="source-line-no">479</span><span id="line-479"> final String userName = call.getRequestUserName().orElse(StringUtils.EMPTY);</span> |
| <span class="source-line-no">480</span><span id="line-480"> // when tagging, we let TooLarge trump TooSmall to keep output simple</span> |
| <span class="source-line-no">481</span><span id="line-481"> // note that large responses will often also be slow.</span> |
| <span class="source-line-no">482</span><span id="line-482"> logResponse(param, md.getName(), md.getName() + "(" + param.getClass().getName() + ")",</span> |
| <span class="source-line-no">483</span><span id="line-483"> tooLarge, tooSlow, status.getClient(), startTime, processingTime, qTime, responseSize,</span> |
| <span class="source-line-no">484</span><span id="line-484"> responseBlockSize, fsReadTime, userName);</span> |
| <span class="source-line-no">485</span><span id="line-485"> if (this.namedQueueRecorder != null && this.isOnlineLogProviderEnabled) {</span> |
| <span class="source-line-no">486</span><span id="line-486"> // send logs to ring buffer owned by slowLogRecorder</span> |
| <span class="source-line-no">487</span><span id="line-487"> final String className =</span> |
| <span class="source-line-no">488</span><span id="line-488"> server == null ? StringUtils.EMPTY : server.getClass().getSimpleName();</span> |
| <span class="source-line-no">489</span><span id="line-489"> this.namedQueueRecorder.addRecord(new RpcLogDetails(call, param, status.getClient(),</span> |
| <span class="source-line-no">490</span><span id="line-490"> responseSize, responseBlockSize, fsReadTime, className, tooSlow, tooLarge));</span> |
| <span class="source-line-no">491</span><span id="line-491"> }</span> |
| <span class="source-line-no">492</span><span id="line-492"> }</span> |
| <span class="source-line-no">493</span><span id="line-493"> return new Pair<>(result, controller.cellScanner());</span> |
| <span class="source-line-no">494</span><span id="line-494"> } catch (Throwable e) {</span> |
| <span class="source-line-no">495</span><span id="line-495"> // The above callBlockingMethod will always return a SE. Strip the SE wrapper before</span> |
| <span class="source-line-no">496</span><span id="line-496"> // putting it on the wire. Its needed to adhere to the pb Service Interface but we don't</span> |
| <span class="source-line-no">497</span><span id="line-497"> // need to pass it over the wire.</span> |
| <span class="source-line-no">498</span><span id="line-498"> if (e instanceof ServiceException) {</span> |
| <span class="source-line-no">499</span><span id="line-499"> if (e.getCause() == null) {</span> |
| <span class="source-line-no">500</span><span id="line-500"> LOG.debug("Caught a ServiceException with null cause", e);</span> |
| <span class="source-line-no">501</span><span id="line-501"> } else {</span> |
| <span class="source-line-no">502</span><span id="line-502"> e = e.getCause();</span> |
| <span class="source-line-no">503</span><span id="line-503"> }</span> |
| <span class="source-line-no">504</span><span id="line-504"> }</span> |
| <span class="source-line-no">505</span><span id="line-505"></span> |
| <span class="source-line-no">506</span><span id="line-506"> // increment the number of requests that were exceptions.</span> |
| <span class="source-line-no">507</span><span id="line-507"> metrics.exception(e);</span> |
| <span class="source-line-no">508</span><span id="line-508"></span> |
| <span class="source-line-no">509</span><span id="line-509"> if (e instanceof LinkageError) throw new DoNotRetryIOException(e);</span> |
| <span class="source-line-no">510</span><span id="line-510"> if (e instanceof IOException) throw (IOException) e;</span> |
| <span class="source-line-no">511</span><span id="line-511"> LOG.error("Unexpected throwable object ", e);</span> |
| <span class="source-line-no">512</span><span id="line-512"> throw new IOException(e.getMessage(), e);</span> |
| <span class="source-line-no">513</span><span id="line-513"> }</span> |
| <span class="source-line-no">514</span><span id="line-514"> }</span> |
| <span class="source-line-no">515</span><span id="line-515"></span> |
| <span class="source-line-no">516</span><span id="line-516"> /**</span> |
| <span class="source-line-no">517</span><span id="line-517"> * Logs an RPC response to the LOG file, producing valid JSON objects for client Operations.</span> |
| <span class="source-line-no">518</span><span id="line-518"> * @param param The parameters received in the call.</span> |
| <span class="source-line-no">519</span><span id="line-519"> * @param methodName The name of the method invoked</span> |
| <span class="source-line-no">520</span><span id="line-520"> * @param call The string representation of the call</span> |
| <span class="source-line-no">521</span><span id="line-521"> * @param tooLarge To indicate if the event is tooLarge</span> |
| <span class="source-line-no">522</span><span id="line-522"> * @param tooSlow To indicate if the event is tooSlow</span> |
| <span class="source-line-no">523</span><span id="line-523"> * @param clientAddress The address of the client who made this call.</span> |
| <span class="source-line-no">524</span><span id="line-524"> * @param startTime The time that the call was initiated, in ms.</span> |
| <span class="source-line-no">525</span><span id="line-525"> * @param processingTime The duration that the call took to run, in ms.</span> |
| <span class="source-line-no">526</span><span id="line-526"> * @param qTime The duration that the call spent on the queue prior to being</span> |
| <span class="source-line-no">527</span><span id="line-527"> * initiated, in ms.</span> |
| <span class="source-line-no">528</span><span id="line-528"> * @param responseSize The size in bytes of the response buffer.</span> |
| <span class="source-line-no">529</span><span id="line-529"> * @param blockBytesScanned The size of block bytes scanned to retrieve the response.</span> |
| <span class="source-line-no">530</span><span id="line-530"> * @param userName UserName of the current RPC Call</span> |
| <span class="source-line-no">531</span><span id="line-531"> */</span> |
| <span class="source-line-no">532</span><span id="line-532"> void logResponse(Message param, String methodName, String call, boolean tooLarge, boolean tooSlow,</span> |
| <span class="source-line-no">533</span><span id="line-533"> String clientAddress, long startTime, int processingTime, int qTime, long responseSize,</span> |
| <span class="source-line-no">534</span><span id="line-534"> long blockBytesScanned, long fsReadTime, String userName) {</span> |
| <span class="source-line-no">535</span><span id="line-535"> final String className = server == null ? StringUtils.EMPTY : server.getClass().getSimpleName();</span> |
| <span class="source-line-no">536</span><span id="line-536"> // base information that is reported regardless of type of call</span> |
| <span class="source-line-no">537</span><span id="line-537"> Map<String, Object> responseInfo = new HashMap<>();</span> |
| <span class="source-line-no">538</span><span id="line-538"> responseInfo.put("starttimems", startTime);</span> |
| <span class="source-line-no">539</span><span id="line-539"> responseInfo.put("processingtimems", processingTime);</span> |
| <span class="source-line-no">540</span><span id="line-540"> responseInfo.put("queuetimems", qTime);</span> |
| <span class="source-line-no">541</span><span id="line-541"> responseInfo.put("responsesize", responseSize);</span> |
| <span class="source-line-no">542</span><span id="line-542"> responseInfo.put("blockbytesscanned", blockBytesScanned);</span> |
| <span class="source-line-no">543</span><span id="line-543"> responseInfo.put("fsreadtime", fsReadTime);</span> |
| <span class="source-line-no">544</span><span id="line-544"> responseInfo.put("client", clientAddress);</span> |
| <span class="source-line-no">545</span><span id="line-545"> responseInfo.put("class", className);</span> |
| <span class="source-line-no">546</span><span id="line-546"> responseInfo.put("method", methodName);</span> |
| <span class="source-line-no">547</span><span id="line-547"> responseInfo.put("call", call);</span> |
| <span class="source-line-no">548</span><span id="line-548"> // The params could be really big, make sure they don't kill us at WARN</span> |
| <span class="source-line-no">549</span><span id="line-549"> String stringifiedParam = ProtobufUtil.getShortTextFormat(param);</span> |
| <span class="source-line-no">550</span><span id="line-550"> if (stringifiedParam.length() > 150) {</span> |
| <span class="source-line-no">551</span><span id="line-551"> // Truncate to 1000 chars if TRACE is on, else to 150 chars</span> |
| <span class="source-line-no">552</span><span id="line-552"> stringifiedParam = truncateTraceLog(stringifiedParam);</span> |
| <span class="source-line-no">553</span><span id="line-553"> }</span> |
| <span class="source-line-no">554</span><span id="line-554"> responseInfo.put("param", stringifiedParam);</span> |
| <span class="source-line-no">555</span><span id="line-555"> if (param instanceof ClientProtos.ScanRequest && rsRpcServices != null) {</span> |
| <span class="source-line-no">556</span><span id="line-556"> ClientProtos.ScanRequest request = ((ClientProtos.ScanRequest) param);</span> |
| <span class="source-line-no">557</span><span id="line-557"> String scanDetails;</span> |
| <span class="source-line-no">558</span><span id="line-558"> if (request.hasScannerId()) {</span> |
| <span class="source-line-no">559</span><span id="line-559"> long scannerId = request.getScannerId();</span> |
| <span class="source-line-no">560</span><span id="line-560"> scanDetails = rsRpcServices.getScanDetailsWithId(scannerId);</span> |
| <span class="source-line-no">561</span><span id="line-561"> } else {</span> |
| <span class="source-line-no">562</span><span id="line-562"> scanDetails = rsRpcServices.getScanDetailsWithRequest(request);</span> |
| <span class="source-line-no">563</span><span id="line-563"> }</span> |
| <span class="source-line-no">564</span><span id="line-564"> if (scanDetails != null) {</span> |
| <span class="source-line-no">565</span><span id="line-565"> responseInfo.put("scandetails", scanDetails);</span> |
| <span class="source-line-no">566</span><span id="line-566"> }</span> |
| <span class="source-line-no">567</span><span id="line-567"> }</span> |
| <span class="source-line-no">568</span><span id="line-568"> if (param instanceof ClientProtos.MultiRequest) {</span> |
| <span class="source-line-no">569</span><span id="line-569"> int numGets = 0;</span> |
| <span class="source-line-no">570</span><span id="line-570"> int numMutations = 0;</span> |
| <span class="source-line-no">571</span><span id="line-571"> int numServiceCalls = 0;</span> |
| <span class="source-line-no">572</span><span id="line-572"> ClientProtos.MultiRequest multi = (ClientProtos.MultiRequest) param;</span> |
| <span class="source-line-no">573</span><span id="line-573"> for (ClientProtos.RegionAction regionAction : multi.getRegionActionList()) {</span> |
| <span class="source-line-no">574</span><span id="line-574"> for (ClientProtos.Action action : regionAction.getActionList()) {</span> |
| <span class="source-line-no">575</span><span id="line-575"> if (action.hasMutation()) {</span> |
| <span class="source-line-no">576</span><span id="line-576"> numMutations++;</span> |
| <span class="source-line-no">577</span><span id="line-577"> }</span> |
| <span class="source-line-no">578</span><span id="line-578"> if (action.hasGet()) {</span> |
| <span class="source-line-no">579</span><span id="line-579"> numGets++;</span> |
| <span class="source-line-no">580</span><span id="line-580"> }</span> |
| <span class="source-line-no">581</span><span id="line-581"> if (action.hasServiceCall()) {</span> |
| <span class="source-line-no">582</span><span id="line-582"> numServiceCalls++;</span> |
| <span class="source-line-no">583</span><span id="line-583"> }</span> |
| <span class="source-line-no">584</span><span id="line-584"> }</span> |
| <span class="source-line-no">585</span><span id="line-585"> }</span> |
| <span class="source-line-no">586</span><span id="line-586"> responseInfo.put(MULTI_GETS, numGets);</span> |
| <span class="source-line-no">587</span><span id="line-587"> responseInfo.put(MULTI_MUTATIONS, numMutations);</span> |
| <span class="source-line-no">588</span><span id="line-588"> responseInfo.put(MULTI_SERVICE_CALLS, numServiceCalls);</span> |
| <span class="source-line-no">589</span><span id="line-589"> }</span> |
| <span class="source-line-no">590</span><span id="line-590"> final String tag =</span> |
| <span class="source-line-no">591</span><span id="line-591"> (tooLarge && tooSlow) ? "TooLarge & TooSlow" : (tooSlow ? "TooSlow" : "TooLarge");</span> |
| <span class="source-line-no">592</span><span id="line-592"> LOG.warn("(response" + tag + "): " + GSON.toJson(responseInfo));</span> |
| <span class="source-line-no">593</span><span id="line-593"> }</span> |
| <span class="source-line-no">594</span><span id="line-594"></span> |
| <span class="source-line-no">595</span><span id="line-595"> private boolean isTooSlow(RpcCall call, int processingTime) {</span> |
| <span class="source-line-no">596</span><span id="line-596"> long warnResponseTime = call.getParam() instanceof ClientProtos.ScanRequest</span> |
| <span class="source-line-no">597</span><span id="line-597"> ? warnScanResponseTime</span> |
| <span class="source-line-no">598</span><span id="line-598"> : this.warnResponseTime;</span> |
| <span class="source-line-no">599</span><span id="line-599"> return (processingTime > warnResponseTime && warnResponseTime > -1);</span> |
| <span class="source-line-no">600</span><span id="line-600"> }</span> |
| <span class="source-line-no">601</span><span id="line-601"></span> |
| <span class="source-line-no">602</span><span id="line-602"> private boolean isTooLarge(RpcCall call, long responseSize, long responseBlockSize) {</span> |
| <span class="source-line-no">603</span><span id="line-603"> long warnResponseSize = call.getParam() instanceof ClientProtos.ScanRequest</span> |
| <span class="source-line-no">604</span><span id="line-604"> ? warnScanResponseSize</span> |
| <span class="source-line-no">605</span><span id="line-605"> : this.warnResponseSize;</span> |
| <span class="source-line-no">606</span><span id="line-606"> return (warnResponseSize > -1</span> |
| <span class="source-line-no">607</span><span id="line-607"> && (responseSize > warnResponseSize || responseBlockSize > warnResponseSize));</span> |
| <span class="source-line-no">608</span><span id="line-608"> }</span> |
| <span class="source-line-no">609</span><span id="line-609"></span> |
| <span class="source-line-no">610</span><span id="line-610"> /**</span> |
| <span class="source-line-no">611</span><span id="line-611"> * Truncate to number of chars decided by conf hbase.ipc.trace.log.max.length if TRACE is on else</span> |
| <span class="source-line-no">612</span><span id="line-612"> * to 150 chars Refer to Jira HBASE-20826 and HBASE-20942</span> |
| <span class="source-line-no">613</span><span id="line-613"> * @param strParam stringifiedParam to be truncated</span> |
| <span class="source-line-no">614</span><span id="line-614"> * @return truncated trace log string</span> |
| <span class="source-line-no">615</span><span id="line-615"> */</span> |
| <span class="source-line-no">616</span><span id="line-616"> String truncateTraceLog(String strParam) {</span> |
| <span class="source-line-no">617</span><span id="line-617"> if (LOG.isTraceEnabled()) {</span> |
| <span class="source-line-no">618</span><span id="line-618"> int traceLogMaxLength = getConf().getInt(TRACE_LOG_MAX_LENGTH, DEFAULT_TRACE_LOG_MAX_LENGTH);</span> |
| <span class="source-line-no">619</span><span id="line-619"> int truncatedLength =</span> |
| <span class="source-line-no">620</span><span id="line-620"> strParam.length() < traceLogMaxLength ? strParam.length() : traceLogMaxLength;</span> |
| <span class="source-line-no">621</span><span id="line-621"> String truncatedFlag = truncatedLength == strParam.length() ? "" : KEY_WORD_TRUNCATED;</span> |
| <span class="source-line-no">622</span><span id="line-622"> return strParam.subSequence(0, truncatedLength) + truncatedFlag;</span> |
| <span class="source-line-no">623</span><span id="line-623"> }</span> |
| <span class="source-line-no">624</span><span id="line-624"> return strParam.subSequence(0, 150) + KEY_WORD_TRUNCATED;</span> |
| <span class="source-line-no">625</span><span id="line-625"> }</span> |
| <span class="source-line-no">626</span><span id="line-626"></span> |
| <span class="source-line-no">627</span><span id="line-627"> /**</span> |
| <span class="source-line-no">628</span><span id="line-628"> * Set the handler for calling out of RPC for error conditions.</span> |
| <span class="source-line-no">629</span><span id="line-629"> * @param handler the handler implementation</span> |
| <span class="source-line-no">630</span><span id="line-630"> */</span> |
| <span class="source-line-no">631</span><span id="line-631"> @Override</span> |
| <span class="source-line-no">632</span><span id="line-632"> public void setErrorHandler(HBaseRPCErrorHandler handler) {</span> |
| <span class="source-line-no">633</span><span id="line-633"> this.errorHandler = handler;</span> |
| <span class="source-line-no">634</span><span id="line-634"> }</span> |
| <span class="source-line-no">635</span><span id="line-635"></span> |
| <span class="source-line-no">636</span><span id="line-636"> @Override</span> |
| <span class="source-line-no">637</span><span id="line-637"> public HBaseRPCErrorHandler getErrorHandler() {</span> |
| <span class="source-line-no">638</span><span id="line-638"> return this.errorHandler;</span> |
| <span class="source-line-no">639</span><span id="line-639"> }</span> |
| <span class="source-line-no">640</span><span id="line-640"></span> |
| <span class="source-line-no">641</span><span id="line-641"> /**</span> |
| <span class="source-line-no">642</span><span id="line-642"> * Returns the metrics instance for reporting RPC call statistics</span> |
| <span class="source-line-no">643</span><span id="line-643"> */</span> |
| <span class="source-line-no">644</span><span id="line-644"> @Override</span> |
| <span class="source-line-no">645</span><span id="line-645"> public MetricsHBaseServer getMetrics() {</span> |
| <span class="source-line-no">646</span><span id="line-646"> return metrics;</span> |
| <span class="source-line-no">647</span><span id="line-647"> }</span> |
| <span class="source-line-no">648</span><span id="line-648"></span> |
| <span class="source-line-no">649</span><span id="line-649"> @Override</span> |
| <span class="source-line-no">650</span><span id="line-650"> public void addCallSize(final long diff) {</span> |
| <span class="source-line-no">651</span><span id="line-651"> this.callQueueSizeInBytes.add(diff);</span> |
| <span class="source-line-no">652</span><span id="line-652"> }</span> |
| <span class="source-line-no">653</span><span id="line-653"></span> |
| <span class="source-line-no">654</span><span id="line-654"> /**</span> |
| <span class="source-line-no">655</span><span id="line-655"> * Authorize the incoming client connection.</span> |
| <span class="source-line-no">656</span><span id="line-656"> * @param user client user</span> |
| <span class="source-line-no">657</span><span id="line-657"> * @param connection incoming connection</span> |
| <span class="source-line-no">658</span><span id="line-658"> * @param addr InetAddress of incoming connection</span> |
| <span class="source-line-no">659</span><span id="line-659"> * @throws AuthorizationException when the client isn't authorized to talk the protocol</span> |
| <span class="source-line-no">660</span><span id="line-660"> */</span> |
| <span class="source-line-no">661</span><span id="line-661"> public synchronized void authorize(UserGroupInformation user, ConnectionHeader connection,</span> |
| <span class="source-line-no">662</span><span id="line-662"> InetAddress addr) throws AuthorizationException {</span> |
| <span class="source-line-no">663</span><span id="line-663"> if (authorize) {</span> |
| <span class="source-line-no">664</span><span id="line-664"> Class<?> c = getServiceInterface(services, connection.getServiceName());</span> |
| <span class="source-line-no">665</span><span id="line-665"> authManager.authorize(user, c, getConf(), addr);</span> |
| <span class="source-line-no">666</span><span id="line-666"> }</span> |
| <span class="source-line-no">667</span><span id="line-667"> }</span> |
| <span class="source-line-no">668</span><span id="line-668"></span> |
| <span class="source-line-no">669</span><span id="line-669"> /**</span> |
| <span class="source-line-no">670</span><span id="line-670"> * When the read or write buffer size is larger than this limit, i/o will be done in chunks of</span> |
| <span class="source-line-no">671</span><span id="line-671"> * this size. Most RPC requests and responses would be be smaller.</span> |
| <span class="source-line-no">672</span><span id="line-672"> */</span> |
| <span class="source-line-no">673</span><span id="line-673"> protected static final int NIO_BUFFER_LIMIT = 64 * 1024; // should not be more than 64KB.</span> |
| <span class="source-line-no">674</span><span id="line-674"></span> |
| <span class="source-line-no">675</span><span id="line-675"> /**</span> |
| <span class="source-line-no">676</span><span id="line-676"> * This is a wrapper around</span> |
| <span class="source-line-no">677</span><span id="line-677"> * {@link java.nio.channels.ReadableByteChannel#read(java.nio.ByteBuffer)}. If the amount of data</span> |
| <span class="source-line-no">678</span><span id="line-678"> * is large, it writes to channel in smaller chunks. This is to avoid jdk from creating many</span> |
| <span class="source-line-no">679</span><span id="line-679"> * direct buffers as the size of ByteBuffer increases. There should not be any performance</span> |
| <span class="source-line-no">680</span><span id="line-680"> * degredation.</span> |
| <span class="source-line-no">681</span><span id="line-681"> * @param channel writable byte channel to write on</span> |
| <span class="source-line-no">682</span><span id="line-682"> * @param buffer buffer to write</span> |
| <span class="source-line-no">683</span><span id="line-683"> * @return number of bytes written</span> |
| <span class="source-line-no">684</span><span id="line-684"> * @throws java.io.IOException e</span> |
| <span class="source-line-no">685</span><span id="line-685"> * @see java.nio.channels.ReadableByteChannel#read(java.nio.ByteBuffer)</span> |
| <span class="source-line-no">686</span><span id="line-686"> */</span> |
| <span class="source-line-no">687</span><span id="line-687"> protected int channelRead(ReadableByteChannel channel, ByteBuffer buffer) throws IOException {</span> |
| <span class="source-line-no">688</span><span id="line-688"></span> |
| <span class="source-line-no">689</span><span id="line-689"> int count = (buffer.remaining() <= NIO_BUFFER_LIMIT)</span> |
| <span class="source-line-no">690</span><span id="line-690"> ? channel.read(buffer)</span> |
| <span class="source-line-no">691</span><span id="line-691"> : channelIO(channel, null, buffer);</span> |
| <span class="source-line-no">692</span><span id="line-692"> if (count > 0) {</span> |
| <span class="source-line-no">693</span><span id="line-693"> metrics.receivedBytes(count);</span> |
| <span class="source-line-no">694</span><span id="line-694"> }</span> |
| <span class="source-line-no">695</span><span id="line-695"> return count;</span> |
| <span class="source-line-no">696</span><span id="line-696"> }</span> |
| <span class="source-line-no">697</span><span id="line-697"></span> |
| <span class="source-line-no">698</span><span id="line-698"> /**</span> |
| <span class="source-line-no">699</span><span id="line-699"> * Helper for {@link #channelRead(java.nio.channels.ReadableByteChannel, java.nio.ByteBuffer)}.</span> |
| <span class="source-line-no">700</span><span id="line-700"> * Only one of readCh or writeCh should be non-null.</span> |
| <span class="source-line-no">701</span><span id="line-701"> * @param readCh read channel</span> |
| <span class="source-line-no">702</span><span id="line-702"> * @param writeCh write channel</span> |
| <span class="source-line-no">703</span><span id="line-703"> * @param buf buffer to read or write into/out of</span> |
| <span class="source-line-no">704</span><span id="line-704"> * @return bytes written</span> |
| <span class="source-line-no">705</span><span id="line-705"> * @throws java.io.IOException e</span> |
| <span class="source-line-no">706</span><span id="line-706"> * @see #channelRead(java.nio.channels.ReadableByteChannel, java.nio.ByteBuffer)</span> |
| <span class="source-line-no">707</span><span id="line-707"> */</span> |
| <span class="source-line-no">708</span><span id="line-708"> private static int channelIO(ReadableByteChannel readCh, WritableByteChannel writeCh,</span> |
| <span class="source-line-no">709</span><span id="line-709"> ByteBuffer buf) throws IOException {</span> |
| <span class="source-line-no">710</span><span id="line-710"></span> |
| <span class="source-line-no">711</span><span id="line-711"> int originalLimit = buf.limit();</span> |
| <span class="source-line-no">712</span><span id="line-712"> int initialRemaining = buf.remaining();</span> |
| <span class="source-line-no">713</span><span id="line-713"> int ret = 0;</span> |
| <span class="source-line-no">714</span><span id="line-714"></span> |
| <span class="source-line-no">715</span><span id="line-715"> while (buf.remaining() > 0) {</span> |
| <span class="source-line-no">716</span><span id="line-716"> try {</span> |
| <span class="source-line-no">717</span><span id="line-717"> int ioSize = Math.min(buf.remaining(), NIO_BUFFER_LIMIT);</span> |
| <span class="source-line-no">718</span><span id="line-718"> buf.limit(buf.position() + ioSize);</span> |
| <span class="source-line-no">719</span><span id="line-719"></span> |
| <span class="source-line-no">720</span><span id="line-720"> ret = (readCh == null) ? writeCh.write(buf) : readCh.read(buf);</span> |
| <span class="source-line-no">721</span><span id="line-721"></span> |
| <span class="source-line-no">722</span><span id="line-722"> if (ret < ioSize) {</span> |
| <span class="source-line-no">723</span><span id="line-723"> break;</span> |
| <span class="source-line-no">724</span><span id="line-724"> }</span> |
| <span class="source-line-no">725</span><span id="line-725"></span> |
| <span class="source-line-no">726</span><span id="line-726"> } finally {</span> |
| <span class="source-line-no">727</span><span id="line-727"> buf.limit(originalLimit);</span> |
| <span class="source-line-no">728</span><span id="line-728"> }</span> |
| <span class="source-line-no">729</span><span id="line-729"> }</span> |
| <span class="source-line-no">730</span><span id="line-730"></span> |
| <span class="source-line-no">731</span><span id="line-731"> int nBytes = initialRemaining - buf.remaining();</span> |
| <span class="source-line-no">732</span><span id="line-732"> return (nBytes > 0) ? nBytes : ret;</span> |
| <span class="source-line-no">733</span><span id="line-733"> }</span> |
| <span class="source-line-no">734</span><span id="line-734"></span> |
| <span class="source-line-no">735</span><span id="line-735"> /**</span> |
| <span class="source-line-no">736</span><span id="line-736"> * Needed for features such as delayed calls. We need to be able to store the current call so that</span> |
| <span class="source-line-no">737</span><span id="line-737"> * we can complete it later or ask questions of what is supported by the current ongoing call.</span> |
| <span class="source-line-no">738</span><span id="line-738"> * @return An RpcCallContext backed by the currently ongoing call (gotten from a thread local)</span> |
| <span class="source-line-no">739</span><span id="line-739"> */</span> |
| <span class="source-line-no">740</span><span id="line-740"> public static Optional<RpcCall> getCurrentCall() {</span> |
| <span class="source-line-no">741</span><span id="line-741"> return Optional.ofNullable(CurCall.get());</span> |
| <span class="source-line-no">742</span><span id="line-742"> }</span> |
| <span class="source-line-no">743</span><span id="line-743"></span> |
| <span class="source-line-no">744</span><span id="line-744"> /**</span> |
| <span class="source-line-no">745</span><span id="line-745"> * Just return the current rpc call if it is a {@link ServerCall} and also has {@link CellScanner}</span> |
| <span class="source-line-no">746</span><span id="line-746"> * attached.</span> |
| <span class="source-line-no">747</span><span id="line-747"> * <p/></span> |
| <span class="source-line-no">748</span><span id="line-748"> * Mainly used for reference counting as {@link CellScanner} may reference non heap memory.</span> |
| <span class="source-line-no">749</span><span id="line-749"> */</span> |
| <span class="source-line-no">750</span><span id="line-750"> public static Optional<ServerCall<?>> getCurrentServerCallWithCellScanner() {</span> |
| <span class="source-line-no">751</span><span id="line-751"> return getCurrentCall().filter(c -> c instanceof ServerCall)</span> |
| <span class="source-line-no">752</span><span id="line-752"> .filter(c -> c.getCellScanner() != null).map(c -> (ServerCall<?>) c);</span> |
| <span class="source-line-no">753</span><span id="line-753"> }</span> |
| <span class="source-line-no">754</span><span id="line-754"></span> |
| <span class="source-line-no">755</span><span id="line-755"> public static boolean isInRpcCallContext() {</span> |
| <span class="source-line-no">756</span><span id="line-756"> return CurCall.get() != null;</span> |
| <span class="source-line-no">757</span><span id="line-757"> }</span> |
| <span class="source-line-no">758</span><span id="line-758"></span> |
| <span class="source-line-no">759</span><span id="line-759"> /**</span> |
| <span class="source-line-no">760</span><span id="line-760"> * Used by {@link org.apache.hadoop.hbase.procedure2.store.region.RegionProcedureStore}. For</span> |
| <span class="source-line-no">761</span><span id="line-761"> * master's rpc call, it may generate new procedure and mutate the region which store procedure.</span> |
| <span class="source-line-no">762</span><span id="line-762"> * There are some check about rpc when mutate region, such as rpc timeout check. So unset the rpc</span> |
| <span class="source-line-no">763</span><span id="line-763"> * call to avoid the rpc check.</span> |
| <span class="source-line-no">764</span><span id="line-764"> * @return the currently ongoing rpc call</span> |
| <span class="source-line-no">765</span><span id="line-765"> */</span> |
| <span class="source-line-no">766</span><span id="line-766"> public static Optional<RpcCall> unsetCurrentCall() {</span> |
| <span class="source-line-no">767</span><span id="line-767"> Optional<RpcCall> rpcCall = getCurrentCall();</span> |
| <span class="source-line-no">768</span><span id="line-768"> CurCall.set(null);</span> |
| <span class="source-line-no">769</span><span id="line-769"> return rpcCall;</span> |
| <span class="source-line-no">770</span><span id="line-770"> }</span> |
| <span class="source-line-no">771</span><span id="line-771"></span> |
| <span class="source-line-no">772</span><span id="line-772"> /**</span> |
| <span class="source-line-no">773</span><span id="line-773"> * Used by {@link org.apache.hadoop.hbase.procedure2.store.region.RegionProcedureStore}. Set the</span> |
| <span class="source-line-no">774</span><span id="line-774"> * rpc call back after mutate region.</span> |
| <span class="source-line-no">775</span><span id="line-775"> */</span> |
| <span class="source-line-no">776</span><span id="line-776"> public static void setCurrentCall(RpcCall rpcCall) {</span> |
| <span class="source-line-no">777</span><span id="line-777"> CurCall.set(rpcCall);</span> |
| <span class="source-line-no">778</span><span id="line-778"> }</span> |
| <span class="source-line-no">779</span><span id="line-779"></span> |
| <span class="source-line-no">780</span><span id="line-780"> /**</span> |
| <span class="source-line-no">781</span><span id="line-781"> * Returns the user credentials associated with the current RPC request or not present if no</span> |
| <span class="source-line-no">782</span><span id="line-782"> * credentials were provided.</span> |
| <span class="source-line-no">783</span><span id="line-783"> * @return A User</span> |
| <span class="source-line-no">784</span><span id="line-784"> */</span> |
| <span class="source-line-no">785</span><span id="line-785"> public static Optional<User> getRequestUser() {</span> |
| <span class="source-line-no">786</span><span id="line-786"> Optional<RpcCall> ctx = getCurrentCall();</span> |
| <span class="source-line-no">787</span><span id="line-787"> return ctx.isPresent() ? ctx.get().getRequestUser() : Optional.empty();</span> |
| <span class="source-line-no">788</span><span id="line-788"> }</span> |
| <span class="source-line-no">789</span><span id="line-789"></span> |
| <span class="source-line-no">790</span><span id="line-790"> /**</span> |
| <span class="source-line-no">791</span><span id="line-791"> * The number of open RPC conections</span> |
| <span class="source-line-no">792</span><span id="line-792"> * @return the number of open rpc connections</span> |
| <span class="source-line-no">793</span><span id="line-793"> */</span> |
| <span class="source-line-no">794</span><span id="line-794"> abstract public int getNumOpenConnections();</span> |
| <span class="source-line-no">795</span><span id="line-795"></span> |
| <span class="source-line-no">796</span><span id="line-796"> /**</span> |
| <span class="source-line-no">797</span><span id="line-797"> * Returns the username for any user associated with the current RPC request or not present if no</span> |
| <span class="source-line-no">798</span><span id="line-798"> * user is set.</span> |
| <span class="source-line-no">799</span><span id="line-799"> */</span> |
| <span class="source-line-no">800</span><span id="line-800"> public static Optional<String> getRequestUserName() {</span> |
| <span class="source-line-no">801</span><span id="line-801"> return getRequestUser().map(User::getShortName);</span> |
| <span class="source-line-no">802</span><span id="line-802"> }</span> |
| <span class="source-line-no">803</span><span id="line-803"></span> |
| <span class="source-line-no">804</span><span id="line-804"> /**</span> |
| <span class="source-line-no">805</span><span id="line-805"> * Returns the address of the remote client associated with the current RPC request or not present</span> |
| <span class="source-line-no">806</span><span id="line-806"> * if no address is set.</span> |
| <span class="source-line-no">807</span><span id="line-807"> */</span> |
| <span class="source-line-no">808</span><span id="line-808"> public static Optional<InetAddress> getRemoteAddress() {</span> |
| <span class="source-line-no">809</span><span id="line-809"> return getCurrentCall().map(RpcCall::getRemoteAddress);</span> |
| <span class="source-line-no">810</span><span id="line-810"> }</span> |
| <span class="source-line-no">811</span><span id="line-811"></span> |
| <span class="source-line-no">812</span><span id="line-812"> /**</span> |
| <span class="source-line-no">813</span><span id="line-813"> * @param serviceName Some arbitrary string that represents a 'service'.</span> |
| <span class="source-line-no">814</span><span id="line-814"> * @param services Available service instances</span> |
| <span class="source-line-no">815</span><span id="line-815"> * @return Matching BlockingServiceAndInterface pair</span> |
| <span class="source-line-no">816</span><span id="line-816"> */</span> |
| <span class="source-line-no">817</span><span id="line-817"> protected static BlockingServiceAndInterface getServiceAndInterface(</span> |
| <span class="source-line-no">818</span><span id="line-818"> final List<BlockingServiceAndInterface> services, final String serviceName) {</span> |
| <span class="source-line-no">819</span><span id="line-819"> for (BlockingServiceAndInterface bs : services) {</span> |
| <span class="source-line-no">820</span><span id="line-820"> if (bs.getBlockingService().getDescriptorForType().getName().equals(serviceName)) {</span> |
| <span class="source-line-no">821</span><span id="line-821"> return bs;</span> |
| <span class="source-line-no">822</span><span id="line-822"> }</span> |
| <span class="source-line-no">823</span><span id="line-823"> }</span> |
| <span class="source-line-no">824</span><span id="line-824"> return null;</span> |
| <span class="source-line-no">825</span><span id="line-825"> }</span> |
| <span class="source-line-no">826</span><span id="line-826"></span> |
| <span class="source-line-no">827</span><span id="line-827"> /**</span> |
| <span class="source-line-no">828</span><span id="line-828"> * @param serviceName Some arbitrary string that represents a 'service'.</span> |
| <span class="source-line-no">829</span><span id="line-829"> * @param services Available services and their service interfaces.</span> |
| <span class="source-line-no">830</span><span id="line-830"> * @return Service interface class for <code>serviceName</code></span> |
| <span class="source-line-no">831</span><span id="line-831"> */</span> |
| <span class="source-line-no">832</span><span id="line-832"> protected static Class<?> getServiceInterface(final List<BlockingServiceAndInterface> services,</span> |
| <span class="source-line-no">833</span><span id="line-833"> final String serviceName) {</span> |
| <span class="source-line-no">834</span><span id="line-834"> BlockingServiceAndInterface bsasi = getServiceAndInterface(services, serviceName);</span> |
| <span class="source-line-no">835</span><span id="line-835"> return bsasi == null ? null : bsasi.getServiceInterface();</span> |
| <span class="source-line-no">836</span><span id="line-836"> }</span> |
| <span class="source-line-no">837</span><span id="line-837"></span> |
| <span class="source-line-no">838</span><span id="line-838"> /**</span> |
| <span class="source-line-no">839</span><span id="line-839"> * @param serviceName Some arbitrary string that represents a 'service'.</span> |
| <span class="source-line-no">840</span><span id="line-840"> * @param services Available services and their service interfaces.</span> |
| <span class="source-line-no">841</span><span id="line-841"> * @return BlockingService that goes with the passed <code>serviceName</code></span> |
| <span class="source-line-no">842</span><span id="line-842"> */</span> |
| <span class="source-line-no">843</span><span id="line-843"> protected static BlockingService getService(final List<BlockingServiceAndInterface> services,</span> |
| <span class="source-line-no">844</span><span id="line-844"> final String serviceName) {</span> |
| <span class="source-line-no">845</span><span id="line-845"> BlockingServiceAndInterface bsasi = getServiceAndInterface(services, serviceName);</span> |
| <span class="source-line-no">846</span><span id="line-846"> return bsasi == null ? null : bsasi.getBlockingService();</span> |
| <span class="source-line-no">847</span><span id="line-847"> }</span> |
| <span class="source-line-no">848</span><span id="line-848"></span> |
| <span class="source-line-no">849</span><span id="line-849"> protected static MonitoredRPCHandler getStatus() {</span> |
| <span class="source-line-no">850</span><span id="line-850"> // It is ugly the way we park status up in RpcServer. Let it be for now. TODO.</span> |
| <span class="source-line-no">851</span><span id="line-851"> MonitoredRPCHandler status = RpcServer.MONITORED_RPC.get();</span> |
| <span class="source-line-no">852</span><span id="line-852"> if (status != null) {</span> |
| <span class="source-line-no">853</span><span id="line-853"> return status;</span> |
| <span class="source-line-no">854</span><span id="line-854"> }</span> |
| <span class="source-line-no">855</span><span id="line-855"> status = TaskMonitor.get().createRPCStatus(Thread.currentThread().getName());</span> |
| <span class="source-line-no">856</span><span id="line-856"> status.pause("Waiting for a call");</span> |
| <span class="source-line-no">857</span><span id="line-857"> RpcServer.MONITORED_RPC.set(status);</span> |
| <span class="source-line-no">858</span><span id="line-858"> return status;</span> |
| <span class="source-line-no">859</span><span id="line-859"> }</span> |
| <span class="source-line-no">860</span><span id="line-860"></span> |
| <span class="source-line-no">861</span><span id="line-861"> /**</span> |
| <span class="source-line-no">862</span><span id="line-862"> * Returns the remote side ip address when invoked inside an RPC Returns null incase of an error.</span> |
| <span class="source-line-no">863</span><span id="line-863"> */</span> |
| <span class="source-line-no">864</span><span id="line-864"> public static InetAddress getRemoteIp() {</span> |
| <span class="source-line-no">865</span><span id="line-865"> RpcCall call = CurCall.get();</span> |
| <span class="source-line-no">866</span><span id="line-866"> if (call != null) {</span> |
| <span class="source-line-no">867</span><span id="line-867"> return call.getRemoteAddress();</span> |
| <span class="source-line-no">868</span><span id="line-868"> }</span> |
| <span class="source-line-no">869</span><span id="line-869"> return null;</span> |
| <span class="source-line-no">870</span><span id="line-870"> }</span> |
| <span class="source-line-no">871</span><span id="line-871"></span> |
| <span class="source-line-no">872</span><span id="line-872"> @Override</span> |
| <span class="source-line-no">873</span><span id="line-873"> public RpcScheduler getScheduler() {</span> |
| <span class="source-line-no">874</span><span id="line-874"> return scheduler;</span> |
| <span class="source-line-no">875</span><span id="line-875"> }</span> |
| <span class="source-line-no">876</span><span id="line-876"></span> |
| <span class="source-line-no">877</span><span id="line-877"> @Override</span> |
| <span class="source-line-no">878</span><span id="line-878"> public ByteBuffAllocator getByteBuffAllocator() {</span> |
| <span class="source-line-no">879</span><span id="line-879"> return this.bbAllocator;</span> |
| <span class="source-line-no">880</span><span id="line-880"> }</span> |
| <span class="source-line-no">881</span><span id="line-881"></span> |
| <span class="source-line-no">882</span><span id="line-882"> @Override</span> |
| <span class="source-line-no">883</span><span id="line-883"> public void setRsRpcServices(RSRpcServices rsRpcServices) {</span> |
| <span class="source-line-no">884</span><span id="line-884"> this.rsRpcServices = rsRpcServices;</span> |
| <span class="source-line-no">885</span><span id="line-885"> }</span> |
| <span class="source-line-no">886</span><span id="line-886"></span> |
| <span class="source-line-no">887</span><span id="line-887"> @Override</span> |
| <span class="source-line-no">888</span><span id="line-888"> public void setNamedQueueRecorder(NamedQueueRecorder namedQueueRecorder) {</span> |
| <span class="source-line-no">889</span><span id="line-889"> this.namedQueueRecorder = namedQueueRecorder;</span> |
| <span class="source-line-no">890</span><span id="line-890"> }</span> |
| <span class="source-line-no">891</span><span id="line-891"></span> |
| <span class="source-line-no">892</span><span id="line-892"> protected boolean needAuthorization() {</span> |
| <span class="source-line-no">893</span><span id="line-893"> return authorize;</span> |
| <span class="source-line-no">894</span><span id="line-894"> }</span> |
| <span class="source-line-no">895</span><span id="line-895"></span> |
| <span class="source-line-no">896</span><span id="line-896"> @RestrictedApi(explanation = "Should only be called in tests", link = "",</span> |
| <span class="source-line-no">897</span><span id="line-897"> allowedOnPath = ".*/src/test/.*")</span> |
| <span class="source-line-no">898</span><span id="line-898"> public List<BlockingServiceAndInterface> getServices() {</span> |
| <span class="source-line-no">899</span><span id="line-899"> return services;</span> |
| <span class="source-line-no">900</span><span id="line-900"> }</span> |
| <span class="source-line-no">901</span><span id="line-901">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
