blob: e549650549d83ca9a4172a98094ee785941bd930 [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.client, class: AsyncRpcRetryingCaller">
<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.client;</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.hbase.client.ConnectionUtils.resetController;</span>
<span class="source-line-no">021</span><span id="line-21">import static org.apache.hadoop.hbase.client.ConnectionUtils.translateException;</span>
<span class="source-line-no">022</span><span id="line-22"></span>
<span class="source-line-no">023</span><span id="line-23">import java.util.ArrayList;</span>
<span class="source-line-no">024</span><span id="line-24">import java.util.List;</span>
<span class="source-line-no">025</span><span id="line-25">import java.util.Map;</span>
<span class="source-line-no">026</span><span id="line-26">import java.util.Optional;</span>
<span class="source-line-no">027</span><span id="line-27">import java.util.OptionalLong;</span>
<span class="source-line-no">028</span><span id="line-28">import java.util.concurrent.CompletableFuture;</span>
<span class="source-line-no">029</span><span id="line-29">import java.util.concurrent.TimeUnit;</span>
<span class="source-line-no">030</span><span id="line-30">import java.util.function.Consumer;</span>
<span class="source-line-no">031</span><span id="line-31">import java.util.function.Supplier;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.DoNotRetryIOException;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.HBaseServerException;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.NotServingRegionException;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.TableName;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.TableNotEnabledException;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.TableNotFoundException;</span>
<span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.client.backoff.HBaseServerExceptionPauseManager;</span>
<span class="source-line-no">039</span><span id="line-39">import org.apache.hadoop.hbase.exceptions.ScannerResetException;</span>
<span class="source-line-no">040</span><span id="line-40">import org.apache.hadoop.hbase.ipc.HBaseRpcController;</span>
<span class="source-line-no">041</span><span id="line-41">import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;</span>
<span class="source-line-no">042</span><span id="line-42">import org.apache.hadoop.hbase.util.FutureUtils;</span>
<span class="source-line-no">043</span><span id="line-43">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">044</span><span id="line-44">import org.slf4j.Logger;</span>
<span class="source-line-no">045</span><span id="line-45">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">046</span><span id="line-46"></span>
<span class="source-line-no">047</span><span id="line-47">import org.apache.hbase.thirdparty.io.netty.util.Timer;</span>
<span class="source-line-no">048</span><span id="line-48"></span>
<span class="source-line-no">049</span><span id="line-49">@InterfaceAudience.Private</span>
<span class="source-line-no">050</span><span id="line-50">public abstract class AsyncRpcRetryingCaller&lt;T&gt; {</span>
<span class="source-line-no">051</span><span id="line-51"></span>
<span class="source-line-no">052</span><span id="line-52"> private static final Logger LOG = LoggerFactory.getLogger(AsyncRpcRetryingCaller.class);</span>
<span class="source-line-no">053</span><span id="line-53"></span>
<span class="source-line-no">054</span><span id="line-54"> private final Timer retryTimer;</span>
<span class="source-line-no">055</span><span id="line-55"></span>
<span class="source-line-no">056</span><span id="line-56"> private final int priority;</span>
<span class="source-line-no">057</span><span id="line-57"></span>
<span class="source-line-no">058</span><span id="line-58"> private final long startNs;</span>
<span class="source-line-no">059</span><span id="line-59"></span>
<span class="source-line-no">060</span><span id="line-60"> private int tries = 1;</span>
<span class="source-line-no">061</span><span id="line-61"></span>
<span class="source-line-no">062</span><span id="line-62"> private final int maxAttempts;</span>
<span class="source-line-no">063</span><span id="line-63"></span>
<span class="source-line-no">064</span><span id="line-64"> private final int startLogErrorsCnt;</span>
<span class="source-line-no">065</span><span id="line-65"></span>
<span class="source-line-no">066</span><span id="line-66"> private final List&lt;RetriesExhaustedException.ThrowableWithExtraContext&gt; exceptions;</span>
<span class="source-line-no">067</span><span id="line-67"></span>
<span class="source-line-no">068</span><span id="line-68"> private final long rpcTimeoutNs;</span>
<span class="source-line-no">069</span><span id="line-69"></span>
<span class="source-line-no">070</span><span id="line-70"> protected final long operationTimeoutNs;</span>
<span class="source-line-no">071</span><span id="line-71"></span>
<span class="source-line-no">072</span><span id="line-72"> protected final AsyncConnectionImpl conn;</span>
<span class="source-line-no">073</span><span id="line-73"></span>
<span class="source-line-no">074</span><span id="line-74"> protected final CompletableFuture&lt;T&gt; future;</span>
<span class="source-line-no">075</span><span id="line-75"></span>
<span class="source-line-no">076</span><span id="line-76"> protected final HBaseRpcController controller;</span>
<span class="source-line-no">077</span><span id="line-77"></span>
<span class="source-line-no">078</span><span id="line-78"> private final HBaseServerExceptionPauseManager pauseManager;</span>
<span class="source-line-no">079</span><span id="line-79"></span>
<span class="source-line-no">080</span><span id="line-80"> public AsyncRpcRetryingCaller(Timer retryTimer, AsyncConnectionImpl conn, int priority,</span>
<span class="source-line-no">081</span><span id="line-81"> long pauseNs, long pauseNsForServerOverloaded, int maxAttempts, long operationTimeoutNs,</span>
<span class="source-line-no">082</span><span id="line-82"> long rpcTimeoutNs, int startLogErrorsCnt, Map&lt;String, byte[]&gt; requestAttributes) {</span>
<span class="source-line-no">083</span><span id="line-83"> this.retryTimer = retryTimer;</span>
<span class="source-line-no">084</span><span id="line-84"> this.conn = conn;</span>
<span class="source-line-no">085</span><span id="line-85"> this.priority = priority;</span>
<span class="source-line-no">086</span><span id="line-86"> this.maxAttempts = maxAttempts;</span>
<span class="source-line-no">087</span><span id="line-87"> this.operationTimeoutNs = operationTimeoutNs;</span>
<span class="source-line-no">088</span><span id="line-88"> this.rpcTimeoutNs = rpcTimeoutNs;</span>
<span class="source-line-no">089</span><span id="line-89"> this.startLogErrorsCnt = startLogErrorsCnt;</span>
<span class="source-line-no">090</span><span id="line-90"> this.future = new CompletableFuture&lt;&gt;();</span>
<span class="source-line-no">091</span><span id="line-91"> this.controller = conn.rpcControllerFactory.newController();</span>
<span class="source-line-no">092</span><span id="line-92"> this.controller.setPriority(priority);</span>
<span class="source-line-no">093</span><span id="line-93"> this.controller.setRequestAttributes(requestAttributes);</span>
<span class="source-line-no">094</span><span id="line-94"> this.exceptions = new ArrayList&lt;&gt;();</span>
<span class="source-line-no">095</span><span id="line-95"> this.startNs = System.nanoTime();</span>
<span class="source-line-no">096</span><span id="line-96"> this.pauseManager =</span>
<span class="source-line-no">097</span><span id="line-97"> new HBaseServerExceptionPauseManager(pauseNs, pauseNsForServerOverloaded, operationTimeoutNs);</span>
<span class="source-line-no">098</span><span id="line-98"> }</span>
<span class="source-line-no">099</span><span id="line-99"></span>
<span class="source-line-no">100</span><span id="line-100"> private long elapsedMs() {</span>
<span class="source-line-no">101</span><span id="line-101"> return TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - startNs);</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"> protected final long remainingTimeNs() {</span>
<span class="source-line-no">105</span><span id="line-105"> return pauseManager.remainingTimeNs(startNs);</span>
<span class="source-line-no">106</span><span id="line-106"> }</span>
<span class="source-line-no">107</span><span id="line-107"></span>
<span class="source-line-no">108</span><span id="line-108"> protected final void completeExceptionally() {</span>
<span class="source-line-no">109</span><span id="line-109"> future.completeExceptionally(new RetriesExhaustedException(tries - 1, exceptions));</span>
<span class="source-line-no">110</span><span id="line-110"> }</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 final void resetCallTimeout() {</span>
<span class="source-line-no">113</span><span id="line-113"> long callTimeoutNs;</span>
<span class="source-line-no">114</span><span id="line-114"> if (operationTimeoutNs &gt; 0) {</span>
<span class="source-line-no">115</span><span id="line-115"> callTimeoutNs = remainingTimeNs();</span>
<span class="source-line-no">116</span><span id="line-116"> if (callTimeoutNs &lt;= 0) {</span>
<span class="source-line-no">117</span><span id="line-117"> completeExceptionally();</span>
<span class="source-line-no">118</span><span id="line-118"> return;</span>
<span class="source-line-no">119</span><span id="line-119"> }</span>
<span class="source-line-no">120</span><span id="line-120"> callTimeoutNs = Math.min(callTimeoutNs, rpcTimeoutNs);</span>
<span class="source-line-no">121</span><span id="line-121"> } else {</span>
<span class="source-line-no">122</span><span id="line-122"> callTimeoutNs = rpcTimeoutNs;</span>
<span class="source-line-no">123</span><span id="line-123"> }</span>
<span class="source-line-no">124</span><span id="line-124"> resetController(controller, callTimeoutNs, priority, getTableName().orElse(null));</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"> private void tryScheduleRetry(Throwable error) {</span>
<span class="source-line-no">128</span><span id="line-128"> OptionalLong maybePauseNsToUse = pauseManager.getPauseNsFromException(error, tries, startNs);</span>
<span class="source-line-no">129</span><span id="line-129"> if (!maybePauseNsToUse.isPresent()) {</span>
<span class="source-line-no">130</span><span id="line-130"> completeExceptionally();</span>
<span class="source-line-no">131</span><span id="line-131"> return;</span>
<span class="source-line-no">132</span><span id="line-132"> }</span>
<span class="source-line-no">133</span><span id="line-133"> long delayNs = maybePauseNsToUse.getAsLong();</span>
<span class="source-line-no">134</span><span id="line-134"> tries++;</span>
<span class="source-line-no">135</span><span id="line-135"> if (HBaseServerException.isServerOverloaded(error)) {</span>
<span class="source-line-no">136</span><span id="line-136"> Optional&lt;MetricsConnection&gt; metrics = conn.getConnectionMetrics();</span>
<span class="source-line-no">137</span><span id="line-137"> metrics.ifPresent(m -&gt; m.incrementServerOverloadedBackoffTime(delayNs, TimeUnit.NANOSECONDS));</span>
<span class="source-line-no">138</span><span id="line-138"> }</span>
<span class="source-line-no">139</span><span id="line-139"> retryTimer.newTimeout(t -&gt; doCall(), delayNs, TimeUnit.NANOSECONDS);</span>
<span class="source-line-no">140</span><span id="line-140"> }</span>
<span class="source-line-no">141</span><span id="line-141"></span>
<span class="source-line-no">142</span><span id="line-142"> protected Optional&lt;TableName&gt; getTableName() {</span>
<span class="source-line-no">143</span><span id="line-143"> return Optional.empty();</span>
<span class="source-line-no">144</span><span id="line-144"> }</span>
<span class="source-line-no">145</span><span id="line-145"></span>
<span class="source-line-no">146</span><span id="line-146"> // Sub classes can override this method to change the error type, to control the retry logic.</span>
<span class="source-line-no">147</span><span id="line-147"> // For example, during rolling upgrading, if we call this newly added method, we will get a</span>
<span class="source-line-no">148</span><span id="line-148"> // UnsupportedOperationException(wrapped by a DNRIOE), and sometimes we may want to fallback to</span>
<span class="source-line-no">149</span><span id="line-149"> // use the old method first, so the sub class could change the exception type to something not a</span>
<span class="source-line-no">150</span><span id="line-150"> // DNRIOE, so we will schedule a retry, and the next time the sub class could use old method to</span>
<span class="source-line-no">151</span><span id="line-151"> // make the rpc call.</span>
<span class="source-line-no">152</span><span id="line-152"> protected Throwable preProcessError(Throwable error) {</span>
<span class="source-line-no">153</span><span id="line-153"> return error;</span>
<span class="source-line-no">154</span><span id="line-154"> }</span>
<span class="source-line-no">155</span><span id="line-155"></span>
<span class="source-line-no">156</span><span id="line-156"> protected final void onError(Throwable t, Supplier&lt;String&gt; errMsg,</span>
<span class="source-line-no">157</span><span id="line-157"> Consumer&lt;Throwable&gt; updateCachedLocation) {</span>
<span class="source-line-no">158</span><span id="line-158"> if (future.isDone()) {</span>
<span class="source-line-no">159</span><span id="line-159"> // Give up if the future is already done, this is possible if user has already canceled the</span>
<span class="source-line-no">160</span><span id="line-160"> // future. And for timeline consistent read, we will also cancel some requests if we have</span>
<span class="source-line-no">161</span><span id="line-161"> // already get one of the responses.</span>
<span class="source-line-no">162</span><span id="line-162"> LOG.debug("The future is already done, canceled={}, give up retrying", future.isCancelled());</span>
<span class="source-line-no">163</span><span id="line-163"> return;</span>
<span class="source-line-no">164</span><span id="line-164"> }</span>
<span class="source-line-no">165</span><span id="line-165"> Throwable error = preProcessError(translateException(t));</span>
<span class="source-line-no">166</span><span id="line-166"> // We use this retrying caller to open a scanner, as it is idempotent, but we may throw</span>
<span class="source-line-no">167</span><span id="line-167"> // ScannerResetException, which is a DoNotRetryIOException when opening a scanner as now we will</span>
<span class="source-line-no">168</span><span id="line-168"> // also fetch data when opening a scanner. The intention here is that if we hit a</span>
<span class="source-line-no">169</span><span id="line-169"> // ScannerResetException when scanning then we should try to open a new scanner, instead of</span>
<span class="source-line-no">170</span><span id="line-170"> // retrying on the old one, so it is declared as a DoNotRetryIOException. But here we are</span>
<span class="source-line-no">171</span><span id="line-171"> // exactly trying to open a new scanner, so we should retry on ScannerResetException.</span>
<span class="source-line-no">172</span><span id="line-172"> if (error instanceof DoNotRetryIOException &amp;&amp; !(error instanceof ScannerResetException)) {</span>
<span class="source-line-no">173</span><span id="line-173"> future.completeExceptionally(error);</span>
<span class="source-line-no">174</span><span id="line-174"> return;</span>
<span class="source-line-no">175</span><span id="line-175"> }</span>
<span class="source-line-no">176</span><span id="line-176"> if (tries &gt; startLogErrorsCnt) {</span>
<span class="source-line-no">177</span><span id="line-177"> LOG.warn(errMsg.get() + ", tries = " + tries + ", maxAttempts = " + maxAttempts</span>
<span class="source-line-no">178</span><span id="line-178"> + ", timeout = " + TimeUnit.NANOSECONDS.toMillis(operationTimeoutNs)</span>
<span class="source-line-no">179</span><span id="line-179"> + " ms, time elapsed = " + elapsedMs() + " ms", error);</span>
<span class="source-line-no">180</span><span id="line-180"> }</span>
<span class="source-line-no">181</span><span id="line-181"> updateCachedLocation.accept(error);</span>
<span class="source-line-no">182</span><span id="line-182"> RetriesExhaustedException.ThrowableWithExtraContext qt =</span>
<span class="source-line-no">183</span><span id="line-183"> new RetriesExhaustedException.ThrowableWithExtraContext(error,</span>
<span class="source-line-no">184</span><span id="line-184"> EnvironmentEdgeManager.currentTime(), "");</span>
<span class="source-line-no">185</span><span id="line-185"> exceptions.add(qt);</span>
<span class="source-line-no">186</span><span id="line-186"> if (tries &gt;= maxAttempts) {</span>
<span class="source-line-no">187</span><span id="line-187"> completeExceptionally();</span>
<span class="source-line-no">188</span><span id="line-188"> return;</span>
<span class="source-line-no">189</span><span id="line-189"> }</span>
<span class="source-line-no">190</span><span id="line-190"> // check whether the table has been disabled, notice that the check will introduce a request to</span>
<span class="source-line-no">191</span><span id="line-191"> // meta, so here we only check for disabled for some specific exception types.</span>
<span class="source-line-no">192</span><span id="line-192"> if (error instanceof NotServingRegionException || error instanceof RegionOfflineException) {</span>
<span class="source-line-no">193</span><span id="line-193"> Optional&lt;TableName&gt; tableName = getTableName();</span>
<span class="source-line-no">194</span><span id="line-194"> if (tableName.isPresent()) {</span>
<span class="source-line-no">195</span><span id="line-195"> FutureUtils.addListener(conn.getAdmin().isTableDisabled(tableName.get()), (disabled, e) -&gt; {</span>
<span class="source-line-no">196</span><span id="line-196"> if (e != null) {</span>
<span class="source-line-no">197</span><span id="line-197"> if (e instanceof TableNotFoundException) {</span>
<span class="source-line-no">198</span><span id="line-198"> future.completeExceptionally(e);</span>
<span class="source-line-no">199</span><span id="line-199"> } else {</span>
<span class="source-line-no">200</span><span id="line-200"> // failed to test whether the table is disabled, not a big deal, continue retrying</span>
<span class="source-line-no">201</span><span id="line-201"> tryScheduleRetry(error);</span>
<span class="source-line-no">202</span><span id="line-202"> }</span>
<span class="source-line-no">203</span><span id="line-203"> return;</span>
<span class="source-line-no">204</span><span id="line-204"> }</span>
<span class="source-line-no">205</span><span id="line-205"> if (disabled) {</span>
<span class="source-line-no">206</span><span id="line-206"> future.completeExceptionally(new TableNotEnabledException(tableName.get()));</span>
<span class="source-line-no">207</span><span id="line-207"> } else {</span>
<span class="source-line-no">208</span><span id="line-208"> tryScheduleRetry(error);</span>
<span class="source-line-no">209</span><span id="line-209"> }</span>
<span class="source-line-no">210</span><span id="line-210"> });</span>
<span class="source-line-no">211</span><span id="line-211"> } else {</span>
<span class="source-line-no">212</span><span id="line-212"> tryScheduleRetry(error);</span>
<span class="source-line-no">213</span><span id="line-213"> }</span>
<span class="source-line-no">214</span><span id="line-214"> } else {</span>
<span class="source-line-no">215</span><span id="line-215"> tryScheduleRetry(error);</span>
<span class="source-line-no">216</span><span id="line-216"> }</span>
<span class="source-line-no">217</span><span id="line-217"> }</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 abstract void doCall();</span>
<span class="source-line-no">220</span><span id="line-220"></span>
<span class="source-line-no">221</span><span id="line-221"> CompletableFuture&lt;T&gt; call() {</span>
<span class="source-line-no">222</span><span id="line-222"> doCall();</span>
<span class="source-line-no">223</span><span id="line-223"> return future;</span>
<span class="source-line-no">224</span><span id="line-224"> }</span>
<span class="source-line-no">225</span><span id="line-225">}</span>
</pre>
</div>
</main>
</body>
</html>