blob: 99a1e9bf234c020e144212e46797497f4c6f6509 [file] [log] [blame]
<!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: CallRunner">
<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 io.opentelemetry.api.trace.Span;</span>
<span class="source-line-no">021</span><span id="line-21">import io.opentelemetry.api.trace.StatusCode;</span>
<span class="source-line-no">022</span><span id="line-22">import io.opentelemetry.context.Scope;</span>
<span class="source-line-no">023</span><span id="line-23">import java.net.InetSocketAddress;</span>
<span class="source-line-no">024</span><span id="line-24">import java.nio.channels.ClosedChannelException;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.CallDroppedException;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.ExtendedCellScanner;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.HBaseInterfaceAudience;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.exceptions.TimeoutIOException;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.monitoring.MonitoredRPCHandler;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.security.User;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.server.trace.IpcServerSpanBuilder;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.trace.TraceUtil;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.util.Pair;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.util.StringUtils;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.yetus.audience.InterfaceStability;</span>
<span class="source-line-no">038</span><span id="line-38"></span>
<span class="source-line-no">039</span><span id="line-39">import org.apache.hbase.thirdparty.com.google.protobuf.Message;</span>
<span class="source-line-no">040</span><span id="line-40"></span>
<span class="source-line-no">041</span><span id="line-41">/**</span>
<span class="source-line-no">042</span><span id="line-42"> * The request processing logic, which is usually executed in thread pools provided by an</span>
<span class="source-line-no">043</span><span id="line-43"> * {@link RpcScheduler}. Call {@link #run()} to actually execute the contained RpcServer.Call</span>
<span class="source-line-no">044</span><span id="line-44"> */</span>
<span class="source-line-no">045</span><span id="line-45">@InterfaceAudience.LimitedPrivate({ HBaseInterfaceAudience.COPROC, HBaseInterfaceAudience.PHOENIX })</span>
<span class="source-line-no">046</span><span id="line-46">@InterfaceStability.Evolving</span>
<span class="source-line-no">047</span><span id="line-47">public class CallRunner {</span>
<span class="source-line-no">048</span><span id="line-48"></span>
<span class="source-line-no">049</span><span id="line-49"> private static final CallDroppedException CALL_DROPPED_EXCEPTION = new CallDroppedException();</span>
<span class="source-line-no">050</span><span id="line-50"></span>
<span class="source-line-no">051</span><span id="line-51"> private RpcCall call;</span>
<span class="source-line-no">052</span><span id="line-52"> private RpcServerInterface rpcServer;</span>
<span class="source-line-no">053</span><span id="line-53"> private MonitoredRPCHandler status;</span>
<span class="source-line-no">054</span><span id="line-54"> private final Span span;</span>
<span class="source-line-no">055</span><span id="line-55"> private volatile boolean successful;</span>
<span class="source-line-no">056</span><span id="line-56"></span>
<span class="source-line-no">057</span><span id="line-57"> /**</span>
<span class="source-line-no">058</span><span id="line-58"> * On construction, adds the size of this call to the running count of outstanding call sizes.</span>
<span class="source-line-no">059</span><span id="line-59"> * Presumption is that we are put on a queue while we wait on an executor to run us. During this</span>
<span class="source-line-no">060</span><span id="line-60"> * time we occupy heap.</span>
<span class="source-line-no">061</span><span id="line-61"> */</span>
<span class="source-line-no">062</span><span id="line-62"> // The constructor is shutdown so only RpcServer in this class can make one of these.</span>
<span class="source-line-no">063</span><span id="line-63"> CallRunner(final RpcServerInterface rpcServer, final RpcCall call) {</span>
<span class="source-line-no">064</span><span id="line-64"> this.call = call;</span>
<span class="source-line-no">065</span><span id="line-65"> this.rpcServer = rpcServer;</span>
<span class="source-line-no">066</span><span id="line-66"> this.span = Span.current();</span>
<span class="source-line-no">067</span><span id="line-67"> // Add size of the call to queue size.</span>
<span class="source-line-no">068</span><span id="line-68"> if (call != null &amp;&amp; rpcServer != null) {</span>
<span class="source-line-no">069</span><span id="line-69"> this.rpcServer.addCallSize(call.getSize());</span>
<span class="source-line-no">070</span><span id="line-70"> }</span>
<span class="source-line-no">071</span><span id="line-71"> }</span>
<span class="source-line-no">072</span><span id="line-72"></span>
<span class="source-line-no">073</span><span id="line-73"> public RpcCall getRpcCall() {</span>
<span class="source-line-no">074</span><span id="line-74"> return call;</span>
<span class="source-line-no">075</span><span id="line-75"> }</span>
<span class="source-line-no">076</span><span id="line-76"></span>
<span class="source-line-no">077</span><span id="line-77"> public void setStatus(MonitoredRPCHandler status) {</span>
<span class="source-line-no">078</span><span id="line-78"> this.status = status;</span>
<span class="source-line-no">079</span><span id="line-79"> }</span>
<span class="source-line-no">080</span><span id="line-80"></span>
<span class="source-line-no">081</span><span id="line-81"> /**</span>
<span class="source-line-no">082</span><span id="line-82"> * Cleanup after ourselves... let go of references.</span>
<span class="source-line-no">083</span><span id="line-83"> */</span>
<span class="source-line-no">084</span><span id="line-84"> private void cleanup() {</span>
<span class="source-line-no">085</span><span id="line-85"> this.call.cleanup();</span>
<span class="source-line-no">086</span><span id="line-86"> this.call = null;</span>
<span class="source-line-no">087</span><span id="line-87"> this.rpcServer = null;</span>
<span class="source-line-no">088</span><span id="line-88"> }</span>
<span class="source-line-no">089</span><span id="line-89"></span>
<span class="source-line-no">090</span><span id="line-90"> public void run() {</span>
<span class="source-line-no">091</span><span id="line-91"> try (Scope ignored = span.makeCurrent()) {</span>
<span class="source-line-no">092</span><span id="line-92"> if (call.disconnectSince() &gt;= 0) {</span>
<span class="source-line-no">093</span><span id="line-93"> RpcServer.LOG.debug("{}: skipped {}", Thread.currentThread().getName(), call);</span>
<span class="source-line-no">094</span><span id="line-94"> span.addEvent("Client disconnect detected");</span>
<span class="source-line-no">095</span><span id="line-95"> span.setStatus(StatusCode.OK);</span>
<span class="source-line-no">096</span><span id="line-96"> return;</span>
<span class="source-line-no">097</span><span id="line-97"> }</span>
<span class="source-line-no">098</span><span id="line-98"> call.setStartTime(EnvironmentEdgeManager.currentTime());</span>
<span class="source-line-no">099</span><span id="line-99"> if (call.getStartTime() &gt; call.getDeadline()) {</span>
<span class="source-line-no">100</span><span id="line-100"> RpcServer.LOG.warn("Dropping timed out call: {}", call);</span>
<span class="source-line-no">101</span><span id="line-101"> this.rpcServer.getMetrics().callTimedOut();</span>
<span class="source-line-no">102</span><span id="line-102"> span.addEvent("Call deadline exceeded");</span>
<span class="source-line-no">103</span><span id="line-103"> span.setStatus(StatusCode.OK);</span>
<span class="source-line-no">104</span><span id="line-104"> return;</span>
<span class="source-line-no">105</span><span id="line-105"> }</span>
<span class="source-line-no">106</span><span id="line-106"> this.status.setStatus("Setting up call");</span>
<span class="source-line-no">107</span><span id="line-107"> this.status.setConnection(call.getRemoteAddress().getHostAddress(), call.getRemotePort());</span>
<span class="source-line-no">108</span><span id="line-108"> if (RpcServer.LOG.isTraceEnabled()) {</span>
<span class="source-line-no">109</span><span id="line-109"> RpcServer.LOG.trace("{} executing as {}", call.toShortString(),</span>
<span class="source-line-no">110</span><span id="line-110"> call.getRequestUser().map(User::getName).orElse("NULL principal"));</span>
<span class="source-line-no">111</span><span id="line-111"> }</span>
<span class="source-line-no">112</span><span id="line-112"> Throwable errorThrowable = null;</span>
<span class="source-line-no">113</span><span id="line-113"> String error = null;</span>
<span class="source-line-no">114</span><span id="line-114"> Pair&lt;Message, ExtendedCellScanner&gt; resultPair = null;</span>
<span class="source-line-no">115</span><span id="line-115"> RpcServer.CurCall.set(call);</span>
<span class="source-line-no">116</span><span id="line-116"> final Span ipcServerSpan = new IpcServerSpanBuilder(call).build();</span>
<span class="source-line-no">117</span><span id="line-117"> try (Scope ignored1 = ipcServerSpan.makeCurrent()) {</span>
<span class="source-line-no">118</span><span id="line-118"> if (!this.rpcServer.isStarted()) {</span>
<span class="source-line-no">119</span><span id="line-119"> InetSocketAddress address = rpcServer.getListenerAddress();</span>
<span class="source-line-no">120</span><span id="line-120"> throw new ServerNotRunningYetException(</span>
<span class="source-line-no">121</span><span id="line-121"> "Server " + (address != null ? address : "(channel closed)") + " is not running yet");</span>
<span class="source-line-no">122</span><span id="line-122"> }</span>
<span class="source-line-no">123</span><span id="line-123"> // make the call</span>
<span class="source-line-no">124</span><span id="line-124"> resultPair = this.rpcServer.call(call, this.status);</span>
<span class="source-line-no">125</span><span id="line-125"> } catch (TimeoutIOException e) {</span>
<span class="source-line-no">126</span><span id="line-126"> RpcServer.LOG.warn("Can not complete this request in time, drop it: {}", call);</span>
<span class="source-line-no">127</span><span id="line-127"> TraceUtil.setError(ipcServerSpan, e);</span>
<span class="source-line-no">128</span><span id="line-128"> return;</span>
<span class="source-line-no">129</span><span id="line-129"> } catch (Throwable e) {</span>
<span class="source-line-no">130</span><span id="line-130"> TraceUtil.setError(ipcServerSpan, e);</span>
<span class="source-line-no">131</span><span id="line-131"> if (e instanceof ServerNotRunningYetException) {</span>
<span class="source-line-no">132</span><span id="line-132"> // If ServerNotRunningYetException, don't spew stack trace.</span>
<span class="source-line-no">133</span><span id="line-133"> if (RpcServer.LOG.isTraceEnabled()) {</span>
<span class="source-line-no">134</span><span id="line-134"> RpcServer.LOG.trace(call.toShortString(), e);</span>
<span class="source-line-no">135</span><span id="line-135"> }</span>
<span class="source-line-no">136</span><span id="line-136"> } else {</span>
<span class="source-line-no">137</span><span id="line-137"> // Don't dump full exception.. just String version</span>
<span class="source-line-no">138</span><span id="line-138"> RpcServer.LOG.debug("{}, exception={}", call.toShortString(), e);</span>
<span class="source-line-no">139</span><span id="line-139"> }</span>
<span class="source-line-no">140</span><span id="line-140"> errorThrowable = e;</span>
<span class="source-line-no">141</span><span id="line-141"> error = StringUtils.stringifyException(e);</span>
<span class="source-line-no">142</span><span id="line-142"> if (e instanceof Error) {</span>
<span class="source-line-no">143</span><span id="line-143"> throw (Error) e;</span>
<span class="source-line-no">144</span><span id="line-144"> }</span>
<span class="source-line-no">145</span><span id="line-145"> } finally {</span>
<span class="source-line-no">146</span><span id="line-146"> RpcServer.CurCall.set(null);</span>
<span class="source-line-no">147</span><span id="line-147"> if (resultPair != null) {</span>
<span class="source-line-no">148</span><span id="line-148"> this.rpcServer.addCallSize(call.getSize() * -1);</span>
<span class="source-line-no">149</span><span id="line-149"> ipcServerSpan.setStatus(StatusCode.OK);</span>
<span class="source-line-no">150</span><span id="line-150"> successful = true;</span>
<span class="source-line-no">151</span><span id="line-151"> }</span>
<span class="source-line-no">152</span><span id="line-152"> ipcServerSpan.end();</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.status.markComplete("To send response");</span>
<span class="source-line-no">155</span><span id="line-155"> // return the RPC request read BB we can do here. It is done by now.</span>
<span class="source-line-no">156</span><span id="line-156"> call.cleanup();</span>
<span class="source-line-no">157</span><span id="line-157"> // Set the response</span>
<span class="source-line-no">158</span><span id="line-158"> Message param = resultPair != null ? resultPair.getFirst() : null;</span>
<span class="source-line-no">159</span><span id="line-159"> ExtendedCellScanner cells = resultPair != null ? resultPair.getSecond() : null;</span>
<span class="source-line-no">160</span><span id="line-160"> call.setResponse(param, cells, errorThrowable, error);</span>
<span class="source-line-no">161</span><span id="line-161"> call.sendResponseIfReady();</span>
<span class="source-line-no">162</span><span id="line-162"> // don't touch `span` here because its status and `end()` are managed in `call#setResponse()`</span>
<span class="source-line-no">163</span><span id="line-163"> } catch (OutOfMemoryError e) {</span>
<span class="source-line-no">164</span><span id="line-164"> TraceUtil.setError(span, e);</span>
<span class="source-line-no">165</span><span id="line-165"> if (</span>
<span class="source-line-no">166</span><span id="line-166"> this.rpcServer.getErrorHandler() != null &amp;&amp; this.rpcServer.getErrorHandler().checkOOME(e)</span>
<span class="source-line-no">167</span><span id="line-167"> ) {</span>
<span class="source-line-no">168</span><span id="line-168"> RpcServer.LOG.info("{}: exiting on OutOfMemoryError", Thread.currentThread().getName());</span>
<span class="source-line-no">169</span><span id="line-169"> // exception intentionally swallowed</span>
<span class="source-line-no">170</span><span id="line-170"> } else {</span>
<span class="source-line-no">171</span><span id="line-171"> // rethrow if no handler</span>
<span class="source-line-no">172</span><span id="line-172"> throw e;</span>
<span class="source-line-no">173</span><span id="line-173"> }</span>
<span class="source-line-no">174</span><span id="line-174"> } catch (ClosedChannelException cce) {</span>
<span class="source-line-no">175</span><span id="line-175"> InetSocketAddress address = rpcServer.getListenerAddress();</span>
<span class="source-line-no">176</span><span id="line-176"> RpcServer.LOG.warn(</span>
<span class="source-line-no">177</span><span id="line-177"> "{}: caught a ClosedChannelException, " + "this means that the server "</span>
<span class="source-line-no">178</span><span id="line-178"> + (address != null ? address : "(channel closed)")</span>
<span class="source-line-no">179</span><span id="line-179"> + " was processing a request but the client went away. The error message was: {}",</span>
<span class="source-line-no">180</span><span id="line-180"> Thread.currentThread().getName(), cce.getMessage());</span>
<span class="source-line-no">181</span><span id="line-181"> TraceUtil.setError(span, cce);</span>
<span class="source-line-no">182</span><span id="line-182"> } catch (Exception e) {</span>
<span class="source-line-no">183</span><span id="line-183"> RpcServer.LOG.warn("{}: caught: {}", Thread.currentThread().getName(),</span>
<span class="source-line-no">184</span><span id="line-184"> StringUtils.stringifyException(e));</span>
<span class="source-line-no">185</span><span id="line-185"> TraceUtil.setError(span, e);</span>
<span class="source-line-no">186</span><span id="line-186"> } finally {</span>
<span class="source-line-no">187</span><span id="line-187"> if (!successful) {</span>
<span class="source-line-no">188</span><span id="line-188"> this.rpcServer.addCallSize(call.getSize() * -1);</span>
<span class="source-line-no">189</span><span id="line-189"> }</span>
<span class="source-line-no">190</span><span id="line-190"></span>
<span class="source-line-no">191</span><span id="line-191"> if (this.status.isRPCRunning()) {</span>
<span class="source-line-no">192</span><span id="line-192"> this.status.markComplete("Call error");</span>
<span class="source-line-no">193</span><span id="line-193"> }</span>
<span class="source-line-no">194</span><span id="line-194"> this.status.pause("Waiting for a call");</span>
<span class="source-line-no">195</span><span id="line-195"> cleanup();</span>
<span class="source-line-no">196</span><span id="line-196"> span.end();</span>
<span class="source-line-no">197</span><span id="line-197"> }</span>
<span class="source-line-no">198</span><span id="line-198"> }</span>
<span class="source-line-no">199</span><span id="line-199"></span>
<span class="source-line-no">200</span><span id="line-200"> /**</span>
<span class="source-line-no">201</span><span id="line-201"> * When we want to drop this call because of server is overloaded.</span>
<span class="source-line-no">202</span><span id="line-202"> */</span>
<span class="source-line-no">203</span><span id="line-203"> public void drop() {</span>
<span class="source-line-no">204</span><span id="line-204"> try (Scope ignored = span.makeCurrent()) {</span>
<span class="source-line-no">205</span><span id="line-205"> if (call.disconnectSince() &gt;= 0) {</span>
<span class="source-line-no">206</span><span id="line-206"> RpcServer.LOG.debug("{}: skipped {}", Thread.currentThread().getName(), call);</span>
<span class="source-line-no">207</span><span id="line-207"> span.addEvent("Client disconnect detected");</span>
<span class="source-line-no">208</span><span id="line-208"> span.setStatus(StatusCode.OK);</span>
<span class="source-line-no">209</span><span id="line-209"> return;</span>
<span class="source-line-no">210</span><span id="line-210"> }</span>
<span class="source-line-no">211</span><span id="line-211"></span>
<span class="source-line-no">212</span><span id="line-212"> // Set the response</span>
<span class="source-line-no">213</span><span id="line-213"> InetSocketAddress address = rpcServer.getListenerAddress();</span>
<span class="source-line-no">214</span><span id="line-214"> call.setResponse(null, null, CALL_DROPPED_EXCEPTION, "Call dropped, server "</span>
<span class="source-line-no">215</span><span id="line-215"> + (address != null ? address : "(channel closed)") + " is overloaded, please retry.");</span>
<span class="source-line-no">216</span><span id="line-216"> TraceUtil.setError(span, CALL_DROPPED_EXCEPTION);</span>
<span class="source-line-no">217</span><span id="line-217"> call.sendResponseIfReady();</span>
<span class="source-line-no">218</span><span id="line-218"> this.rpcServer.getMetrics().exception(CALL_DROPPED_EXCEPTION);</span>
<span class="source-line-no">219</span><span id="line-219"> } catch (ClosedChannelException cce) {</span>
<span class="source-line-no">220</span><span id="line-220"> InetSocketAddress address = rpcServer.getListenerAddress();</span>
<span class="source-line-no">221</span><span id="line-221"> RpcServer.LOG.warn(</span>
<span class="source-line-no">222</span><span id="line-222"> "{}: caught a ClosedChannelException, " + "this means that the server "</span>
<span class="source-line-no">223</span><span id="line-223"> + (address != null ? address : "(channel closed)")</span>
<span class="source-line-no">224</span><span id="line-224"> + " was processing a request but the client went away. The error message was: {}",</span>
<span class="source-line-no">225</span><span id="line-225"> Thread.currentThread().getName(), cce.getMessage());</span>
<span class="source-line-no">226</span><span id="line-226"> TraceUtil.setError(span, cce);</span>
<span class="source-line-no">227</span><span id="line-227"> } catch (Exception e) {</span>
<span class="source-line-no">228</span><span id="line-228"> RpcServer.LOG.warn("{}: caught: {}", Thread.currentThread().getName(),</span>
<span class="source-line-no">229</span><span id="line-229"> StringUtils.stringifyException(e));</span>
<span class="source-line-no">230</span><span id="line-230"> TraceUtil.setError(span, e);</span>
<span class="source-line-no">231</span><span id="line-231"> } finally {</span>
<span class="source-line-no">232</span><span id="line-232"> if (!successful) {</span>
<span class="source-line-no">233</span><span id="line-233"> this.rpcServer.addCallSize(call.getSize() * -1);</span>
<span class="source-line-no">234</span><span id="line-234"> }</span>
<span class="source-line-no">235</span><span id="line-235"> cleanup();</span>
<span class="source-line-no">236</span><span id="line-236"> span.end();</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>
</pre>
</div>
</main>
</body>
</html>