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