| <!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: AsyncScanSingleRegionRpcRetryingCaller, enum: ScanResumerState"> |
| <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.incRPCCallsMetrics;</span> |
| <span class="source-line-no">021</span><span id="line-21">import static org.apache.hadoop.hbase.client.ConnectionUtils.incRPCRetriesMetrics;</span> |
| <span class="source-line-no">022</span><span id="line-22">import static org.apache.hadoop.hbase.client.ConnectionUtils.noMoreResultsForReverseScan;</span> |
| <span class="source-line-no">023</span><span id="line-23">import static org.apache.hadoop.hbase.client.ConnectionUtils.noMoreResultsForScan;</span> |
| <span class="source-line-no">024</span><span id="line-24">import static org.apache.hadoop.hbase.client.ConnectionUtils.resetController;</span> |
| <span class="source-line-no">025</span><span id="line-25">import static org.apache.hadoop.hbase.client.ConnectionUtils.translateException;</span> |
| <span class="source-line-no">026</span><span id="line-26">import static org.apache.hadoop.hbase.client.ConnectionUtils.updateResultsMetrics;</span> |
| <span class="source-line-no">027</span><span id="line-27">import static org.apache.hadoop.hbase.client.ConnectionUtils.updateServerSideMetrics;</span> |
| <span class="source-line-no">028</span><span id="line-28"></span> |
| <span class="source-line-no">029</span><span id="line-29">import io.opentelemetry.context.Context;</span> |
| <span class="source-line-no">030</span><span id="line-30">import io.opentelemetry.context.Scope;</span> |
| <span class="source-line-no">031</span><span id="line-31">import java.io.IOException;</span> |
| <span class="source-line-no">032</span><span id="line-32">import java.util.ArrayList;</span> |
| <span class="source-line-no">033</span><span id="line-33">import java.util.List;</span> |
| <span class="source-line-no">034</span><span id="line-34">import java.util.Map;</span> |
| <span class="source-line-no">035</span><span id="line-35">import java.util.Optional;</span> |
| <span class="source-line-no">036</span><span id="line-36">import java.util.OptionalLong;</span> |
| <span class="source-line-no">037</span><span id="line-37">import java.util.concurrent.CompletableFuture;</span> |
| <span class="source-line-no">038</span><span id="line-38">import java.util.concurrent.TimeUnit;</span> |
| <span class="source-line-no">039</span><span id="line-39">import org.apache.hadoop.hbase.DoNotRetryIOException;</span> |
| <span class="source-line-no">040</span><span id="line-40">import org.apache.hadoop.hbase.HBaseServerException;</span> |
| <span class="source-line-no">041</span><span id="line-41">import org.apache.hadoop.hbase.HConstants;</span> |
| <span class="source-line-no">042</span><span id="line-42">import org.apache.hadoop.hbase.HRegionLocation;</span> |
| <span class="source-line-no">043</span><span id="line-43">import org.apache.hadoop.hbase.NotServingRegionException;</span> |
| <span class="source-line-no">044</span><span id="line-44">import org.apache.hadoop.hbase.UnknownScannerException;</span> |
| <span class="source-line-no">045</span><span id="line-45">import org.apache.hadoop.hbase.client.AdvancedScanResultConsumer.ScanResumer;</span> |
| <span class="source-line-no">046</span><span id="line-46">import org.apache.hadoop.hbase.client.backoff.HBaseServerExceptionPauseManager;</span> |
| <span class="source-line-no">047</span><span id="line-47">import org.apache.hadoop.hbase.client.metrics.ScanMetrics;</span> |
| <span class="source-line-no">048</span><span id="line-48">import org.apache.hadoop.hbase.exceptions.OutOfOrderScannerNextException;</span> |
| <span class="source-line-no">049</span><span id="line-49">import org.apache.hadoop.hbase.exceptions.ScannerResetException;</span> |
| <span class="source-line-no">050</span><span id="line-50">import org.apache.hadoop.hbase.ipc.HBaseRpcController;</span> |
| <span class="source-line-no">051</span><span id="line-51">import org.apache.hadoop.hbase.regionserver.RegionServerStoppedException;</span> |
| <span class="source-line-no">052</span><span id="line-52">import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;</span> |
| <span class="source-line-no">053</span><span id="line-53">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">054</span><span id="line-54">import org.slf4j.Logger;</span> |
| <span class="source-line-no">055</span><span id="line-55">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">056</span><span id="line-56"></span> |
| <span class="source-line-no">057</span><span id="line-57">import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;</span> |
| <span class="source-line-no">058</span><span id="line-58">import org.apache.hbase.thirdparty.io.netty.util.Timeout;</span> |
| <span class="source-line-no">059</span><span id="line-59">import org.apache.hbase.thirdparty.io.netty.util.Timer;</span> |
| <span class="source-line-no">060</span><span id="line-60"></span> |
| <span class="source-line-no">061</span><span id="line-61">import org.apache.hadoop.hbase.shaded.protobuf.ProtobufUtil;</span> |
| <span class="source-line-no">062</span><span id="line-62">import org.apache.hadoop.hbase.shaded.protobuf.RequestConverter;</span> |
| <span class="source-line-no">063</span><span id="line-63">import org.apache.hadoop.hbase.shaded.protobuf.ResponseConverter;</span> |
| <span class="source-line-no">064</span><span id="line-64">import org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ClientService;</span> |
| <span class="source-line-no">065</span><span id="line-65">import org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ClientService.Interface;</span> |
| <span class="source-line-no">066</span><span id="line-66">import org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ScanRequest;</span> |
| <span class="source-line-no">067</span><span id="line-67">import org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ScanResponse;</span> |
| <span class="source-line-no">068</span><span id="line-68"></span> |
| <span class="source-line-no">069</span><span id="line-69">/**</span> |
| <span class="source-line-no">070</span><span id="line-70"> * Retry caller for scanning a region.</span> |
| <span class="source-line-no">071</span><span id="line-71"> * <p></span> |
| <span class="source-line-no">072</span><span id="line-72"> * We will modify the {@link Scan} object passed in directly. The upper layer should store the</span> |
| <span class="source-line-no">073</span><span id="line-73"> * reference of this object and use it to open new single region scanners.</span> |
| <span class="source-line-no">074</span><span id="line-74"> */</span> |
| <span class="source-line-no">075</span><span id="line-75">@InterfaceAudience.Private</span> |
| <span class="source-line-no">076</span><span id="line-76">class AsyncScanSingleRegionRpcRetryingCaller {</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 static final Logger LOG =</span> |
| <span class="source-line-no">079</span><span id="line-79"> LoggerFactory.getLogger(AsyncScanSingleRegionRpcRetryingCaller.class);</span> |
| <span class="source-line-no">080</span><span id="line-80"></span> |
| <span class="source-line-no">081</span><span id="line-81"> private final Timer retryTimer;</span> |
| <span class="source-line-no">082</span><span id="line-82"></span> |
| <span class="source-line-no">083</span><span id="line-83"> private final Scan scan;</span> |
| <span class="source-line-no">084</span><span id="line-84"></span> |
| <span class="source-line-no">085</span><span id="line-85"> private final ScanMetrics scanMetrics;</span> |
| <span class="source-line-no">086</span><span id="line-86"></span> |
| <span class="source-line-no">087</span><span id="line-87"> private final long scannerId;</span> |
| <span class="source-line-no">088</span><span id="line-88"></span> |
| <span class="source-line-no">089</span><span id="line-89"> private final ScanResultCache resultCache;</span> |
| <span class="source-line-no">090</span><span id="line-90"></span> |
| <span class="source-line-no">091</span><span id="line-91"> private final AdvancedScanResultConsumer consumer;</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 final ClientService.Interface stub;</span> |
| <span class="source-line-no">094</span><span id="line-94"></span> |
| <span class="source-line-no">095</span><span id="line-95"> private final HRegionLocation loc;</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 regionServerRemote;</span> |
| <span class="source-line-no">098</span><span id="line-98"></span> |
| <span class="source-line-no">099</span><span id="line-99"> private final int priority;</span> |
| <span class="source-line-no">100</span><span id="line-100"></span> |
| <span class="source-line-no">101</span><span id="line-101"> private final long scannerLeaseTimeoutPeriodNs;</span> |
| <span class="source-line-no">102</span><span id="line-102"></span> |
| <span class="source-line-no">103</span><span id="line-103"> private final int maxAttempts;</span> |
| <span class="source-line-no">104</span><span id="line-104"></span> |
| <span class="source-line-no">105</span><span id="line-105"> private final long scanTimeoutNs;</span> |
| <span class="source-line-no">106</span><span id="line-106"></span> |
| <span class="source-line-no">107</span><span id="line-107"> private final long rpcTimeoutNs;</span> |
| <span class="source-line-no">108</span><span id="line-108"></span> |
| <span class="source-line-no">109</span><span id="line-109"> private final int startLogErrorsCnt;</span> |
| <span class="source-line-no">110</span><span id="line-110"></span> |
| <span class="source-line-no">111</span><span id="line-111"> private final Runnable completeWhenNoMoreResultsInRegion;</span> |
| <span class="source-line-no">112</span><span id="line-112"></span> |
| <span class="source-line-no">113</span><span id="line-113"> private final AsyncConnectionImpl conn;</span> |
| <span class="source-line-no">114</span><span id="line-114"></span> |
| <span class="source-line-no">115</span><span id="line-115"> private final CompletableFuture<Boolean> future;</span> |
| <span class="source-line-no">116</span><span id="line-116"></span> |
| <span class="source-line-no">117</span><span id="line-117"> private final HBaseRpcController controller;</span> |
| <span class="source-line-no">118</span><span id="line-118"></span> |
| <span class="source-line-no">119</span><span id="line-119"> private byte[] nextStartRowWhenError;</span> |
| <span class="source-line-no">120</span><span id="line-120"></span> |
| <span class="source-line-no">121</span><span id="line-121"> private boolean includeNextStartRowWhenError;</span> |
| <span class="source-line-no">122</span><span id="line-122"></span> |
| <span class="source-line-no">123</span><span id="line-123"> private long nextCallStartNs;</span> |
| <span class="source-line-no">124</span><span id="line-124"></span> |
| <span class="source-line-no">125</span><span id="line-125"> private int tries;</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 final List<RetriesExhaustedException.ThrowableWithExtraContext> exceptions;</span> |
| <span class="source-line-no">128</span><span id="line-128"></span> |
| <span class="source-line-no">129</span><span id="line-129"> private long nextCallSeq = -1L;</span> |
| <span class="source-line-no">130</span><span id="line-130"></span> |
| <span class="source-line-no">131</span><span id="line-131"> private final HBaseServerExceptionPauseManager pauseManager;</span> |
| <span class="source-line-no">132</span><span id="line-132"></span> |
| <span class="source-line-no">133</span><span id="line-133"> private enum ScanControllerState {</span> |
| <span class="source-line-no">134</span><span id="line-134"> INITIALIZED,</span> |
| <span class="source-line-no">135</span><span id="line-135"> SUSPENDED,</span> |
| <span class="source-line-no">136</span><span id="line-136"> TERMINATED,</span> |
| <span class="source-line-no">137</span><span id="line-137"> DESTROYED</span> |
| <span class="source-line-no">138</span><span id="line-138"> }</span> |
| <span class="source-line-no">139</span><span id="line-139"></span> |
| <span class="source-line-no">140</span><span id="line-140"> // Since suspend and terminate should only be called within onNext or onHeartbeat(see the comments</span> |
| <span class="source-line-no">141</span><span id="line-141"> // of RawScanResultConsumer.onNext and onHeartbeat), we need to add some check to prevent invalid</span> |
| <span class="source-line-no">142</span><span id="line-142"> // usage. We use two things to prevent invalid usage:</span> |
| <span class="source-line-no">143</span><span id="line-143"> // 1. Record the thread that construct the ScanControllerImpl instance. We will throw an</span> |
| <span class="source-line-no">144</span><span id="line-144"> // IllegalStateException if the caller thread is not this thread.</span> |
| <span class="source-line-no">145</span><span id="line-145"> // 2. The ControllerState. The initial state is INITIALIZED, if you call suspend, the state will</span> |
| <span class="source-line-no">146</span><span id="line-146"> // be transformed to SUSPENDED, and if you call terminate, the state will be transformed to</span> |
| <span class="source-line-no">147</span><span id="line-147"> // TERMINATED. And when we are back from onNext or onHeartbeat in the onComplete method, we will</span> |
| <span class="source-line-no">148</span><span id="line-148"> // call destroy to get the current state and set the state to DESTROYED. And when user calls</span> |
| <span class="source-line-no">149</span><span id="line-149"> // suspend or terminate, we will check if the current state is INITIALIZED, if not we will throw</span> |
| <span class="source-line-no">150</span><span id="line-150"> // an IllegalStateException. Notice that the DESTROYED state is necessary as you may not call</span> |
| <span class="source-line-no">151</span><span id="line-151"> // suspend or terminate so the state will still be INITIALIZED when back from onNext or</span> |
| <span class="source-line-no">152</span><span id="line-152"> // onHeartbeat. We need another state to replace the INITIALIZED state to prevent the controller</span> |
| <span class="source-line-no">153</span><span id="line-153"> // to be used in the future.</span> |
| <span class="source-line-no">154</span><span id="line-154"> // Notice that, the public methods of this class is supposed to be called by upper layer only, and</span> |
| <span class="source-line-no">155</span><span id="line-155"> // package private methods can only be called within the implementation of</span> |
| <span class="source-line-no">156</span><span id="line-156"> // AsyncScanSingleRegionRpcRetryingCaller.</span> |
| <span class="source-line-no">157</span><span id="line-157"> private final class ScanControllerImpl implements AdvancedScanResultConsumer.ScanController {</span> |
| <span class="source-line-no">158</span><span id="line-158"></span> |
| <span class="source-line-no">159</span><span id="line-159"> // Make sure the methods are only called in this thread.</span> |
| <span class="source-line-no">160</span><span id="line-160"> private final Thread callerThread;</span> |
| <span class="source-line-no">161</span><span id="line-161"></span> |
| <span class="source-line-no">162</span><span id="line-162"> private final Optional<Cursor> cursor;</span> |
| <span class="source-line-no">163</span><span id="line-163"></span> |
| <span class="source-line-no">164</span><span id="line-164"> // INITIALIZED -> SUSPENDED -> DESTROYED</span> |
| <span class="source-line-no">165</span><span id="line-165"> // INITIALIZED -> TERMINATED -> DESTROYED</span> |
| <span class="source-line-no">166</span><span id="line-166"> // INITIALIZED -> DESTROYED</span> |
| <span class="source-line-no">167</span><span id="line-167"> // If the state is incorrect we will throw IllegalStateException.</span> |
| <span class="source-line-no">168</span><span id="line-168"> private ScanControllerState state = ScanControllerState.INITIALIZED;</span> |
| <span class="source-line-no">169</span><span id="line-169"></span> |
| <span class="source-line-no">170</span><span id="line-170"> private ScanResumerImpl resumer;</span> |
| <span class="source-line-no">171</span><span id="line-171"></span> |
| <span class="source-line-no">172</span><span id="line-172"> public ScanControllerImpl(Optional<Cursor> cursor) {</span> |
| <span class="source-line-no">173</span><span id="line-173"> this.callerThread = Thread.currentThread();</span> |
| <span class="source-line-no">174</span><span id="line-174"> this.cursor = cursor;</span> |
| <span class="source-line-no">175</span><span id="line-175"> }</span> |
| <span class="source-line-no">176</span><span id="line-176"></span> |
| <span class="source-line-no">177</span><span id="line-177"> private void preCheck() {</span> |
| <span class="source-line-no">178</span><span id="line-178"> Preconditions.checkState(Thread.currentThread() == callerThread,</span> |
| <span class="source-line-no">179</span><span id="line-179"> "The current thread is %s, expected thread is %s, "</span> |
| <span class="source-line-no">180</span><span id="line-180"> + "you should not call this method outside onNext or onHeartbeat",</span> |
| <span class="source-line-no">181</span><span id="line-181"> Thread.currentThread(), callerThread);</span> |
| <span class="source-line-no">182</span><span id="line-182"> Preconditions.checkState(state.equals(ScanControllerState.INITIALIZED),</span> |
| <span class="source-line-no">183</span><span id="line-183"> "Invalid Stopper state %s", state);</span> |
| <span class="source-line-no">184</span><span id="line-184"> }</span> |
| <span class="source-line-no">185</span><span id="line-185"></span> |
| <span class="source-line-no">186</span><span id="line-186"> @Override</span> |
| <span class="source-line-no">187</span><span id="line-187"> public ScanResumer suspend() {</span> |
| <span class="source-line-no">188</span><span id="line-188"> preCheck();</span> |
| <span class="source-line-no">189</span><span id="line-189"> state = ScanControllerState.SUSPENDED;</span> |
| <span class="source-line-no">190</span><span id="line-190"> ScanResumerImpl resumer = new ScanResumerImpl();</span> |
| <span class="source-line-no">191</span><span id="line-191"> this.resumer = resumer;</span> |
| <span class="source-line-no">192</span><span id="line-192"> return resumer;</span> |
| <span class="source-line-no">193</span><span id="line-193"> }</span> |
| <span class="source-line-no">194</span><span id="line-194"></span> |
| <span class="source-line-no">195</span><span id="line-195"> @Override</span> |
| <span class="source-line-no">196</span><span id="line-196"> public void terminate() {</span> |
| <span class="source-line-no">197</span><span id="line-197"> preCheck();</span> |
| <span class="source-line-no">198</span><span id="line-198"> state = ScanControllerState.TERMINATED;</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"> // return the current state, and set the state to DESTROYED.</span> |
| <span class="source-line-no">202</span><span id="line-202"> ScanControllerState destroy() {</span> |
| <span class="source-line-no">203</span><span id="line-203"> ScanControllerState state = this.state;</span> |
| <span class="source-line-no">204</span><span id="line-204"> this.state = ScanControllerState.DESTROYED;</span> |
| <span class="source-line-no">205</span><span id="line-205"> return state;</span> |
| <span class="source-line-no">206</span><span id="line-206"> }</span> |
| <span class="source-line-no">207</span><span id="line-207"></span> |
| <span class="source-line-no">208</span><span id="line-208"> @Override</span> |
| <span class="source-line-no">209</span><span id="line-209"> public Optional<Cursor> cursor() {</span> |
| <span class="source-line-no">210</span><span id="line-210"> return cursor;</span> |
| <span class="source-line-no">211</span><span id="line-211"> }</span> |
| <span class="source-line-no">212</span><span id="line-212"> }</span> |
| <span class="source-line-no">213</span><span id="line-213"></span> |
| <span class="source-line-no">214</span><span id="line-214"> private enum ScanResumerState {</span> |
| <span class="source-line-no">215</span><span id="line-215"> INITIALIZED,</span> |
| <span class="source-line-no">216</span><span id="line-216"> SUSPENDED,</span> |
| <span class="source-line-no">217</span><span id="line-217"> RESUMED</span> |
| <span class="source-line-no">218</span><span id="line-218"> }</span> |
| <span class="source-line-no">219</span><span id="line-219"></span> |
| <span class="source-line-no">220</span><span id="line-220"> // The resume method is allowed to be called in another thread so here we also use the</span> |
| <span class="source-line-no">221</span><span id="line-221"> // ResumerState to prevent race. The initial state is INITIALIZED, and in most cases, when back</span> |
| <span class="source-line-no">222</span><span id="line-222"> // from onNext or onHeartbeat, we will call the prepare method to change the state to SUSPENDED,</span> |
| <span class="source-line-no">223</span><span id="line-223"> // and when user calls resume method, we will change the state to RESUMED. But the resume method</span> |
| <span class="source-line-no">224</span><span id="line-224"> // could be called in other thread, and in fact, user could just do this:</span> |
| <span class="source-line-no">225</span><span id="line-225"> // controller.suspend().resume()</span> |
| <span class="source-line-no">226</span><span id="line-226"> // This is strange but valid. This means the scan could be resumed before we call the prepare</span> |
| <span class="source-line-no">227</span><span id="line-227"> // method to do the actual suspend work. So in the resume method, we will check if the state is</span> |
| <span class="source-line-no">228</span><span id="line-228"> // INTIALIZED, if it is, then we will just set the state to RESUMED and return. And in prepare</span> |
| <span class="source-line-no">229</span><span id="line-229"> // method, if the state is RESUMED already, we will just return an let the scan go on.</span> |
| <span class="source-line-no">230</span><span id="line-230"> // Notice that, the public methods of this class is supposed to be called by upper layer only, and</span> |
| <span class="source-line-no">231</span><span id="line-231"> // package private methods can only be called within the implementation of</span> |
| <span class="source-line-no">232</span><span id="line-232"> // AsyncScanSingleRegionRpcRetryingCaller.</span> |
| <span class="source-line-no">233</span><span id="line-233"> @InterfaceAudience.Private</span> |
| <span class="source-line-no">234</span><span id="line-234"> final class ScanResumerImpl implements AdvancedScanResultConsumer.ScanResumer {</span> |
| <span class="source-line-no">235</span><span id="line-235"></span> |
| <span class="source-line-no">236</span><span id="line-236"> // INITIALIZED -> SUSPENDED -> RESUMED</span> |
| <span class="source-line-no">237</span><span id="line-237"> // INITIALIZED -> RESUMED</span> |
| <span class="source-line-no">238</span><span id="line-238"> private ScanResumerState state = ScanResumerState.INITIALIZED;</span> |
| <span class="source-line-no">239</span><span id="line-239"></span> |
| <span class="source-line-no">240</span><span id="line-240"> private ScanResponse resp;</span> |
| <span class="source-line-no">241</span><span id="line-241"></span> |
| <span class="source-line-no">242</span><span id="line-242"> private int numberOfCompleteRows;</span> |
| <span class="source-line-no">243</span><span id="line-243"></span> |
| <span class="source-line-no">244</span><span id="line-244"> // If the scan is suspended successfully, we need to do lease renewal to prevent it being closed</span> |
| <span class="source-line-no">245</span><span id="line-245"> // by RS due to lease expire. It is a one-time timer task so we need to schedule a new task</span> |
| <span class="source-line-no">246</span><span id="line-246"> // every time when the previous task is finished. There could also be race as the renewal is</span> |
| <span class="source-line-no">247</span><span id="line-247"> // executed in the timer thread, so we also need to check the state before lease renewal. If the</span> |
| <span class="source-line-no">248</span><span id="line-248"> // state is RESUMED already, we will give up lease renewal and also not schedule the next lease</span> |
| <span class="source-line-no">249</span><span id="line-249"> // renewal task.</span> |
| <span class="source-line-no">250</span><span id="line-250"> private Timeout leaseRenewer;</span> |
| <span class="source-line-no">251</span><span id="line-251"></span> |
| <span class="source-line-no">252</span><span id="line-252"> @Override</span> |
| <span class="source-line-no">253</span><span id="line-253"> public void resume() {</span> |
| <span class="source-line-no">254</span><span id="line-254"> doResume(false);</span> |
| <span class="source-line-no">255</span><span id="line-255"> }</span> |
| <span class="source-line-no">256</span><span id="line-256"></span> |
| <span class="source-line-no">257</span><span id="line-257"> /**</span> |
| <span class="source-line-no">258</span><span id="line-258"> * This method is used when {@link ScanControllerImpl#suspend} had ever been called to get a</span> |
| <span class="source-line-no">259</span><span id="line-259"> * {@link ScanResumerImpl}, but now user stops scan and does not need any more scan results.</span> |
| <span class="source-line-no">260</span><span id="line-260"> */</span> |
| <span class="source-line-no">261</span><span id="line-261"> public void terminate() {</span> |
| <span class="source-line-no">262</span><span id="line-262"> doResume(true);</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"> private void doResume(boolean stopScan) {</span> |
| <span class="source-line-no">266</span><span id="line-266"> // just used to fix findbugs warnings. In fact, if resume is called before prepare, then we</span> |
| <span class="source-line-no">267</span><span id="line-267"> // just return at the first if condition without loading the resp and numValidResuls field. If</span> |
| <span class="source-line-no">268</span><span id="line-268"> // resume is called after suspend, then it is also safe to just reference resp and</span> |
| <span class="source-line-no">269</span><span id="line-269"> // numValidResults after the synchronized block as no one will change it anymore.</span> |
| <span class="source-line-no">270</span><span id="line-270"> ScanResponse localResp;</span> |
| <span class="source-line-no">271</span><span id="line-271"> int localNumberOfCompleteRows;</span> |
| <span class="source-line-no">272</span><span id="line-272"> synchronized (this) {</span> |
| <span class="source-line-no">273</span><span id="line-273"> if (state == ScanResumerState.INITIALIZED) {</span> |
| <span class="source-line-no">274</span><span id="line-274"> // user calls this method before we call prepare, so just set the state to</span> |
| <span class="source-line-no">275</span><span id="line-275"> // RESUMED, the implementation will just go on.</span> |
| <span class="source-line-no">276</span><span id="line-276"> state = ScanResumerState.RESUMED;</span> |
| <span class="source-line-no">277</span><span id="line-277"> return;</span> |
| <span class="source-line-no">278</span><span id="line-278"> }</span> |
| <span class="source-line-no">279</span><span id="line-279"> if (state == ScanResumerState.RESUMED) {</span> |
| <span class="source-line-no">280</span><span id="line-280"> // already resumed, give up.</span> |
| <span class="source-line-no">281</span><span id="line-281"> return;</span> |
| <span class="source-line-no">282</span><span id="line-282"> }</span> |
| <span class="source-line-no">283</span><span id="line-283"> state = ScanResumerState.RESUMED;</span> |
| <span class="source-line-no">284</span><span id="line-284"> if (leaseRenewer != null) {</span> |
| <span class="source-line-no">285</span><span id="line-285"> leaseRenewer.cancel();</span> |
| <span class="source-line-no">286</span><span id="line-286"> }</span> |
| <span class="source-line-no">287</span><span id="line-287"> localResp = this.resp;</span> |
| <span class="source-line-no">288</span><span id="line-288"> localNumberOfCompleteRows = this.numberOfCompleteRows;</span> |
| <span class="source-line-no">289</span><span id="line-289"> }</span> |
| <span class="source-line-no">290</span><span id="line-290"> if (stopScan) {</span> |
| <span class="source-line-no">291</span><span id="line-291"> stopScan(localResp);</span> |
| <span class="source-line-no">292</span><span id="line-292"> } else {</span> |
| <span class="source-line-no">293</span><span id="line-293"> completeOrNext(localResp, localNumberOfCompleteRows);</span> |
| <span class="source-line-no">294</span><span id="line-294"> }</span> |
| <span class="source-line-no">295</span><span id="line-295"> }</span> |
| <span class="source-line-no">296</span><span id="line-296"></span> |
| <span class="source-line-no">297</span><span id="line-297"> private void scheduleRenewLeaseTask() {</span> |
| <span class="source-line-no">298</span><span id="line-298"> leaseRenewer = retryTimer.newTimeout(t -> tryRenewLease(), scannerLeaseTimeoutPeriodNs / 2,</span> |
| <span class="source-line-no">299</span><span id="line-299"> TimeUnit.NANOSECONDS);</span> |
| <span class="source-line-no">300</span><span id="line-300"> }</span> |
| <span class="source-line-no">301</span><span id="line-301"></span> |
| <span class="source-line-no">302</span><span id="line-302"> private synchronized void tryRenewLease() {</span> |
| <span class="source-line-no">303</span><span id="line-303"> // the scan has already been resumed, give up</span> |
| <span class="source-line-no">304</span><span id="line-304"> if (state == ScanResumerState.RESUMED) {</span> |
| <span class="source-line-no">305</span><span id="line-305"> return;</span> |
| <span class="source-line-no">306</span><span id="line-306"> }</span> |
| <span class="source-line-no">307</span><span id="line-307"> renewLease();</span> |
| <span class="source-line-no">308</span><span id="line-308"> // schedule the next renew lease task again as this is a one-time task.</span> |
| <span class="source-line-no">309</span><span id="line-309"> scheduleRenewLeaseTask();</span> |
| <span class="source-line-no">310</span><span id="line-310"> }</span> |
| <span class="source-line-no">311</span><span id="line-311"></span> |
| <span class="source-line-no">312</span><span id="line-312"> // return false if the scan has already been resumed. See the comment above for ScanResumerImpl</span> |
| <span class="source-line-no">313</span><span id="line-313"> // for more details.</span> |
| <span class="source-line-no">314</span><span id="line-314"> synchronized boolean prepare(ScanResponse resp, int numberOfCompleteRows) {</span> |
| <span class="source-line-no">315</span><span id="line-315"> if (state == ScanResumerState.RESUMED) {</span> |
| <span class="source-line-no">316</span><span id="line-316"> // user calls resume before we actually suspend the scan, just continue;</span> |
| <span class="source-line-no">317</span><span id="line-317"> return false;</span> |
| <span class="source-line-no">318</span><span id="line-318"> }</span> |
| <span class="source-line-no">319</span><span id="line-319"> state = ScanResumerState.SUSPENDED;</span> |
| <span class="source-line-no">320</span><span id="line-320"> this.resp = resp;</span> |
| <span class="source-line-no">321</span><span id="line-321"> this.numberOfCompleteRows = numberOfCompleteRows;</span> |
| <span class="source-line-no">322</span><span id="line-322"> // if there are no more results in region then the scanner at RS side will be closed</span> |
| <span class="source-line-no">323</span><span id="line-323"> // automatically so we do not need to renew lease.</span> |
| <span class="source-line-no">324</span><span id="line-324"> if (resp.getMoreResultsInRegion()) {</span> |
| <span class="source-line-no">325</span><span id="line-325"> // schedule renew lease task</span> |
| <span class="source-line-no">326</span><span id="line-326"> scheduleRenewLeaseTask();</span> |
| <span class="source-line-no">327</span><span id="line-327"> }</span> |
| <span class="source-line-no">328</span><span id="line-328"> return true;</span> |
| <span class="source-line-no">329</span><span id="line-329"> }</span> |
| <span class="source-line-no">330</span><span id="line-330"> }</span> |
| <span class="source-line-no">331</span><span id="line-331"></span> |
| <span class="source-line-no">332</span><span id="line-332"> public AsyncScanSingleRegionRpcRetryingCaller(Timer retryTimer, AsyncConnectionImpl conn,</span> |
| <span class="source-line-no">333</span><span id="line-333"> Scan scan, ScanMetrics scanMetrics, long scannerId, ScanResultCache resultCache,</span> |
| <span class="source-line-no">334</span><span id="line-334"> AdvancedScanResultConsumer consumer, Interface stub, HRegionLocation loc,</span> |
| <span class="source-line-no">335</span><span id="line-335"> boolean isRegionServerRemote, int priority, long scannerLeaseTimeoutPeriodNs, long pauseNs,</span> |
| <span class="source-line-no">336</span><span id="line-336"> long pauseNsForServerOverloaded, int maxAttempts, long scanTimeoutNs, long rpcTimeoutNs,</span> |
| <span class="source-line-no">337</span><span id="line-337"> int startLogErrorsCnt, Map<String, byte[]> requestAttributes) {</span> |
| <span class="source-line-no">338</span><span id="line-338"> this.retryTimer = retryTimer;</span> |
| <span class="source-line-no">339</span><span id="line-339"> this.conn = conn;</span> |
| <span class="source-line-no">340</span><span id="line-340"> this.scan = scan;</span> |
| <span class="source-line-no">341</span><span id="line-341"> this.scanMetrics = scanMetrics;</span> |
| <span class="source-line-no">342</span><span id="line-342"> this.scannerId = scannerId;</span> |
| <span class="source-line-no">343</span><span id="line-343"> this.resultCache = resultCache;</span> |
| <span class="source-line-no">344</span><span id="line-344"> this.consumer = consumer;</span> |
| <span class="source-line-no">345</span><span id="line-345"> this.stub = stub;</span> |
| <span class="source-line-no">346</span><span id="line-346"> this.loc = loc;</span> |
| <span class="source-line-no">347</span><span id="line-347"> this.regionServerRemote = isRegionServerRemote;</span> |
| <span class="source-line-no">348</span><span id="line-348"> this.scannerLeaseTimeoutPeriodNs = scannerLeaseTimeoutPeriodNs;</span> |
| <span class="source-line-no">349</span><span id="line-349"> this.maxAttempts = maxAttempts;</span> |
| <span class="source-line-no">350</span><span id="line-350"> this.scanTimeoutNs = scanTimeoutNs;</span> |
| <span class="source-line-no">351</span><span id="line-351"> this.rpcTimeoutNs = rpcTimeoutNs;</span> |
| <span class="source-line-no">352</span><span id="line-352"> this.startLogErrorsCnt = startLogErrorsCnt;</span> |
| <span class="source-line-no">353</span><span id="line-353"> if (scan.isReversed()) {</span> |
| <span class="source-line-no">354</span><span id="line-354"> completeWhenNoMoreResultsInRegion = this::completeReversedWhenNoMoreResultsInRegion;</span> |
| <span class="source-line-no">355</span><span id="line-355"> } else {</span> |
| <span class="source-line-no">356</span><span id="line-356"> completeWhenNoMoreResultsInRegion = this::completeWhenNoMoreResultsInRegion;</span> |
| <span class="source-line-no">357</span><span id="line-357"> }</span> |
| <span class="source-line-no">358</span><span id="line-358"> this.future = new CompletableFuture<>();</span> |
| <span class="source-line-no">359</span><span id="line-359"> this.priority = priority;</span> |
| <span class="source-line-no">360</span><span id="line-360"> this.controller = conn.rpcControllerFactory.newController();</span> |
| <span class="source-line-no">361</span><span id="line-361"> this.controller.setPriority(priority);</span> |
| <span class="source-line-no">362</span><span id="line-362"> this.controller.setRequestAttributes(requestAttributes);</span> |
| <span class="source-line-no">363</span><span id="line-363"> this.exceptions = new ArrayList<>();</span> |
| <span class="source-line-no">364</span><span id="line-364"> this.pauseManager =</span> |
| <span class="source-line-no">365</span><span id="line-365"> new HBaseServerExceptionPauseManager(pauseNs, pauseNsForServerOverloaded, scanTimeoutNs);</span> |
| <span class="source-line-no">366</span><span id="line-366"> }</span> |
| <span class="source-line-no">367</span><span id="line-367"></span> |
| <span class="source-line-no">368</span><span id="line-368"> private long elapsedMs() {</span> |
| <span class="source-line-no">369</span><span id="line-369"> return TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - nextCallStartNs);</span> |
| <span class="source-line-no">370</span><span id="line-370"> }</span> |
| <span class="source-line-no">371</span><span id="line-371"></span> |
| <span class="source-line-no">372</span><span id="line-372"> private void closeScanner() {</span> |
| <span class="source-line-no">373</span><span id="line-373"> incRPCCallsMetrics(scanMetrics, regionServerRemote);</span> |
| <span class="source-line-no">374</span><span id="line-374"> resetController(controller, rpcTimeoutNs, HConstants.HIGH_QOS, loc.getRegion().getTable());</span> |
| <span class="source-line-no">375</span><span id="line-375"> ScanRequest req = RequestConverter.buildScanRequest(this.scannerId, 0, true, false);</span> |
| <span class="source-line-no">376</span><span id="line-376"> stub.scan(controller, req, resp -> {</span> |
| <span class="source-line-no">377</span><span id="line-377"> if (controller.failed()) {</span> |
| <span class="source-line-no">378</span><span id="line-378"> LOG.warn("Call to " + loc.getServerName() + " for closing scanner id = " + scannerId</span> |
| <span class="source-line-no">379</span><span id="line-379"> + " for " + loc.getRegion().getEncodedName() + " of " + loc.getRegion().getTable()</span> |
| <span class="source-line-no">380</span><span id="line-380"> + " failed, ignore, probably already closed", controller.getFailed());</span> |
| <span class="source-line-no">381</span><span id="line-381"> }</span> |
| <span class="source-line-no">382</span><span id="line-382"> });</span> |
| <span class="source-line-no">383</span><span id="line-383"> }</span> |
| <span class="source-line-no">384</span><span id="line-384"></span> |
| <span class="source-line-no">385</span><span id="line-385"> private void completeExceptionally(boolean closeScanner) {</span> |
| <span class="source-line-no">386</span><span id="line-386"> resultCache.clear();</span> |
| <span class="source-line-no">387</span><span id="line-387"> if (closeScanner) {</span> |
| <span class="source-line-no">388</span><span id="line-388"> closeScanner();</span> |
| <span class="source-line-no">389</span><span id="line-389"> }</span> |
| <span class="source-line-no">390</span><span id="line-390"> future.completeExceptionally(new RetriesExhaustedException(tries - 1, exceptions));</span> |
| <span class="source-line-no">391</span><span id="line-391"> }</span> |
| <span class="source-line-no">392</span><span id="line-392"></span> |
| <span class="source-line-no">393</span><span id="line-393"> private void completeNoMoreResults() {</span> |
| <span class="source-line-no">394</span><span id="line-394"> future.complete(false);</span> |
| <span class="source-line-no">395</span><span id="line-395"> }</span> |
| <span class="source-line-no">396</span><span id="line-396"></span> |
| <span class="source-line-no">397</span><span id="line-397"> private void completeWithNextStartRow(byte[] row, boolean inclusive) {</span> |
| <span class="source-line-no">398</span><span id="line-398"> scan.withStartRow(row, inclusive);</span> |
| <span class="source-line-no">399</span><span id="line-399"> future.complete(true);</span> |
| <span class="source-line-no">400</span><span id="line-400"> }</span> |
| <span class="source-line-no">401</span><span id="line-401"></span> |
| <span class="source-line-no">402</span><span id="line-402"> private void completeWhenError(boolean closeScanner) {</span> |
| <span class="source-line-no">403</span><span id="line-403"> incRPCRetriesMetrics(scanMetrics, closeScanner);</span> |
| <span class="source-line-no">404</span><span id="line-404"> resultCache.clear();</span> |
| <span class="source-line-no">405</span><span id="line-405"> if (closeScanner) {</span> |
| <span class="source-line-no">406</span><span id="line-406"> closeScanner();</span> |
| <span class="source-line-no">407</span><span id="line-407"> }</span> |
| <span class="source-line-no">408</span><span id="line-408"> if (nextStartRowWhenError != null) {</span> |
| <span class="source-line-no">409</span><span id="line-409"> scan.withStartRow(nextStartRowWhenError, includeNextStartRowWhenError);</span> |
| <span class="source-line-no">410</span><span id="line-410"> }</span> |
| <span class="source-line-no">411</span><span id="line-411"> future.complete(true);</span> |
| <span class="source-line-no">412</span><span id="line-412"> }</span> |
| <span class="source-line-no">413</span><span id="line-413"></span> |
| <span class="source-line-no">414</span><span id="line-414"> private void onError(Throwable error) {</span> |
| <span class="source-line-no">415</span><span id="line-415"> error = translateException(error);</span> |
| <span class="source-line-no">416</span><span id="line-416"> if (tries > startLogErrorsCnt) {</span> |
| <span class="source-line-no">417</span><span id="line-417"> LOG.warn("Call to " + loc.getServerName() + " for scanner id = " + scannerId + " for "</span> |
| <span class="source-line-no">418</span><span id="line-418"> + loc.getRegion().getEncodedName() + " of " + loc.getRegion().getTable()</span> |
| <span class="source-line-no">419</span><span id="line-419"> + " failed, , tries = " + tries + ", maxAttempts = " + maxAttempts + ", timeout = "</span> |
| <span class="source-line-no">420</span><span id="line-420"> + TimeUnit.NANOSECONDS.toMillis(scanTimeoutNs) + " ms, time elapsed = " + elapsedMs()</span> |
| <span class="source-line-no">421</span><span id="line-421"> + " ms", error);</span> |
| <span class="source-line-no">422</span><span id="line-422"> }</span> |
| <span class="source-line-no">423</span><span id="line-423"> boolean scannerClosed =</span> |
| <span class="source-line-no">424</span><span id="line-424"> error instanceof UnknownScannerException || error instanceof NotServingRegionException</span> |
| <span class="source-line-no">425</span><span id="line-425"> || error instanceof RegionServerStoppedException || error instanceof ScannerResetException;</span> |
| <span class="source-line-no">426</span><span id="line-426"> RetriesExhaustedException.ThrowableWithExtraContext qt =</span> |
| <span class="source-line-no">427</span><span id="line-427"> new RetriesExhaustedException.ThrowableWithExtraContext(error,</span> |
| <span class="source-line-no">428</span><span id="line-428"> EnvironmentEdgeManager.currentTime(), "");</span> |
| <span class="source-line-no">429</span><span id="line-429"> exceptions.add(qt);</span> |
| <span class="source-line-no">430</span><span id="line-430"> if (tries >= maxAttempts) {</span> |
| <span class="source-line-no">431</span><span id="line-431"> completeExceptionally(!scannerClosed);</span> |
| <span class="source-line-no">432</span><span id="line-432"> return;</span> |
| <span class="source-line-no">433</span><span id="line-433"> }</span> |
| <span class="source-line-no">434</span><span id="line-434"></span> |
| <span class="source-line-no">435</span><span id="line-435"> OptionalLong maybePauseNsToUse =</span> |
| <span class="source-line-no">436</span><span id="line-436"> pauseManager.getPauseNsFromException(error, tries, nextCallStartNs);</span> |
| <span class="source-line-no">437</span><span id="line-437"> if (!maybePauseNsToUse.isPresent()) {</span> |
| <span class="source-line-no">438</span><span id="line-438"> completeExceptionally(!scannerClosed);</span> |
| <span class="source-line-no">439</span><span id="line-439"> return;</span> |
| <span class="source-line-no">440</span><span id="line-440"> }</span> |
| <span class="source-line-no">441</span><span id="line-441"> long delayNs = maybePauseNsToUse.getAsLong();</span> |
| <span class="source-line-no">442</span><span id="line-442"> if (scannerClosed) {</span> |
| <span class="source-line-no">443</span><span id="line-443"> completeWhenError(false);</span> |
| <span class="source-line-no">444</span><span id="line-444"> return;</span> |
| <span class="source-line-no">445</span><span id="line-445"> }</span> |
| <span class="source-line-no">446</span><span id="line-446"> if (error instanceof OutOfOrderScannerNextException) {</span> |
| <span class="source-line-no">447</span><span id="line-447"> completeWhenError(true);</span> |
| <span class="source-line-no">448</span><span id="line-448"> return;</span> |
| <span class="source-line-no">449</span><span id="line-449"> }</span> |
| <span class="source-line-no">450</span><span id="line-450"> if (error instanceof DoNotRetryIOException) {</span> |
| <span class="source-line-no">451</span><span id="line-451"> completeExceptionally(true);</span> |
| <span class="source-line-no">452</span><span id="line-452"> return;</span> |
| <span class="source-line-no">453</span><span id="line-453"> }</span> |
| <span class="source-line-no">454</span><span id="line-454"> tries++;</span> |
| <span class="source-line-no">455</span><span id="line-455"></span> |
| <span class="source-line-no">456</span><span id="line-456"> if (HBaseServerException.isServerOverloaded(error)) {</span> |
| <span class="source-line-no">457</span><span id="line-457"> Optional<MetricsConnection> metrics = conn.getConnectionMetrics();</span> |
| <span class="source-line-no">458</span><span id="line-458"> metrics.ifPresent(m -> m.incrementServerOverloadedBackoffTime(delayNs, TimeUnit.NANOSECONDS));</span> |
| <span class="source-line-no">459</span><span id="line-459"> }</span> |
| <span class="source-line-no">460</span><span id="line-460"> retryTimer.newTimeout(t -> call(), delayNs, TimeUnit.NANOSECONDS);</span> |
| <span class="source-line-no">461</span><span id="line-461"> }</span> |
| <span class="source-line-no">462</span><span id="line-462"></span> |
| <span class="source-line-no">463</span><span id="line-463"> private void updateNextStartRowWhenError(Result result) {</span> |
| <span class="source-line-no">464</span><span id="line-464"> nextStartRowWhenError = result.getRow();</span> |
| <span class="source-line-no">465</span><span id="line-465"> includeNextStartRowWhenError = result.mayHaveMoreCellsInRow();</span> |
| <span class="source-line-no">466</span><span id="line-466"> }</span> |
| <span class="source-line-no">467</span><span id="line-467"></span> |
| <span class="source-line-no">468</span><span id="line-468"> private void completeWhenNoMoreResultsInRegion() {</span> |
| <span class="source-line-no">469</span><span id="line-469"> if (noMoreResultsForScan(scan, loc.getRegion())) {</span> |
| <span class="source-line-no">470</span><span id="line-470"> completeNoMoreResults();</span> |
| <span class="source-line-no">471</span><span id="line-471"> } else {</span> |
| <span class="source-line-no">472</span><span id="line-472"> completeWithNextStartRow(loc.getRegion().getEndKey(), true);</span> |
| <span class="source-line-no">473</span><span id="line-473"> }</span> |
| <span class="source-line-no">474</span><span id="line-474"> }</span> |
| <span class="source-line-no">475</span><span id="line-475"></span> |
| <span class="source-line-no">476</span><span id="line-476"> private void completeReversedWhenNoMoreResultsInRegion() {</span> |
| <span class="source-line-no">477</span><span id="line-477"> if (noMoreResultsForReverseScan(scan, loc.getRegion())) {</span> |
| <span class="source-line-no">478</span><span id="line-478"> completeNoMoreResults();</span> |
| <span class="source-line-no">479</span><span id="line-479"> } else {</span> |
| <span class="source-line-no">480</span><span id="line-480"> completeWithNextStartRow(loc.getRegion().getStartKey(), false);</span> |
| <span class="source-line-no">481</span><span id="line-481"> }</span> |
| <span class="source-line-no">482</span><span id="line-482"> }</span> |
| <span class="source-line-no">483</span><span id="line-483"></span> |
| <span class="source-line-no">484</span><span id="line-484"> private void completeOrNext(ScanResponse resp, int numberOfCompleteRows) {</span> |
| <span class="source-line-no">485</span><span id="line-485"> if (resp.hasMoreResults() && !resp.getMoreResults()) {</span> |
| <span class="source-line-no">486</span><span id="line-486"> // RS tells us there is no more data for the whole scan</span> |
| <span class="source-line-no">487</span><span id="line-487"> completeNoMoreResults();</span> |
| <span class="source-line-no">488</span><span id="line-488"> return;</span> |
| <span class="source-line-no">489</span><span id="line-489"> }</span> |
| <span class="source-line-no">490</span><span id="line-490"> if (scan.getLimit() > 0) {</span> |
| <span class="source-line-no">491</span><span id="line-491"> // The RS should have set the moreResults field in ScanResponse to false when we have reached</span> |
| <span class="source-line-no">492</span><span id="line-492"> // the limit, so we add an assert here.</span> |
| <span class="source-line-no">493</span><span id="line-493"> int newLimit = scan.getLimit() - numberOfCompleteRows;</span> |
| <span class="source-line-no">494</span><span id="line-494"> assert newLimit > 0;</span> |
| <span class="source-line-no">495</span><span id="line-495"> scan.setLimit(newLimit);</span> |
| <span class="source-line-no">496</span><span id="line-496"> }</span> |
| <span class="source-line-no">497</span><span id="line-497"> // as in 2.0 this value will always be set</span> |
| <span class="source-line-no">498</span><span id="line-498"> if (!resp.getMoreResultsInRegion()) {</span> |
| <span class="source-line-no">499</span><span id="line-499"> completeWhenNoMoreResultsInRegion.run();</span> |
| <span class="source-line-no">500</span><span id="line-500"> return;</span> |
| <span class="source-line-no">501</span><span id="line-501"> }</span> |
| <span class="source-line-no">502</span><span id="line-502"> next();</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"> private void onComplete(HBaseRpcController controller, ScanResponse resp) {</span> |
| <span class="source-line-no">506</span><span id="line-506"> if (controller.failed()) {</span> |
| <span class="source-line-no">507</span><span id="line-507"> onError(controller.getFailed());</span> |
| <span class="source-line-no">508</span><span id="line-508"> return;</span> |
| <span class="source-line-no">509</span><span id="line-509"> }</span> |
| <span class="source-line-no">510</span><span id="line-510"> updateServerSideMetrics(scanMetrics, resp);</span> |
| <span class="source-line-no">511</span><span id="line-511"> boolean isHeartbeatMessage = resp.hasHeartbeatMessage() && resp.getHeartbeatMessage();</span> |
| <span class="source-line-no">512</span><span id="line-512"> Result[] rawResults;</span> |
| <span class="source-line-no">513</span><span id="line-513"> Result[] results;</span> |
| <span class="source-line-no">514</span><span id="line-514"> int numberOfCompleteRowsBefore = resultCache.numberOfCompleteRows();</span> |
| <span class="source-line-no">515</span><span id="line-515"> try {</span> |
| <span class="source-line-no">516</span><span id="line-516"> rawResults = ResponseConverter.getResults(controller.cellScanner(), resp);</span> |
| <span class="source-line-no">517</span><span id="line-517"> updateResultsMetrics(scanMetrics, rawResults, isHeartbeatMessage);</span> |
| <span class="source-line-no">518</span><span id="line-518"> results = resultCache.addAndGet(</span> |
| <span class="source-line-no">519</span><span id="line-519"> Optional.ofNullable(rawResults).orElse(ScanResultCache.EMPTY_RESULT_ARRAY),</span> |
| <span class="source-line-no">520</span><span id="line-520"> isHeartbeatMessage);</span> |
| <span class="source-line-no">521</span><span id="line-521"> } catch (IOException e) {</span> |
| <span class="source-line-no">522</span><span id="line-522"> // We can not retry here. The server has responded normally and the call sequence has been</span> |
| <span class="source-line-no">523</span><span id="line-523"> // increased so a new scan with the same call sequence will cause an</span> |
| <span class="source-line-no">524</span><span id="line-524"> // OutOfOrderScannerNextException. Let the upper layer open a new scanner.</span> |
| <span class="source-line-no">525</span><span id="line-525"> LOG.warn("decode scan response failed", e);</span> |
| <span class="source-line-no">526</span><span id="line-526"> completeWhenError(true);</span> |
| <span class="source-line-no">527</span><span id="line-527"> return;</span> |
| <span class="source-line-no">528</span><span id="line-528"> }</span> |
| <span class="source-line-no">529</span><span id="line-529"></span> |
| <span class="source-line-no">530</span><span id="line-530"> ScanControllerImpl scanController;</span> |
| <span class="source-line-no">531</span><span id="line-531"> if (results.length > 0) {</span> |
| <span class="source-line-no">532</span><span id="line-532"> scanController = new ScanControllerImpl(</span> |
| <span class="source-line-no">533</span><span id="line-533"> resp.hasCursor() ? Optional.of(ProtobufUtil.toCursor(resp.getCursor())) : Optional.empty());</span> |
| <span class="source-line-no">534</span><span id="line-534"> updateNextStartRowWhenError(results[results.length - 1]);</span> |
| <span class="source-line-no">535</span><span id="line-535"> consumer.onNext(results, scanController);</span> |
| <span class="source-line-no">536</span><span id="line-536"> } else {</span> |
| <span class="source-line-no">537</span><span id="line-537"> Optional<Cursor> cursor = Optional.empty();</span> |
| <span class="source-line-no">538</span><span id="line-538"> if (resp.hasCursor()) {</span> |
| <span class="source-line-no">539</span><span id="line-539"> cursor = Optional.of(ProtobufUtil.toCursor(resp.getCursor()));</span> |
| <span class="source-line-no">540</span><span id="line-540"> } else if (scan.isNeedCursorResult() && rawResults.length > 0) {</span> |
| <span class="source-line-no">541</span><span id="line-541"> // It is size limit exceed and we need to return the last Result's row.</span> |
| <span class="source-line-no">542</span><span id="line-542"> // When user setBatch and the scanner is reopened, the server may return Results that</span> |
| <span class="source-line-no">543</span><span id="line-543"> // user has seen and the last Result can not be seen because the number is not enough.</span> |
| <span class="source-line-no">544</span><span id="line-544"> // So the row keys of results may not be same, we must use the last one.</span> |
| <span class="source-line-no">545</span><span id="line-545"> cursor = Optional.of(new Cursor(rawResults[rawResults.length - 1].getRow()));</span> |
| <span class="source-line-no">546</span><span id="line-546"> }</span> |
| <span class="source-line-no">547</span><span id="line-547"> scanController = new ScanControllerImpl(cursor);</span> |
| <span class="source-line-no">548</span><span id="line-548"> if (isHeartbeatMessage || cursor.isPresent()) {</span> |
| <span class="source-line-no">549</span><span id="line-549"> // only call onHeartbeat if server tells us explicitly this is a heartbeat message, or we</span> |
| <span class="source-line-no">550</span><span id="line-550"> // want to pass a cursor to upper layer.</span> |
| <span class="source-line-no">551</span><span id="line-551"> consumer.onHeartbeat(scanController);</span> |
| <span class="source-line-no">552</span><span id="line-552"> }</span> |
| <span class="source-line-no">553</span><span id="line-553"> }</span> |
| <span class="source-line-no">554</span><span id="line-554"> ScanControllerState state = scanController.destroy();</span> |
| <span class="source-line-no">555</span><span id="line-555"> if (state == ScanControllerState.TERMINATED) {</span> |
| <span class="source-line-no">556</span><span id="line-556"> stopScan(resp);</span> |
| <span class="source-line-no">557</span><span id="line-557"> return;</span> |
| <span class="source-line-no">558</span><span id="line-558"> }</span> |
| <span class="source-line-no">559</span><span id="line-559"> int numberOfCompleteRows = resultCache.numberOfCompleteRows() - numberOfCompleteRowsBefore;</span> |
| <span class="source-line-no">560</span><span id="line-560"> if (state == ScanControllerState.SUSPENDED) {</span> |
| <span class="source-line-no">561</span><span id="line-561"> if (scanController.resumer.prepare(resp, numberOfCompleteRows)) {</span> |
| <span class="source-line-no">562</span><span id="line-562"> return;</span> |
| <span class="source-line-no">563</span><span id="line-563"> }</span> |
| <span class="source-line-no">564</span><span id="line-564"> }</span> |
| <span class="source-line-no">565</span><span id="line-565"> completeOrNext(resp, numberOfCompleteRows);</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"> private void stopScan(ScanResponse resp) {</span> |
| <span class="source-line-no">569</span><span id="line-569"> if (resp.getMoreResultsInRegion()) {</span> |
| <span class="source-line-no">570</span><span id="line-570"> // we have more results in region but user request to stop the scan, so we need to close the</span> |
| <span class="source-line-no">571</span><span id="line-571"> // scanner explicitly.</span> |
| <span class="source-line-no">572</span><span id="line-572"> closeScanner();</span> |
| <span class="source-line-no">573</span><span id="line-573"> }</span> |
| <span class="source-line-no">574</span><span id="line-574"> completeNoMoreResults();</span> |
| <span class="source-line-no">575</span><span id="line-575"> }</span> |
| <span class="source-line-no">576</span><span id="line-576"></span> |
| <span class="source-line-no">577</span><span id="line-577"> private void call() {</span> |
| <span class="source-line-no">578</span><span id="line-578"> // As we have a call sequence for scan, it is useless to have a different rpc timeout which is</span> |
| <span class="source-line-no">579</span><span id="line-579"> // less than the scan timeout. If the server does not respond in time(usually this will not</span> |
| <span class="source-line-no">580</span><span id="line-580"> // happen as we have heartbeat now), we will get an OutOfOrderScannerNextException when</span> |
| <span class="source-line-no">581</span><span id="line-581"> // resending the next request and the only way to fix this is to close the scanner and open a</span> |
| <span class="source-line-no">582</span><span id="line-582"> // new one.</span> |
| <span class="source-line-no">583</span><span id="line-583"> long callTimeoutNs;</span> |
| <span class="source-line-no">584</span><span id="line-584"> if (scanTimeoutNs > 0) {</span> |
| <span class="source-line-no">585</span><span id="line-585"> long remainingNs = scanTimeoutNs - (System.nanoTime() - nextCallStartNs);</span> |
| <span class="source-line-no">586</span><span id="line-586"> if (remainingNs <= 0) {</span> |
| <span class="source-line-no">587</span><span id="line-587"> completeExceptionally(true);</span> |
| <span class="source-line-no">588</span><span id="line-588"> return;</span> |
| <span class="source-line-no">589</span><span id="line-589"> }</span> |
| <span class="source-line-no">590</span><span id="line-590"> callTimeoutNs = remainingNs;</span> |
| <span class="source-line-no">591</span><span id="line-591"> } else {</span> |
| <span class="source-line-no">592</span><span id="line-592"> callTimeoutNs = 0L;</span> |
| <span class="source-line-no">593</span><span id="line-593"> }</span> |
| <span class="source-line-no">594</span><span id="line-594"> incRPCCallsMetrics(scanMetrics, regionServerRemote);</span> |
| <span class="source-line-no">595</span><span id="line-595"> if (tries > 1) {</span> |
| <span class="source-line-no">596</span><span id="line-596"> incRPCRetriesMetrics(scanMetrics, regionServerRemote);</span> |
| <span class="source-line-no">597</span><span id="line-597"> }</span> |
| <span class="source-line-no">598</span><span id="line-598"> resetController(controller, callTimeoutNs, priority, loc.getRegion().getTable());</span> |
| <span class="source-line-no">599</span><span id="line-599"> ScanRequest req = RequestConverter.buildScanRequest(scannerId, scan.getCaching(), false,</span> |
| <span class="source-line-no">600</span><span id="line-600"> nextCallSeq, scan.isScanMetricsEnabled(), false, scan.getLimit());</span> |
| <span class="source-line-no">601</span><span id="line-601"> final Context context = Context.current();</span> |
| <span class="source-line-no">602</span><span id="line-602"> stub.scan(controller, req, resp -> {</span> |
| <span class="source-line-no">603</span><span id="line-603"> try (Scope ignored = context.makeCurrent()) {</span> |
| <span class="source-line-no">604</span><span id="line-604"> onComplete(controller, resp);</span> |
| <span class="source-line-no">605</span><span id="line-605"> }</span> |
| <span class="source-line-no">606</span><span id="line-606"> });</span> |
| <span class="source-line-no">607</span><span id="line-607"> }</span> |
| <span class="source-line-no">608</span><span id="line-608"></span> |
| <span class="source-line-no">609</span><span id="line-609"> private void next() {</span> |
| <span class="source-line-no">610</span><span id="line-610"> nextCallSeq++;</span> |
| <span class="source-line-no">611</span><span id="line-611"> tries = 1;</span> |
| <span class="source-line-no">612</span><span id="line-612"> exceptions.clear();</span> |
| <span class="source-line-no">613</span><span id="line-613"> nextCallStartNs = System.nanoTime();</span> |
| <span class="source-line-no">614</span><span id="line-614"> call();</span> |
| <span class="source-line-no">615</span><span id="line-615"> }</span> |
| <span class="source-line-no">616</span><span id="line-616"></span> |
| <span class="source-line-no">617</span><span id="line-617"> private void renewLease() {</span> |
| <span class="source-line-no">618</span><span id="line-618"> incRPCCallsMetrics(scanMetrics, regionServerRemote);</span> |
| <span class="source-line-no">619</span><span id="line-619"> nextCallSeq++;</span> |
| <span class="source-line-no">620</span><span id="line-620"> resetController(controller, rpcTimeoutNs, priority, loc.getRegion().getTable());</span> |
| <span class="source-line-no">621</span><span id="line-621"> ScanRequest req =</span> |
| <span class="source-line-no">622</span><span id="line-622"> RequestConverter.buildScanRequest(scannerId, 0, false, nextCallSeq, false, true, -1);</span> |
| <span class="source-line-no">623</span><span id="line-623"> stub.scan(controller, req, resp -> {</span> |
| <span class="source-line-no">624</span><span id="line-624"> });</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"> * Now we will also fetch some cells along with the scanner id when opening a scanner, so we also</span> |
| <span class="source-line-no">629</span><span id="line-629"> * need to process the ScanResponse for the open scanner request. The HBaseRpcController for the</span> |
| <span class="source-line-no">630</span><span id="line-630"> * open scanner request is also needed because we may have some data in the CellScanner which is</span> |
| <span class="source-line-no">631</span><span id="line-631"> * contained in the controller.</span> |
| <span class="source-line-no">632</span><span id="line-632"> * @return {@code true} if we should continue, otherwise {@code false}.</span> |
| <span class="source-line-no">633</span><span id="line-633"> */</span> |
| <span class="source-line-no">634</span><span id="line-634"> public CompletableFuture<Boolean> start(HBaseRpcController controller,</span> |
| <span class="source-line-no">635</span><span id="line-635"> ScanResponse respWhenOpen) {</span> |
| <span class="source-line-no">636</span><span id="line-636"> onComplete(controller, respWhenOpen);</span> |
| <span class="source-line-no">637</span><span id="line-637"> return future;</span> |
| <span class="source-line-no">638</span><span id="line-638"> }</span> |
| <span class="source-line-no">639</span><span id="line-639">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
