| <!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: ChoreService"> |
| <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 com.google.errorprone.annotations.RestrictedApi;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.util.ArrayList;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.HashMap;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.util.LinkedHashMap;</span> |
| <span class="source-line-no">024</span><span id="line-24">import java.util.Map.Entry;</span> |
| <span class="source-line-no">025</span><span id="line-25">import java.util.concurrent.ScheduledFuture;</span> |
| <span class="source-line-no">026</span><span id="line-26">import java.util.concurrent.ScheduledThreadPoolExecutor;</span> |
| <span class="source-line-no">027</span><span id="line-27">import java.util.concurrent.ThreadFactory;</span> |
| <span class="source-line-no">028</span><span id="line-28">import java.util.concurrent.atomic.AtomicInteger;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.trace.TraceUtil;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.slf4j.Logger;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">033</span><span id="line-33"></span> |
| <span class="source-line-no">034</span><span id="line-34">/**</span> |
| <span class="source-line-no">035</span><span id="line-35"> * ChoreService is a service that can be used to schedule instances of {@link ScheduledChore} to run</span> |
| <span class="source-line-no">036</span><span id="line-36"> * periodically while sharing threads. The ChoreService is backed by a</span> |
| <span class="source-line-no">037</span><span id="line-37"> * {@link ScheduledThreadPoolExecutor} whose core pool size changes dynamically depending on the</span> |
| <span class="source-line-no">038</span><span id="line-38"> * number of {@link ScheduledChore} scheduled. All of the threads in the core thread pool of the</span> |
| <span class="source-line-no">039</span><span id="line-39"> * underlying {@link ScheduledThreadPoolExecutor} are set to be daemon threads.</span> |
| <span class="source-line-no">040</span><span id="line-40"> * <p></span> |
| <span class="source-line-no">041</span><span id="line-41"> * The ChoreService provides the ability to schedule, cancel, and trigger instances of</span> |
| <span class="source-line-no">042</span><span id="line-42"> * {@link ScheduledChore}. The ChoreService also provides the ability to check on the status of</span> |
| <span class="source-line-no">043</span><span id="line-43"> * scheduled chores. The number of threads used by the ChoreService changes based on the scheduling</span> |
| <span class="source-line-no">044</span><span id="line-44"> * load and whether or not the scheduled chores are executing on time. As more chores are scheduled,</span> |
| <span class="source-line-no">045</span><span id="line-45"> * there may be a need to increase the number of threads if it is noticed that chores are no longer</span> |
| <span class="source-line-no">046</span><span id="line-46"> * meeting their scheduled start times. On the other hand, as chores are cancelled, an attempt is</span> |
| <span class="source-line-no">047</span><span id="line-47"> * made to reduce the number of running threads to see if chores can still meet their start times</span> |
| <span class="source-line-no">048</span><span id="line-48"> * with a smaller thread pool.</span> |
| <span class="source-line-no">049</span><span id="line-49"> * <p></span> |
| <span class="source-line-no">050</span><span id="line-50"> * When finished with a ChoreService it is good practice to call {@link ChoreService#shutdown()}.</span> |
| <span class="source-line-no">051</span><span id="line-51"> * Calling this method ensures that all scheduled chores are cancelled and cleaned up properly.</span> |
| <span class="source-line-no">052</span><span id="line-52"> */</span> |
| <span class="source-line-no">053</span><span id="line-53">@InterfaceAudience.Private</span> |
| <span class="source-line-no">054</span><span id="line-54">public class ChoreService {</span> |
| <span class="source-line-no">055</span><span id="line-55"> private static final Logger LOG = LoggerFactory.getLogger(ChoreService.class);</span> |
| <span class="source-line-no">056</span><span id="line-56"></span> |
| <span class="source-line-no">057</span><span id="line-57"> /**</span> |
| <span class="source-line-no">058</span><span id="line-58"> * The minimum number of threads in the core pool of the underlying ScheduledThreadPoolExecutor</span> |
| <span class="source-line-no">059</span><span id="line-59"> */</span> |
| <span class="source-line-no">060</span><span id="line-60"> @InterfaceAudience.Private</span> |
| <span class="source-line-no">061</span><span id="line-61"> public final static int MIN_CORE_POOL_SIZE = 1;</span> |
| <span class="source-line-no">062</span><span id="line-62"> /**</span> |
| <span class="source-line-no">063</span><span id="line-63"> * The initial number of threads in the core pool for the {@link ChoreService}.</span> |
| <span class="source-line-no">064</span><span id="line-64"> */</span> |
| <span class="source-line-no">065</span><span id="line-65"> public static final String CHORE_SERVICE_INITIAL_POOL_SIZE =</span> |
| <span class="source-line-no">066</span><span id="line-66"> "hbase.choreservice.initial.pool.size";</span> |
| <span class="source-line-no">067</span><span id="line-67"> public static final int DEFAULT_CHORE_SERVICE_INITIAL_POOL_SIZE = 1;</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"> * This thread pool is used to schedule all of the Chores</span> |
| <span class="source-line-no">071</span><span id="line-71"> */</span> |
| <span class="source-line-no">072</span><span id="line-72"> private final ScheduledThreadPoolExecutor scheduler;</span> |
| <span class="source-line-no">073</span><span id="line-73"></span> |
| <span class="source-line-no">074</span><span id="line-74"> /**</span> |
| <span class="source-line-no">075</span><span id="line-75"> * Maps chores to their futures. Futures are used to control a chore's schedule</span> |
| <span class="source-line-no">076</span><span id="line-76"> */</span> |
| <span class="source-line-no">077</span><span id="line-77"> private final HashMap<ScheduledChore, ScheduledFuture<?>> scheduledChores;</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"> * Maps chores to Booleans which indicate whether or not a chore has caused an increase in the</span> |
| <span class="source-line-no">081</span><span id="line-81"> * core pool size of the ScheduledThreadPoolExecutor. Each chore should only be allowed to</span> |
| <span class="source-line-no">082</span><span id="line-82"> * increase the core pool size by 1 (otherwise a single long running chore whose execution is</span> |
| <span class="source-line-no">083</span><span id="line-83"> * longer than its period would be able to spawn too many threads).</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 HashMap<ScheduledChore, Boolean> choresMissingStartTime;</span> |
| <span class="source-line-no">086</span><span id="line-86"></span> |
| <span class="source-line-no">087</span><span id="line-87"> /**</span> |
| <span class="source-line-no">088</span><span id="line-88"> * The coreThreadPoolPrefix is the prefix that will be applied to all threads within the</span> |
| <span class="source-line-no">089</span><span id="line-89"> * ScheduledThreadPoolExecutor. The prefix is typically related to the Server that the service is</span> |
| <span class="source-line-no">090</span><span id="line-90"> * running on. The prefix is useful because it allows us to monitor how the thread pool of a</span> |
| <span class="source-line-no">091</span><span id="line-91"> * particular service changes over time VIA thread dumps.</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 String coreThreadPoolPrefix;</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"> * @param coreThreadPoolPrefix Prefix that will be applied to the Thread name of all threads</span> |
| <span class="source-line-no">097</span><span id="line-97"> * spawned by this service</span> |
| <span class="source-line-no">098</span><span id="line-98"> */</span> |
| <span class="source-line-no">099</span><span id="line-99"> @InterfaceAudience.Private</span> |
| <span class="source-line-no">100</span><span id="line-100"> public ChoreService(final String coreThreadPoolPrefix) {</span> |
| <span class="source-line-no">101</span><span id="line-101"> this(coreThreadPoolPrefix, MIN_CORE_POOL_SIZE, false);</span> |
| <span class="source-line-no">102</span><span id="line-102"> }</span> |
| <span class="source-line-no">103</span><span id="line-103"></span> |
| <span class="source-line-no">104</span><span id="line-104"> /**</span> |
| <span class="source-line-no">105</span><span id="line-105"> * @param coreThreadPoolPrefix Prefix that will be applied to the Thread name of all threads</span> |
| <span class="source-line-no">106</span><span id="line-106"> * spawned by this service</span> |
| <span class="source-line-no">107</span><span id="line-107"> * @param jitter Should chore service add some jitter for all of the scheduled</span> |
| <span class="source-line-no">108</span><span id="line-108"> * chores. When set to true this will add -10% to 10% jitter.</span> |
| <span class="source-line-no">109</span><span id="line-109"> */</span> |
| <span class="source-line-no">110</span><span id="line-110"> public ChoreService(final String coreThreadPoolPrefix, final boolean jitter) {</span> |
| <span class="source-line-no">111</span><span id="line-111"> this(coreThreadPoolPrefix, MIN_CORE_POOL_SIZE, jitter);</span> |
| <span class="source-line-no">112</span><span id="line-112"> }</span> |
| <span class="source-line-no">113</span><span id="line-113"></span> |
| <span class="source-line-no">114</span><span id="line-114"> /**</span> |
| <span class="source-line-no">115</span><span id="line-115"> * @param coreThreadPoolPrefix Prefix that will be applied to the Thread name of all threads</span> |
| <span class="source-line-no">116</span><span id="line-116"> * spawned by this service</span> |
| <span class="source-line-no">117</span><span id="line-117"> * @param corePoolSize The initial size to set the core pool of the</span> |
| <span class="source-line-no">118</span><span id="line-118"> * ScheduledThreadPoolExecutor to during initialization. The default</span> |
| <span class="source-line-no">119</span><span id="line-119"> * size is 1, but specifying a larger size may be beneficial if you</span> |
| <span class="source-line-no">120</span><span id="line-120"> * know that 1 thread will not be enough.</span> |
| <span class="source-line-no">121</span><span id="line-121"> * @param jitter Should chore service add some jitter for all of the scheduled</span> |
| <span class="source-line-no">122</span><span id="line-122"> * chores. When set to true this will add -10% to 10% jitter.</span> |
| <span class="source-line-no">123</span><span id="line-123"> */</span> |
| <span class="source-line-no">124</span><span id="line-124"> public ChoreService(final String coreThreadPoolPrefix, int corePoolSize, boolean jitter) {</span> |
| <span class="source-line-no">125</span><span id="line-125"> this.coreThreadPoolPrefix = coreThreadPoolPrefix;</span> |
| <span class="source-line-no">126</span><span id="line-126"> if (corePoolSize < MIN_CORE_POOL_SIZE) {</span> |
| <span class="source-line-no">127</span><span id="line-127"> corePoolSize = MIN_CORE_POOL_SIZE;</span> |
| <span class="source-line-no">128</span><span id="line-128"> }</span> |
| <span class="source-line-no">129</span><span id="line-129"></span> |
| <span class="source-line-no">130</span><span id="line-130"> final ThreadFactory threadFactory = new ChoreServiceThreadFactory(coreThreadPoolPrefix);</span> |
| <span class="source-line-no">131</span><span id="line-131"> if (jitter) {</span> |
| <span class="source-line-no">132</span><span id="line-132"> scheduler = new JitterScheduledThreadPoolExecutorImpl(corePoolSize, threadFactory, 0.1);</span> |
| <span class="source-line-no">133</span><span id="line-133"> } else {</span> |
| <span class="source-line-no">134</span><span id="line-134"> scheduler = new ScheduledThreadPoolExecutor(corePoolSize, threadFactory);</span> |
| <span class="source-line-no">135</span><span id="line-135"> }</span> |
| <span class="source-line-no">136</span><span id="line-136"></span> |
| <span class="source-line-no">137</span><span id="line-137"> scheduler.setRemoveOnCancelPolicy(true);</span> |
| <span class="source-line-no">138</span><span id="line-138"> scheduledChores = new HashMap<>();</span> |
| <span class="source-line-no">139</span><span id="line-139"> choresMissingStartTime = new HashMap<>();</span> |
| <span class="source-line-no">140</span><span id="line-140"> }</span> |
| <span class="source-line-no">141</span><span id="line-141"></span> |
| <span class="source-line-no">142</span><span id="line-142"> /**</span> |
| <span class="source-line-no">143</span><span id="line-143"> * Schedule a chore.</span> |
| <span class="source-line-no">144</span><span id="line-144"> * @param chore Chore to be scheduled. If the chore is already scheduled with another ChoreService</span> |
| <span class="source-line-no">145</span><span id="line-145"> * instance, that schedule will be cancelled (i.e. a Chore can only ever be scheduled</span> |
| <span class="source-line-no">146</span><span id="line-146"> * with a single ChoreService instance).</span> |
| <span class="source-line-no">147</span><span id="line-147"> * @return true when the chore was successfully scheduled. false when the scheduling failed</span> |
| <span class="source-line-no">148</span><span id="line-148"> * (typically occurs when a chore is scheduled during shutdown of service)</span> |
| <span class="source-line-no">149</span><span id="line-149"> */</span> |
| <span class="source-line-no">150</span><span id="line-150"> public boolean scheduleChore(ScheduledChore chore) {</span> |
| <span class="source-line-no">151</span><span id="line-151"> if (chore == null) {</span> |
| <span class="source-line-no">152</span><span id="line-152"> return false;</span> |
| <span class="source-line-no">153</span><span id="line-153"> }</span> |
| <span class="source-line-no">154</span><span id="line-154"> // always lock chore first to prevent dead lock</span> |
| <span class="source-line-no">155</span><span id="line-155"> synchronized (chore) {</span> |
| <span class="source-line-no">156</span><span id="line-156"> synchronized (this) {</span> |
| <span class="source-line-no">157</span><span id="line-157"> try {</span> |
| <span class="source-line-no">158</span><span id="line-158"> // Chores should only ever be scheduled with a single ChoreService. If the choreService</span> |
| <span class="source-line-no">159</span><span id="line-159"> // is changing, cancel any existing schedules of this chore.</span> |
| <span class="source-line-no">160</span><span id="line-160"> if (chore.getChoreService() == this) {</span> |
| <span class="source-line-no">161</span><span id="line-161"> LOG.warn("Chore {} has already been scheduled with us", chore);</span> |
| <span class="source-line-no">162</span><span id="line-162"> return false;</span> |
| <span class="source-line-no">163</span><span id="line-163"> }</span> |
| <span class="source-line-no">164</span><span id="line-164"> if (chore.getPeriod() <= 0) {</span> |
| <span class="source-line-no">165</span><span id="line-165"> LOG.info("Chore {} is disabled because its period is not positive.", chore);</span> |
| <span class="source-line-no">166</span><span id="line-166"> return false;</span> |
| <span class="source-line-no">167</span><span id="line-167"> }</span> |
| <span class="source-line-no">168</span><span id="line-168"> LOG.info("Chore {} is enabled.", chore);</span> |
| <span class="source-line-no">169</span><span id="line-169"> if (chore.getChoreService() != null) {</span> |
| <span class="source-line-no">170</span><span id="line-170"> LOG.info("Cancel chore {} from its previous service", chore);</span> |
| <span class="source-line-no">171</span><span id="line-171"> chore.getChoreService().cancelChore(chore);</span> |
| <span class="source-line-no">172</span><span id="line-172"> }</span> |
| <span class="source-line-no">173</span><span id="line-173"> chore.setChoreService(this);</span> |
| <span class="source-line-no">174</span><span id="line-174"> ScheduledFuture<?> future =</span> |
| <span class="source-line-no">175</span><span id="line-175"> scheduler.scheduleAtFixedRate(TraceUtil.tracedRunnable(chore, chore.getName()),</span> |
| <span class="source-line-no">176</span><span id="line-176"> chore.getInitialDelay(), chore.getPeriod(), chore.getTimeUnit());</span> |
| <span class="source-line-no">177</span><span id="line-177"> scheduledChores.put(chore, future);</span> |
| <span class="source-line-no">178</span><span id="line-178"> return true;</span> |
| <span class="source-line-no">179</span><span id="line-179"> } catch (Exception e) {</span> |
| <span class="source-line-no">180</span><span id="line-180"> LOG.error("Could not successfully schedule chore: {}", chore.getName(), e);</span> |
| <span class="source-line-no">181</span><span id="line-181"> return false;</span> |
| <span class="source-line-no">182</span><span id="line-182"> }</span> |
| <span class="source-line-no">183</span><span id="line-183"> }</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"></span> |
| <span class="source-line-no">187</span><span id="line-187"> /**</span> |
| <span class="source-line-no">188</span><span id="line-188"> * @param chore The Chore to be rescheduled. If the chore is not scheduled with this ChoreService</span> |
| <span class="source-line-no">189</span><span id="line-189"> * yet then this call is equivalent to a call to scheduleChore.</span> |
| <span class="source-line-no">190</span><span id="line-190"> */</span> |
| <span class="source-line-no">191</span><span id="line-191"> private void rescheduleChore(ScheduledChore chore, boolean immediately) {</span> |
| <span class="source-line-no">192</span><span id="line-192"> if (scheduledChores.containsKey(chore)) {</span> |
| <span class="source-line-no">193</span><span id="line-193"> ScheduledFuture<?> future = scheduledChores.get(chore);</span> |
| <span class="source-line-no">194</span><span id="line-194"> future.cancel(false);</span> |
| <span class="source-line-no">195</span><span id="line-195"> }</span> |
| <span class="source-line-no">196</span><span id="line-196"> // set initial delay to 0 as we want to run it immediately</span> |
| <span class="source-line-no">197</span><span id="line-197"> ScheduledFuture<?> future = scheduler.scheduleAtFixedRate(chore,</span> |
| <span class="source-line-no">198</span><span id="line-198"> immediately ? 0 : chore.getPeriod(), chore.getPeriod(), chore.getTimeUnit());</span> |
| <span class="source-line-no">199</span><span id="line-199"> scheduledChores.put(chore, future);</span> |
| <span class="source-line-no">200</span><span id="line-200"> }</span> |
| <span class="source-line-no">201</span><span id="line-201"></span> |
| <span class="source-line-no">202</span><span id="line-202"> /**</span> |
| <span class="source-line-no">203</span><span id="line-203"> * Cancel any ongoing schedules that this chore has with the implementer of this interface.</span> |
| <span class="source-line-no">204</span><span id="line-204"> * <p/></span> |
| <span class="source-line-no">205</span><span id="line-205"> * Call {@link ScheduledChore#cancel()} to cancel a {@link ScheduledChore}, in</span> |
| <span class="source-line-no">206</span><span id="line-206"> * {@link ScheduledChore#cancel()} method we will call this method to remove the</span> |
| <span class="source-line-no">207</span><span id="line-207"> * {@link ScheduledChore} from this {@link ChoreService}.</span> |
| <span class="source-line-no">208</span><span id="line-208"> */</span> |
| <span class="source-line-no">209</span><span id="line-209"> @RestrictedApi(explanation = "Should only be called in ScheduledChore", link = "",</span> |
| <span class="source-line-no">210</span><span id="line-210"> allowedOnPath = ".*/org/apache/hadoop/hbase/(ScheduledChore|ChoreService).java")</span> |
| <span class="source-line-no">211</span><span id="line-211"> synchronized void cancelChore(ScheduledChore chore) {</span> |
| <span class="source-line-no">212</span><span id="line-212"> cancelChore(chore, true);</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"> * Cancel any ongoing schedules that this chore has with the implementer of this interface.</span> |
| <span class="source-line-no">217</span><span id="line-217"> * <p/></span> |
| <span class="source-line-no">218</span><span id="line-218"> * Call {@link ScheduledChore#cancel(boolean)} to cancel a {@link ScheduledChore}, in</span> |
| <span class="source-line-no">219</span><span id="line-219"> * {@link ScheduledChore#cancel(boolean)} method we will call this method to remove the</span> |
| <span class="source-line-no">220</span><span id="line-220"> * {@link ScheduledChore} from this {@link ChoreService}.</span> |
| <span class="source-line-no">221</span><span id="line-221"> */</span> |
| <span class="source-line-no">222</span><span id="line-222"> @RestrictedApi(explanation = "Should only be called in ScheduledChore", link = "",</span> |
| <span class="source-line-no">223</span><span id="line-223"> allowedOnPath = ".*/org/apache/hadoop/hbase/(ScheduledChore|ChoreService).java")</span> |
| <span class="source-line-no">224</span><span id="line-224"> synchronized void cancelChore(ScheduledChore chore, boolean mayInterruptIfRunning) {</span> |
| <span class="source-line-no">225</span><span id="line-225"> if (scheduledChores.containsKey(chore)) {</span> |
| <span class="source-line-no">226</span><span id="line-226"> ScheduledFuture<?> future = scheduledChores.get(chore);</span> |
| <span class="source-line-no">227</span><span id="line-227"> future.cancel(mayInterruptIfRunning);</span> |
| <span class="source-line-no">228</span><span id="line-228"> scheduledChores.remove(chore);</span> |
| <span class="source-line-no">229</span><span id="line-229"></span> |
| <span class="source-line-no">230</span><span id="line-230"> // Removing a chore that was missing its start time means it may be possible</span> |
| <span class="source-line-no">231</span><span id="line-231"> // to reduce the number of threads</span> |
| <span class="source-line-no">232</span><span id="line-232"> if (choresMissingStartTime.containsKey(chore)) {</span> |
| <span class="source-line-no">233</span><span id="line-233"> choresMissingStartTime.remove(chore);</span> |
| <span class="source-line-no">234</span><span id="line-234"> requestCorePoolDecrease();</span> |
| <span class="source-line-no">235</span><span id="line-235"> }</span> |
| <span class="source-line-no">236</span><span id="line-236"> }</span> |
| <span class="source-line-no">237</span><span id="line-237"> }</span> |
| <span class="source-line-no">238</span><span id="line-238"></span> |
| <span class="source-line-no">239</span><span id="line-239"> /** Returns true when the chore is scheduled with the implementer of this interface */</span> |
| <span class="source-line-no">240</span><span id="line-240"> @InterfaceAudience.Private</span> |
| <span class="source-line-no">241</span><span id="line-241"> public synchronized boolean isChoreScheduled(ScheduledChore chore) {</span> |
| <span class="source-line-no">242</span><span id="line-242"> return chore != null && scheduledChores.containsKey(chore)</span> |
| <span class="source-line-no">243</span><span id="line-243"> && !scheduledChores.get(chore).isDone();</span> |
| <span class="source-line-no">244</span><span id="line-244"> }</span> |
| <span class="source-line-no">245</span><span id="line-245"></span> |
| <span class="source-line-no">246</span><span id="line-246"> /**</span> |
| <span class="source-line-no">247</span><span id="line-247"> * This method tries to execute the chore immediately. If the chore is executing at the time of</span> |
| <span class="source-line-no">248</span><span id="line-248"> * this call, the chore will begin another execution as soon as the current execution finishes</span> |
| <span class="source-line-no">249</span><span id="line-249"> */</span> |
| <span class="source-line-no">250</span><span id="line-250"> @RestrictedApi(explanation = "Should only be called in ScheduledChore", link = "",</span> |
| <span class="source-line-no">251</span><span id="line-251"> allowedOnPath = ".*/org/apache/hadoop/hbase/ScheduledChore.java")</span> |
| <span class="source-line-no">252</span><span id="line-252"> synchronized void triggerNow(ScheduledChore chore) {</span> |
| <span class="source-line-no">253</span><span id="line-253"> assert chore.getChoreService() == this;</span> |
| <span class="source-line-no">254</span><span id="line-254"> rescheduleChore(chore, true);</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"> /** Returns number of chores that this service currently has scheduled */</span> |
| <span class="source-line-no">258</span><span id="line-258"> int getNumberOfScheduledChores() {</span> |
| <span class="source-line-no">259</span><span id="line-259"> return scheduledChores.size();</span> |
| <span class="source-line-no">260</span><span id="line-260"> }</span> |
| <span class="source-line-no">261</span><span id="line-261"></span> |
| <span class="source-line-no">262</span><span id="line-262"> /**</span> |
| <span class="source-line-no">263</span><span id="line-263"> * Return number of chores that this service currently has scheduled that are missing their</span> |
| <span class="source-line-no">264</span><span id="line-264"> * scheduled start time</span> |
| <span class="source-line-no">265</span><span id="line-265"> */</span> |
| <span class="source-line-no">266</span><span id="line-266"> int getNumberOfChoresMissingStartTime() {</span> |
| <span class="source-line-no">267</span><span id="line-267"> return choresMissingStartTime.size();</span> |
| <span class="source-line-no">268</span><span id="line-268"> }</span> |
| <span class="source-line-no">269</span><span id="line-269"></span> |
| <span class="source-line-no">270</span><span id="line-270"> /** Returns number of threads in the core pool of the underlying ScheduledThreadPoolExecutor */</span> |
| <span class="source-line-no">271</span><span id="line-271"> int getCorePoolSize() {</span> |
| <span class="source-line-no">272</span><span id="line-272"> return scheduler.getCorePoolSize();</span> |
| <span class="source-line-no">273</span><span id="line-273"> }</span> |
| <span class="source-line-no">274</span><span id="line-274"></span> |
| <span class="source-line-no">275</span><span id="line-275"> /**</span> |
| <span class="source-line-no">276</span><span id="line-276"> * Custom ThreadFactory used with the ScheduledThreadPoolExecutor so that all the threads are</span> |
| <span class="source-line-no">277</span><span id="line-277"> * daemon threads, and thus, don't prevent the JVM from shutting down</span> |
| <span class="source-line-no">278</span><span id="line-278"> */</span> |
| <span class="source-line-no">279</span><span id="line-279"> static class ChoreServiceThreadFactory implements ThreadFactory {</span> |
| <span class="source-line-no">280</span><span id="line-280"> private final String threadPrefix;</span> |
| <span class="source-line-no">281</span><span id="line-281"> private final static String THREAD_NAME_SUFFIX = ".Chore.";</span> |
| <span class="source-line-no">282</span><span id="line-282"> private AtomicInteger threadNumber = new AtomicInteger(1);</span> |
| <span class="source-line-no">283</span><span id="line-283"></span> |
| <span class="source-line-no">284</span><span id="line-284"> public ChoreServiceThreadFactory(final String threadPrefix) {</span> |
| <span class="source-line-no">285</span><span id="line-285"> this.threadPrefix = threadPrefix;</span> |
| <span class="source-line-no">286</span><span id="line-286"> }</span> |
| <span class="source-line-no">287</span><span id="line-287"></span> |
| <span class="source-line-no">288</span><span id="line-288"> @Override</span> |
| <span class="source-line-no">289</span><span id="line-289"> public Thread newThread(Runnable r) {</span> |
| <span class="source-line-no">290</span><span id="line-290"> Thread thread =</span> |
| <span class="source-line-no">291</span><span id="line-291"> new Thread(r, threadPrefix + THREAD_NAME_SUFFIX + threadNumber.getAndIncrement());</span> |
| <span class="source-line-no">292</span><span id="line-292"> thread.setDaemon(true);</span> |
| <span class="source-line-no">293</span><span id="line-293"> return thread;</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"> /**</span> |
| <span class="source-line-no">298</span><span id="line-298"> * Represents a request to increase the number of core pool threads. Typically a request</span> |
| <span class="source-line-no">299</span><span id="line-299"> * originates from the fact that the current core pool size is not sufficient to service all of</span> |
| <span class="source-line-no">300</span><span id="line-300"> * the currently running Chores</span> |
| <span class="source-line-no">301</span><span id="line-301"> * @return true when the request to increase the core pool size succeeds</span> |
| <span class="source-line-no">302</span><span id="line-302"> */</span> |
| <span class="source-line-no">303</span><span id="line-303"> private synchronized boolean requestCorePoolIncrease() {</span> |
| <span class="source-line-no">304</span><span id="line-304"> // There is no point in creating more threads than scheduledChores.size since scheduled runs</span> |
| <span class="source-line-no">305</span><span id="line-305"> // of the same chore cannot run concurrently (i.e. happen-before behavior is enforced</span> |
| <span class="source-line-no">306</span><span id="line-306"> // amongst occurrences of the same chore).</span> |
| <span class="source-line-no">307</span><span id="line-307"> if (scheduler.getCorePoolSize() < scheduledChores.size()) {</span> |
| <span class="source-line-no">308</span><span id="line-308"> scheduler.setCorePoolSize(scheduler.getCorePoolSize() + 1);</span> |
| <span class="source-line-no">309</span><span id="line-309"> printChoreServiceDetails("requestCorePoolIncrease");</span> |
| <span class="source-line-no">310</span><span id="line-310"> return true;</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;</span> |
| <span class="source-line-no">313</span><span id="line-313"> }</span> |
| <span class="source-line-no">314</span><span id="line-314"></span> |
| <span class="source-line-no">315</span><span id="line-315"> /**</span> |
| <span class="source-line-no">316</span><span id="line-316"> * Represents a request to decrease the number of core pool threads. Typically a request</span> |
| <span class="source-line-no">317</span><span id="line-317"> * originates from the fact that the current core pool size is more than sufficient to service the</span> |
| <span class="source-line-no">318</span><span id="line-318"> * running Chores.</span> |
| <span class="source-line-no">319</span><span id="line-319"> */</span> |
| <span class="source-line-no">320</span><span id="line-320"> private synchronized void requestCorePoolDecrease() {</span> |
| <span class="source-line-no">321</span><span id="line-321"> if (scheduler.getCorePoolSize() > MIN_CORE_POOL_SIZE) {</span> |
| <span class="source-line-no">322</span><span id="line-322"> scheduler.setCorePoolSize(scheduler.getCorePoolSize() - 1);</span> |
| <span class="source-line-no">323</span><span id="line-323"> printChoreServiceDetails("requestCorePoolDecrease");</span> |
| <span class="source-line-no">324</span><span id="line-324"> }</span> |
| <span class="source-line-no">325</span><span id="line-325"> }</span> |
| <span class="source-line-no">326</span><span id="line-326"></span> |
| <span class="source-line-no">327</span><span id="line-327"> /**</span> |
| <span class="source-line-no">328</span><span id="line-328"> * A callback that tells the implementer of this interface that one of the scheduled chores is</span> |
| <span class="source-line-no">329</span><span id="line-329"> * missing its start time. The implication of a chore missing its start time is that the service's</span> |
| <span class="source-line-no">330</span><span id="line-330"> * current means of scheduling may not be sufficient to handle the number of ongoing chores (the</span> |
| <span class="source-line-no">331</span><span id="line-331"> * other explanation is that the chore's execution time is greater than its scheduled period). The</span> |
| <span class="source-line-no">332</span><span id="line-332"> * service should try to increase its concurrency when this callback is received.</span> |
| <span class="source-line-no">333</span><span id="line-333"> * @param chore The chore that missed its start time</span> |
| <span class="source-line-no">334</span><span id="line-334"> */</span> |
| <span class="source-line-no">335</span><span id="line-335"> @RestrictedApi(explanation = "Should only be called in ScheduledChore", link = "",</span> |
| <span class="source-line-no">336</span><span id="line-336"> allowedOnPath = ".*/org/apache/hadoop/hbase/ScheduledChore.java")</span> |
| <span class="source-line-no">337</span><span id="line-337"> synchronized void onChoreMissedStartTime(ScheduledChore chore) {</span> |
| <span class="source-line-no">338</span><span id="line-338"> if (!scheduledChores.containsKey(chore)) {</span> |
| <span class="source-line-no">339</span><span id="line-339"> return;</span> |
| <span class="source-line-no">340</span><span id="line-340"> }</span> |
| <span class="source-line-no">341</span><span id="line-341"></span> |
| <span class="source-line-no">342</span><span id="line-342"> // If the chore has not caused an increase in the size of the core thread pool then request an</span> |
| <span class="source-line-no">343</span><span id="line-343"> // increase. This allows each chore missing its start time to increase the core pool size by</span> |
| <span class="source-line-no">344</span><span id="line-344"> // at most 1.</span> |
| <span class="source-line-no">345</span><span id="line-345"> if (!choresMissingStartTime.containsKey(chore) || !choresMissingStartTime.get(chore)) {</span> |
| <span class="source-line-no">346</span><span id="line-346"> choresMissingStartTime.put(chore, requestCorePoolIncrease());</span> |
| <span class="source-line-no">347</span><span id="line-347"> }</span> |
| <span class="source-line-no">348</span><span id="line-348"></span> |
| <span class="source-line-no">349</span><span id="line-349"> // Must reschedule the chore to prevent unnecessary delays of chores in the scheduler. If</span> |
| <span class="source-line-no">350</span><span id="line-350"> // the chore is NOT rescheduled, future executions of this chore will be delayed more and</span> |
| <span class="source-line-no">351</span><span id="line-351"> // more on each iteration. This hurts us because the ScheduledThreadPoolExecutor allocates</span> |
| <span class="source-line-no">352</span><span id="line-352"> // idle threads to chores based on how delayed they are.</span> |
| <span class="source-line-no">353</span><span id="line-353"> rescheduleChore(chore, false);</span> |
| <span class="source-line-no">354</span><span id="line-354"> printChoreDetails("onChoreMissedStartTime", chore);</span> |
| <span class="source-line-no">355</span><span id="line-355"> }</span> |
| <span class="source-line-no">356</span><span id="line-356"></span> |
| <span class="source-line-no">357</span><span id="line-357"> /**</span> |
| <span class="source-line-no">358</span><span id="line-358"> * Shut down the service. Any chores that are scheduled for execution will be cancelled. Any</span> |
| <span class="source-line-no">359</span><span id="line-359"> * chores in the middle of execution will be interrupted and shutdown. This service will be</span> |
| <span class="source-line-no">360</span><span id="line-360"> * unusable after this method has been called (i.e. future scheduling attempts will fail).</span> |
| <span class="source-line-no">361</span><span id="line-361"> * <p/></span> |
| <span class="source-line-no">362</span><span id="line-362"> * Notice that, this will only clean the chore from this ChoreService but you could still schedule</span> |
| <span class="source-line-no">363</span><span id="line-363"> * the chore with other ChoreService.</span> |
| <span class="source-line-no">364</span><span id="line-364"> */</span> |
| <span class="source-line-no">365</span><span id="line-365"> public synchronized void shutdown() {</span> |
| <span class="source-line-no">366</span><span id="line-366"> if (isShutdown()) {</span> |
| <span class="source-line-no">367</span><span id="line-367"> return;</span> |
| <span class="source-line-no">368</span><span id="line-368"> }</span> |
| <span class="source-line-no">369</span><span id="line-369"> scheduler.shutdownNow();</span> |
| <span class="source-line-no">370</span><span id="line-370"> LOG.info("Chore service for: {} had {} on shutdown", coreThreadPoolPrefix,</span> |
| <span class="source-line-no">371</span><span id="line-371"> scheduledChores.keySet());</span> |
| <span class="source-line-no">372</span><span id="line-372"> cancelAllChores(true);</span> |
| <span class="source-line-no">373</span><span id="line-373"> scheduledChores.clear();</span> |
| <span class="source-line-no">374</span><span id="line-374"> choresMissingStartTime.clear();</span> |
| <span class="source-line-no">375</span><span id="line-375"> }</span> |
| <span class="source-line-no">376</span><span id="line-376"></span> |
| <span class="source-line-no">377</span><span id="line-377"> /** Returns true when the service is shutdown and thus cannot be used anymore */</span> |
| <span class="source-line-no">378</span><span id="line-378"> public boolean isShutdown() {</span> |
| <span class="source-line-no">379</span><span id="line-379"> return scheduler.isShutdown();</span> |
| <span class="source-line-no">380</span><span id="line-380"> }</span> |
| <span class="source-line-no">381</span><span id="line-381"></span> |
| <span class="source-line-no">382</span><span id="line-382"> /** Returns true when the service is shutdown and all threads have terminated */</span> |
| <span class="source-line-no">383</span><span id="line-383"> public boolean isTerminated() {</span> |
| <span class="source-line-no">384</span><span id="line-384"> return scheduler.isTerminated();</span> |
| <span class="source-line-no">385</span><span id="line-385"> }</span> |
| <span class="source-line-no">386</span><span id="line-386"></span> |
| <span class="source-line-no">387</span><span id="line-387"> private void cancelAllChores(final boolean mayInterruptIfRunning) {</span> |
| <span class="source-line-no">388</span><span id="line-388"> // Build list of chores to cancel so we can iterate through a set that won't change</span> |
| <span class="source-line-no">389</span><span id="line-389"> // as chores are cancelled. If we tried to cancel each chore while iterating through</span> |
| <span class="source-line-no">390</span><span id="line-390"> // keySet the results would be undefined because the keySet would be changing</span> |
| <span class="source-line-no">391</span><span id="line-391"> ArrayList<ScheduledChore> choresToCancel = new ArrayList<>(scheduledChores.keySet());</span> |
| <span class="source-line-no">392</span><span id="line-392"></span> |
| <span class="source-line-no">393</span><span id="line-393"> for (ScheduledChore chore : choresToCancel) {</span> |
| <span class="source-line-no">394</span><span id="line-394"> cancelChore(chore, mayInterruptIfRunning);</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"></span> |
| <span class="source-line-no">398</span><span id="line-398"> /** Prints a summary of important details about the chore. Used for debugging purposes */</span> |
| <span class="source-line-no">399</span><span id="line-399"> private void printChoreDetails(final String header, ScheduledChore chore) {</span> |
| <span class="source-line-no">400</span><span id="line-400"> if (!LOG.isTraceEnabled()) {</span> |
| <span class="source-line-no">401</span><span id="line-401"> return;</span> |
| <span class="source-line-no">402</span><span id="line-402"> }</span> |
| <span class="source-line-no">403</span><span id="line-403"> LinkedHashMap<String, String> output = new LinkedHashMap<>();</span> |
| <span class="source-line-no">404</span><span id="line-404"> output.put(header, "");</span> |
| <span class="source-line-no">405</span><span id="line-405"> output.put("Chore name: ", chore.getName());</span> |
| <span class="source-line-no">406</span><span id="line-406"> output.put("Chore period: ", Integer.toString(chore.getPeriod()));</span> |
| <span class="source-line-no">407</span><span id="line-407"> output.put("Chore timeBetweenRuns: ", Long.toString(chore.getTimeBetweenRuns()));</span> |
| <span class="source-line-no">408</span><span id="line-408"></span> |
| <span class="source-line-no">409</span><span id="line-409"> for (Entry<String, String> entry : output.entrySet()) {</span> |
| <span class="source-line-no">410</span><span id="line-410"> LOG.trace(entry.getKey() + entry.getValue());</span> |
| <span class="source-line-no">411</span><span id="line-411"> }</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"> /** Prints a summary of important details about the service. Used for debugging purposes */</span> |
| <span class="source-line-no">415</span><span id="line-415"> private void printChoreServiceDetails(final String header) {</span> |
| <span class="source-line-no">416</span><span id="line-416"> if (!LOG.isTraceEnabled()) {</span> |
| <span class="source-line-no">417</span><span id="line-417"> return;</span> |
| <span class="source-line-no">418</span><span id="line-418"> }</span> |
| <span class="source-line-no">419</span><span id="line-419"> LinkedHashMap<String, String> output = new LinkedHashMap<>();</span> |
| <span class="source-line-no">420</span><span id="line-420"> output.put(header, "");</span> |
| <span class="source-line-no">421</span><span id="line-421"> output.put("ChoreService corePoolSize: ", Integer.toString(getCorePoolSize()));</span> |
| <span class="source-line-no">422</span><span id="line-422"> output.put("ChoreService scheduledChores: ", Integer.toString(getNumberOfScheduledChores()));</span> |
| <span class="source-line-no">423</span><span id="line-423"> output.put("ChoreService missingStartTimeCount: ",</span> |
| <span class="source-line-no">424</span><span id="line-424"> Integer.toString(getNumberOfChoresMissingStartTime()));</span> |
| <span class="source-line-no">425</span><span id="line-425"></span> |
| <span class="source-line-no">426</span><span id="line-426"> for (Entry<String, String> entry : output.entrySet()) {</span> |
| <span class="source-line-no">427</span><span id="line-427"> LOG.trace(entry.getKey() + entry.getValue());</span> |
| <span class="source-line-no">428</span><span id="line-428"> }</span> |
| <span class="source-line-no">429</span><span id="line-429"> }</span> |
| <span class="source-line-no">430</span><span id="line-430">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
