| <!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, class: Waiter, interface: Predicate"> |
| <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;</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.junit.Assert.fail;</span> |
| <span class="source-line-no">021</span><span id="line-21"></span> |
| <span class="source-line-no">022</span><span id="line-22">import java.text.MessageFormat;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.slf4j.Logger;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">028</span><span id="line-28"></span> |
| <span class="source-line-no">029</span><span id="line-29">/**</span> |
| <span class="source-line-no">030</span><span id="line-30"> * A class that provides a standard waitFor pattern See details at</span> |
| <span class="source-line-no">031</span><span id="line-31"> * https://issues.apache.org/jira/browse/HBASE-7384</span> |
| <span class="source-line-no">032</span><span id="line-32"> */</span> |
| <span class="source-line-no">033</span><span id="line-33">@InterfaceAudience.Private</span> |
| <span class="source-line-no">034</span><span id="line-34">public final class Waiter {</span> |
| <span class="source-line-no">035</span><span id="line-35"> private static final Logger LOG = LoggerFactory.getLogger(Waiter.class);</span> |
| <span class="source-line-no">036</span><span id="line-36"></span> |
| <span class="source-line-no">037</span><span id="line-37"> /**</span> |
| <span class="source-line-no">038</span><span id="line-38"> * System property name whose value is a scale factor to increase time out values dynamically used</span> |
| <span class="source-line-no">039</span><span id="line-39"> * in {@link #sleep(Configuration, long)}, {@link #waitFor(Configuration, long, Predicate)},</span> |
| <span class="source-line-no">040</span><span id="line-40"> * {@link #waitFor(Configuration, long, long, Predicate)}, and</span> |
| <span class="source-line-no">041</span><span id="line-41"> * {@link #waitFor(Configuration, long, long, boolean, Predicate)} method</span> |
| <span class="source-line-no">042</span><span id="line-42"> * <p/></span> |
| <span class="source-line-no">043</span><span id="line-43"> * The actual time out value will equal to hbase.test.wait.for.ratio * passed-in timeout</span> |
| <span class="source-line-no">044</span><span id="line-44"> */</span> |
| <span class="source-line-no">045</span><span id="line-45"> public static final String HBASE_TEST_WAIT_FOR_RATIO = "hbase.test.wait.for.ratio";</span> |
| <span class="source-line-no">046</span><span id="line-46"></span> |
| <span class="source-line-no">047</span><span id="line-47"> private static float HBASE_WAIT_FOR_RATIO_DEFAULT = 1;</span> |
| <span class="source-line-no">048</span><span id="line-48"></span> |
| <span class="source-line-no">049</span><span id="line-49"> private static float waitForRatio = -1;</span> |
| <span class="source-line-no">050</span><span id="line-50"></span> |
| <span class="source-line-no">051</span><span id="line-51"> private Waiter() {</span> |
| <span class="source-line-no">052</span><span id="line-52"> }</span> |
| <span class="source-line-no">053</span><span id="line-53"></span> |
| <span class="source-line-no">054</span><span id="line-54"> /**</span> |
| <span class="source-line-no">055</span><span id="line-55"> * Returns the 'wait for ratio' used in the {@link #sleep(Configuration, long)},</span> |
| <span class="source-line-no">056</span><span id="line-56"> * {@link #waitFor(Configuration, long, Predicate)},</span> |
| <span class="source-line-no">057</span><span id="line-57"> * {@link #waitFor(Configuration, long, long, Predicate)} and</span> |
| <span class="source-line-no">058</span><span id="line-58"> * {@link #waitFor(Configuration, long, long, boolean, Predicate)} methods of the class</span> |
| <span class="source-line-no">059</span><span id="line-59"> * <p/></span> |
| <span class="source-line-no">060</span><span id="line-60"> * This is useful to dynamically adjust max time out values when same test cases run in different</span> |
| <span class="source-line-no">061</span><span id="line-61"> * test machine settings without recompiling & re-deploying code.</span> |
| <span class="source-line-no">062</span><span id="line-62"> * <p/></span> |
| <span class="source-line-no">063</span><span id="line-63"> * The value is obtained from the Java System property or configuration setting</span> |
| <span class="source-line-no">064</span><span id="line-64"> * <code>hbase.test.wait.for.ratio</code> which defaults to <code>1</code>.</span> |
| <span class="source-line-no">065</span><span id="line-65"> * @param conf the configuration</span> |
| <span class="source-line-no">066</span><span id="line-66"> * @return the 'wait for ratio' for the current test run.</span> |
| <span class="source-line-no">067</span><span id="line-67"> */</span> |
| <span class="source-line-no">068</span><span id="line-68"> public static float getWaitForRatio(Configuration conf) {</span> |
| <span class="source-line-no">069</span><span id="line-69"> if (waitForRatio < 0) {</span> |
| <span class="source-line-no">070</span><span id="line-70"> // System property takes precedence over configuration setting</span> |
| <span class="source-line-no">071</span><span id="line-71"> if (System.getProperty(HBASE_TEST_WAIT_FOR_RATIO) != null) {</span> |
| <span class="source-line-no">072</span><span id="line-72"> waitForRatio = Float.parseFloat(System.getProperty(HBASE_TEST_WAIT_FOR_RATIO));</span> |
| <span class="source-line-no">073</span><span id="line-73"> } else {</span> |
| <span class="source-line-no">074</span><span id="line-74"> waitForRatio = conf.getFloat(HBASE_TEST_WAIT_FOR_RATIO, HBASE_WAIT_FOR_RATIO_DEFAULT);</span> |
| <span class="source-line-no">075</span><span id="line-75"> }</span> |
| <span class="source-line-no">076</span><span id="line-76"> }</span> |
| <span class="source-line-no">077</span><span id="line-77"> return waitForRatio;</span> |
| <span class="source-line-no">078</span><span id="line-78"> }</span> |
| <span class="source-line-no">079</span><span id="line-79"></span> |
| <span class="source-line-no">080</span><span id="line-80"> /**</span> |
| <span class="source-line-no">081</span><span id="line-81"> * A predicate 'closure' used by the {@link Waiter#waitFor(Configuration, long, Predicate)} and</span> |
| <span class="source-line-no">082</span><span id="line-82"> * {@link Waiter#waitFor(Configuration, long, Predicate)} and</span> |
| <span class="source-line-no">083</span><span id="line-83"> * {@link Waiter#waitFor(Configuration, long, long, boolean, Predicate)} methods.</span> |
| <span class="source-line-no">084</span><span id="line-84"> */</span> |
| <span class="source-line-no">085</span><span id="line-85"> @InterfaceAudience.Private</span> |
| <span class="source-line-no">086</span><span id="line-86"> public interface Predicate<E extends Exception> {</span> |
| <span class="source-line-no">087</span><span id="line-87"> /**</span> |
| <span class="source-line-no">088</span><span id="line-88"> * Perform a predicate evaluation.</span> |
| <span class="source-line-no">089</span><span id="line-89"> * @return the boolean result of the evaluation.</span> |
| <span class="source-line-no">090</span><span id="line-90"> * @throws E thrown if the predicate evaluation could not evaluate.</span> |
| <span class="source-line-no">091</span><span id="line-91"> */</span> |
| <span class="source-line-no">092</span><span id="line-92"> boolean evaluate() throws E;</span> |
| <span class="source-line-no">093</span><span id="line-93"> }</span> |
| <span class="source-line-no">094</span><span id="line-94"></span> |
| <span class="source-line-no">095</span><span id="line-95"> /**</span> |
| <span class="source-line-no">096</span><span id="line-96"> * A mixin interface, can be used with {@link Waiter} to explain failed state.</span> |
| <span class="source-line-no">097</span><span id="line-97"> */</span> |
| <span class="source-line-no">098</span><span id="line-98"> @InterfaceAudience.Private</span> |
| <span class="source-line-no">099</span><span id="line-99"> public interface ExplainingPredicate<E extends Exception> extends Predicate<E> {</span> |
| <span class="source-line-no">100</span><span id="line-100"> /**</span> |
| <span class="source-line-no">101</span><span id="line-101"> * Perform a predicate evaluation.</span> |
| <span class="source-line-no">102</span><span id="line-102"> * @return explanation of failed state</span> |
| <span class="source-line-no">103</span><span id="line-103"> */</span> |
| <span class="source-line-no">104</span><span id="line-104"> String explainFailure() throws E;</span> |
| <span class="source-line-no">105</span><span id="line-105"> }</span> |
| <span class="source-line-no">106</span><span id="line-106"></span> |
| <span class="source-line-no">107</span><span id="line-107"> /**</span> |
| <span class="source-line-no">108</span><span id="line-108"> * Makes the current thread sleep for the duration equal to the specified time in milliseconds</span> |
| <span class="source-line-no">109</span><span id="line-109"> * multiplied by the {@link #getWaitForRatio(Configuration)}.</span> |
| <span class="source-line-no">110</span><span id="line-110"> * @param conf the configuration</span> |
| <span class="source-line-no">111</span><span id="line-111"> * @param time the number of milliseconds to sleep.</span> |
| <span class="source-line-no">112</span><span id="line-112"> */</span> |
| <span class="source-line-no">113</span><span id="line-113"> public static void sleep(Configuration conf, long time) {</span> |
| <span class="source-line-no">114</span><span id="line-114"> try {</span> |
| <span class="source-line-no">115</span><span id="line-115"> Thread.sleep((long) (getWaitForRatio(conf) * time));</span> |
| <span class="source-line-no">116</span><span id="line-116"> } catch (InterruptedException ex) {</span> |
| <span class="source-line-no">117</span><span id="line-117"> LOG.warn(MessageFormat.format("Sleep interrupted, {0}", ex.toString()));</span> |
| <span class="source-line-no">118</span><span id="line-118"> }</span> |
| <span class="source-line-no">119</span><span id="line-119"> }</span> |
| <span class="source-line-no">120</span><span id="line-120"></span> |
| <span class="source-line-no">121</span><span id="line-121"> /**</span> |
| <span class="source-line-no">122</span><span id="line-122"> * Waits up to the duration equal to the specified timeout multiplied by the</span> |
| <span class="source-line-no">123</span><span id="line-123"> * {@link #getWaitForRatio(Configuration)} for the given {@link Predicate} to become</span> |
| <span class="source-line-no">124</span><span id="line-124"> * <code>true</code>, failing the test if the timeout is reached and the Predicate is still</span> |
| <span class="source-line-no">125</span><span id="line-125"> * <code>false</code>.</span> |
| <span class="source-line-no">126</span><span id="line-126"> * <p/></span> |
| <span class="source-line-no">127</span><span id="line-127"> * @param conf the configuration</span> |
| <span class="source-line-no">128</span><span id="line-128"> * @param timeout the timeout in milliseconds to wait for the predicate.</span> |
| <span class="source-line-no">129</span><span id="line-129"> * @param predicate the predicate to evaluate.</span> |
| <span class="source-line-no">130</span><span id="line-130"> * @return the effective wait, in milli-seconds until the predicate becomes <code>true</code> or</span> |
| <span class="source-line-no">131</span><span id="line-131"> * wait is interrupted otherwise <code>-1</code> when times out</span> |
| <span class="source-line-no">132</span><span id="line-132"> */</span> |
| <span class="source-line-no">133</span><span id="line-133"> public static <E extends Exception> long waitFor(Configuration conf, long timeout,</span> |
| <span class="source-line-no">134</span><span id="line-134"> Predicate<E> predicate) {</span> |
| <span class="source-line-no">135</span><span id="line-135"> return waitFor(conf, timeout, 100, true, predicate);</span> |
| <span class="source-line-no">136</span><span id="line-136"> }</span> |
| <span class="source-line-no">137</span><span id="line-137"></span> |
| <span class="source-line-no">138</span><span id="line-138"> /**</span> |
| <span class="source-line-no">139</span><span id="line-139"> * Waits up to the duration equal to the specified timeout multiplied by the</span> |
| <span class="source-line-no">140</span><span id="line-140"> * {@link #getWaitForRatio(Configuration)} for the given {@link Predicate} to become</span> |
| <span class="source-line-no">141</span><span id="line-141"> * <code>true</code>, failing the test if the timeout is reached and the Predicate is still</span> |
| <span class="source-line-no">142</span><span id="line-142"> * <code>false</code>.</span> |
| <span class="source-line-no">143</span><span id="line-143"> * <p/></span> |
| <span class="source-line-no">144</span><span id="line-144"> * @param conf the configuration</span> |
| <span class="source-line-no">145</span><span id="line-145"> * @param timeout the max timeout in milliseconds to wait for the predicate.</span> |
| <span class="source-line-no">146</span><span id="line-146"> * @param interval the interval in milliseconds to evaluate predicate.</span> |
| <span class="source-line-no">147</span><span id="line-147"> * @param predicate the predicate to evaluate.</span> |
| <span class="source-line-no">148</span><span id="line-148"> * @return the effective wait, in milli-seconds until the predicate becomes <code>true</code> or</span> |
| <span class="source-line-no">149</span><span id="line-149"> * wait is interrupted otherwise <code>-1</code> when times out</span> |
| <span class="source-line-no">150</span><span id="line-150"> */</span> |
| <span class="source-line-no">151</span><span id="line-151"> public static <E extends Exception> long waitFor(Configuration conf, long timeout, long interval,</span> |
| <span class="source-line-no">152</span><span id="line-152"> Predicate<E> predicate) {</span> |
| <span class="source-line-no">153</span><span id="line-153"> return waitFor(conf, timeout, interval, true, predicate);</span> |
| <span class="source-line-no">154</span><span id="line-154"> }</span> |
| <span class="source-line-no">155</span><span id="line-155"></span> |
| <span class="source-line-no">156</span><span id="line-156"> /**</span> |
| <span class="source-line-no">157</span><span id="line-157"> * Waits up to the duration equal to the specified timeout multiplied by the</span> |
| <span class="source-line-no">158</span><span id="line-158"> * {@link #getWaitForRatio(Configuration)} for the given {@link Predicate} to become</span> |
| <span class="source-line-no">159</span><span id="line-159"> * <code>true</code>, failing the test if the timeout is reached, the Predicate is still</span> |
| <span class="source-line-no">160</span><span id="line-160"> * <code>false</code> and failIfTimeout is set as <code>true</code>.</span> |
| <span class="source-line-no">161</span><span id="line-161"> * <p/></span> |
| <span class="source-line-no">162</span><span id="line-162"> * @param conf the configuration</span> |
| <span class="source-line-no">163</span><span id="line-163"> * @param timeout the timeout in milliseconds to wait for the predicate.</span> |
| <span class="source-line-no">164</span><span id="line-164"> * @param interval the interval in milliseconds to evaluate predicate.</span> |
| <span class="source-line-no">165</span><span id="line-165"> * @param failIfTimeout indicates if should fail current test case when times out.</span> |
| <span class="source-line-no">166</span><span id="line-166"> * @param predicate the predicate to evaluate.</span> |
| <span class="source-line-no">167</span><span id="line-167"> * @return the effective wait, in milli-seconds until the predicate becomes <code>true</code> or</span> |
| <span class="source-line-no">168</span><span id="line-168"> * wait is interrupted otherwise <code>-1</code> when times out</span> |
| <span class="source-line-no">169</span><span id="line-169"> */</span> |
| <span class="source-line-no">170</span><span id="line-170"> public static <E extends Exception> long waitFor(Configuration conf, long timeout, long interval,</span> |
| <span class="source-line-no">171</span><span id="line-171"> boolean failIfTimeout, Predicate<E> predicate) {</span> |
| <span class="source-line-no">172</span><span id="line-172"> long started = EnvironmentEdgeManager.currentTime();</span> |
| <span class="source-line-no">173</span><span id="line-173"> long adjustedTimeout = (long) (getWaitForRatio(conf) * timeout);</span> |
| <span class="source-line-no">174</span><span id="line-174"> long mustEnd = started + adjustedTimeout;</span> |
| <span class="source-line-no">175</span><span id="line-175"> long remainderWait;</span> |
| <span class="source-line-no">176</span><span id="line-176"> long sleepInterval;</span> |
| <span class="source-line-no">177</span><span id="line-177"> boolean eval;</span> |
| <span class="source-line-no">178</span><span id="line-178"> boolean interrupted = false;</span> |
| <span class="source-line-no">179</span><span id="line-179"></span> |
| <span class="source-line-no">180</span><span id="line-180"> try {</span> |
| <span class="source-line-no">181</span><span id="line-181"> LOG.info(MessageFormat.format("Waiting up to [{0}] milli-secs(wait.for.ratio=[{1}])",</span> |
| <span class="source-line-no">182</span><span id="line-182"> adjustedTimeout, getWaitForRatio(conf)));</span> |
| <span class="source-line-no">183</span><span id="line-183"> while (</span> |
| <span class="source-line-no">184</span><span id="line-184"> !(eval = predicate.evaluate())</span> |
| <span class="source-line-no">185</span><span id="line-185"> && (remainderWait = mustEnd - EnvironmentEdgeManager.currentTime()) > 0</span> |
| <span class="source-line-no">186</span><span id="line-186"> ) {</span> |
| <span class="source-line-no">187</span><span id="line-187"> try {</span> |
| <span class="source-line-no">188</span><span id="line-188"> // handle tail case when remainder wait is less than one interval</span> |
| <span class="source-line-no">189</span><span id="line-189"> sleepInterval = Math.min(remainderWait, interval);</span> |
| <span class="source-line-no">190</span><span id="line-190"> Thread.sleep(sleepInterval);</span> |
| <span class="source-line-no">191</span><span id="line-191"> } catch (InterruptedException e) {</span> |
| <span class="source-line-no">192</span><span id="line-192"> eval = predicate.evaluate();</span> |
| <span class="source-line-no">193</span><span id="line-193"> interrupted = true;</span> |
| <span class="source-line-no">194</span><span id="line-194"> break;</span> |
| <span class="source-line-no">195</span><span id="line-195"> }</span> |
| <span class="source-line-no">196</span><span id="line-196"> }</span> |
| <span class="source-line-no">197</span><span id="line-197"> if (!eval) {</span> |
| <span class="source-line-no">198</span><span id="line-198"> if (interrupted) {</span> |
| <span class="source-line-no">199</span><span id="line-199"> LOG.warn(MessageFormat.format("Waiting interrupted after [{0}] msec",</span> |
| <span class="source-line-no">200</span><span id="line-200"> EnvironmentEdgeManager.currentTime() - started));</span> |
| <span class="source-line-no">201</span><span id="line-201"> } else if (failIfTimeout) {</span> |
| <span class="source-line-no">202</span><span id="line-202"> String msg = getExplanation(predicate);</span> |
| <span class="source-line-no">203</span><span id="line-203"> fail(MessageFormat.format("Waiting timed out after [{0}] msec", adjustedTimeout) + msg);</span> |
| <span class="source-line-no">204</span><span id="line-204"> } else {</span> |
| <span class="source-line-no">205</span><span id="line-205"> String msg = getExplanation(predicate);</span> |
| <span class="source-line-no">206</span><span id="line-206"> LOG.warn(</span> |
| <span class="source-line-no">207</span><span id="line-207"> MessageFormat.format("Waiting timed out after [{0}] msec", adjustedTimeout) + msg);</span> |
| <span class="source-line-no">208</span><span id="line-208"> }</span> |
| <span class="source-line-no">209</span><span id="line-209"> }</span> |
| <span class="source-line-no">210</span><span id="line-210"> return (eval || interrupted) ? (EnvironmentEdgeManager.currentTime() - started) : -1;</span> |
| <span class="source-line-no">211</span><span id="line-211"> } catch (Exception ex) {</span> |
| <span class="source-line-no">212</span><span id="line-212"> throw new RuntimeException(ex);</span> |
| <span class="source-line-no">213</span><span id="line-213"> }</span> |
| <span class="source-line-no">214</span><span id="line-214"> }</span> |
| <span class="source-line-no">215</span><span id="line-215"></span> |
| <span class="source-line-no">216</span><span id="line-216"> public static String getExplanation(Predicate<?> explain) {</span> |
| <span class="source-line-no">217</span><span id="line-217"> if (explain instanceof ExplainingPredicate) {</span> |
| <span class="source-line-no">218</span><span id="line-218"> try {</span> |
| <span class="source-line-no">219</span><span id="line-219"> return " " + ((ExplainingPredicate<?>) explain).explainFailure();</span> |
| <span class="source-line-no">220</span><span id="line-220"> } catch (Exception e) {</span> |
| <span class="source-line-no">221</span><span id="line-221"> LOG.error("Failed to get explanation, ", e);</span> |
| <span class="source-line-no">222</span><span id="line-222"> return e.getMessage();</span> |
| <span class="source-line-no">223</span><span id="line-223"> }</span> |
| <span class="source-line-no">224</span><span id="line-224"> } else {</span> |
| <span class="source-line-no">225</span><span id="line-225"> return "";</span> |
| <span class="source-line-no">226</span><span id="line-226"> }</span> |
| <span class="source-line-no">227</span><span id="line-227"> }</span> |
| <span class="source-line-no">228</span><span id="line-228">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
