| <!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> *<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * or more contributor license agreements. See the NOTICE file<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * distributed with this work for additional information<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * regarding copyright ownership. The ASF licenses this file<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * to you under the Apache License, Version 2.0 (the<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * "License"); you may not use this file except in compliance<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * with the License. You may obtain a copy of the License at<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> *<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * Unless required by applicable law or agreed to in writing, software<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * See the License for the specific language governing permissions and<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * limitations under the License.<a name="line.17"></a> |
| <span class="sourceLineNo">018</span> */<a name="line.18"></a> |
| <span class="sourceLineNo">019</span>package org.apache.hadoop.hbase;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.ArrayList;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.HashMap;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.LinkedHashMap;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.Map.Entry;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.util.concurrent.ScheduledFuture;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.concurrent.ScheduledThreadPoolExecutor;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.util.concurrent.ThreadFactory;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import java.util.concurrent.atomic.AtomicInteger;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span><a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.ScheduledChore.ChoreServicer;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.slf4j.Logger;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.slf4j.LoggerFactory;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span><a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.hbase.thirdparty.com.google.common.annotations.VisibleForTesting;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span><a name="line.36"></a> |
| <span class="sourceLineNo">037</span>/**<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * ChoreService is a service that can be used to schedule instances of {@link ScheduledChore} to run<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * periodically while sharing threads. The ChoreService is backed by a<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * {@link ScheduledThreadPoolExecutor} whose core pool size changes dynamically depending on the<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * number of {@link ScheduledChore} scheduled. All of the threads in the core thread pool of the<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * underlying {@link ScheduledThreadPoolExecutor} are set to be daemon threads.<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * <p><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * The ChoreService provides the ability to schedule, cancel, and trigger instances of<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * {@link ScheduledChore}. The ChoreService also provides the ability to check on the status of<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * scheduled chores. The number of threads used by the ChoreService changes based on the scheduling<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * load and whether or not the scheduled chores are executing on time. As more chores are scheduled,<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * there may be a need to increase the number of threads if it is noticed that chores are no longer<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * meeting their scheduled start times. On the other hand, as chores are cancelled, an attempt is<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * made to reduce the number of running threads to see if chores can still meet their start times<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * with a smaller thread pool.<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * <p><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * When finished with a ChoreService it is good practice to call {@link ChoreService#shutdown()}.<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * Calling this method ensures that all scheduled chores are cancelled and cleaned up properly.<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> */<a name="line.55"></a> |
| <span class="sourceLineNo">056</span>@InterfaceAudience.Public<a name="line.56"></a> |
| <span class="sourceLineNo">057</span>public class ChoreService implements ChoreServicer {<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> private static final Logger LOG = LoggerFactory.getLogger(ChoreService.class);<a name="line.58"></a> |
| <span class="sourceLineNo">059</span><a name="line.59"></a> |
| <span class="sourceLineNo">060</span> /**<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * The minimum number of threads in the core pool of the underlying ScheduledThreadPoolExecutor<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> */<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> @InterfaceAudience.Private<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> public final static int MIN_CORE_POOL_SIZE = 1;<a name="line.64"></a> |
| <span class="sourceLineNo">065</span><a name="line.65"></a> |
| <span class="sourceLineNo">066</span> /**<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * This thread pool is used to schedule all of the Chores<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> */<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> private final ScheduledThreadPoolExecutor scheduler;<a name="line.69"></a> |
| <span class="sourceLineNo">070</span><a name="line.70"></a> |
| <span class="sourceLineNo">071</span> /**<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * Maps chores to their futures. Futures are used to control a chore's schedule<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> */<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> private final HashMap<ScheduledChore, ScheduledFuture<?>> scheduledChores;<a name="line.74"></a> |
| <span class="sourceLineNo">075</span><a name="line.75"></a> |
| <span class="sourceLineNo">076</span> /**<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * Maps chores to Booleans which indicate whether or not a chore has caused an increase in the<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * core pool size of the ScheduledThreadPoolExecutor. Each chore should only be allowed to<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * increase the core pool size by 1 (otherwise a single long running chore whose execution is<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * longer than its period would be able to spawn too many threads).<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> */<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> private final HashMap<ScheduledChore, Boolean> choresMissingStartTime;<a name="line.82"></a> |
| <span class="sourceLineNo">083</span><a name="line.83"></a> |
| <span class="sourceLineNo">084</span> /**<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * The coreThreadPoolPrefix is the prefix that will be applied to all threads within the<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * ScheduledThreadPoolExecutor. The prefix is typically related to the Server that the service is<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * running on. The prefix is useful because it allows us to monitor how the thread pool of a<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * particular service changes over time VIA thread dumps.<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> */<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> private final String coreThreadPoolPrefix;<a name="line.90"></a> |
| <span class="sourceLineNo">091</span><a name="line.91"></a> |
| <span class="sourceLineNo">092</span> /**<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> *<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * @param coreThreadPoolPrefix Prefix that will be applied to the Thread name of all threads<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * spawned by this service<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> */<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> @InterfaceAudience.Private<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> @VisibleForTesting<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> public ChoreService(final String coreThreadPoolPrefix) {<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> this(coreThreadPoolPrefix, MIN_CORE_POOL_SIZE, false);<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> }<a name="line.101"></a> |
| <span class="sourceLineNo">102</span><a name="line.102"></a> |
| <span class="sourceLineNo">103</span> /**<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * @param coreThreadPoolPrefix Prefix that will be applied to the Thread name of all threads<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * spawned by this service<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * @param jitter Should chore service add some jitter for all of the scheduled chores. When set<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * to true this will add -10% to 10% jitter.<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> */<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> public ChoreService(final String coreThreadPoolPrefix, final boolean jitter) {<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> this(coreThreadPoolPrefix, MIN_CORE_POOL_SIZE, jitter);<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> }<a name="line.111"></a> |
| <span class="sourceLineNo">112</span><a name="line.112"></a> |
| <span class="sourceLineNo">113</span> /**<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * @param coreThreadPoolPrefix Prefix that will be applied to the Thread name of all threads<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * spawned by this service<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * @param corePoolSize The initial size to set the core pool of the ScheduledThreadPoolExecutor<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * to during initialization. The default size is 1, but specifying a larger size may be<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * beneficial if you know that 1 thread will not be enough.<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * @param jitter Should chore service add some jitter for all of the scheduled chores. When set<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * to true this will add -10% to 10% jitter.<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> */<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> public ChoreService(final String coreThreadPoolPrefix, int corePoolSize, boolean jitter) {<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> this.coreThreadPoolPrefix = coreThreadPoolPrefix;<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> if (corePoolSize < MIN_CORE_POOL_SIZE) {<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> corePoolSize = MIN_CORE_POOL_SIZE;<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> }<a name="line.126"></a> |
| <span class="sourceLineNo">127</span><a name="line.127"></a> |
| <span class="sourceLineNo">128</span> final ThreadFactory threadFactory = new ChoreServiceThreadFactory(coreThreadPoolPrefix);<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> if (jitter) {<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> scheduler = new JitterScheduledThreadPoolExecutorImpl(corePoolSize, threadFactory, 0.1);<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> } else {<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> scheduler = new ScheduledThreadPoolExecutor(corePoolSize, threadFactory);<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> }<a name="line.133"></a> |
| <span class="sourceLineNo">134</span><a name="line.134"></a> |
| <span class="sourceLineNo">135</span> scheduler.setRemoveOnCancelPolicy(true);<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> scheduledChores = new HashMap<>();<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> choresMissingStartTime = new HashMap<>();<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> }<a name="line.138"></a> |
| <span class="sourceLineNo">139</span><a name="line.139"></a> |
| <span class="sourceLineNo">140</span> /**<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * @param chore Chore to be scheduled. If the chore is already scheduled with another ChoreService<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> * instance, that schedule will be cancelled (i.e. a Chore can only ever be scheduled<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> * with a single ChoreService instance).<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> * @return true when the chore was successfully scheduled. false when the scheduling failed<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * (typically occurs when a chore is scheduled during shutdown of service)<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> */<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> public synchronized boolean scheduleChore(ScheduledChore chore) {<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> if (chore == null) {<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> return false;<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> }<a name="line.150"></a> |
| <span class="sourceLineNo">151</span><a name="line.151"></a> |
| <span class="sourceLineNo">152</span> try {<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> chore.setChoreServicer(this);<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> ScheduledFuture<?> future =<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> scheduler.scheduleAtFixedRate(chore, chore.getInitialDelay(), chore.getPeriod(),<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> chore.getTimeUnit());<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> scheduledChores.put(chore, future);<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> return true;<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> } catch (Exception exception) {<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> if (LOG.isInfoEnabled()) {<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> LOG.info("Could not successfully schedule chore: " + chore.getName());<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> }<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> return false;<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> }<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> }<a name="line.165"></a> |
| <span class="sourceLineNo">166</span><a name="line.166"></a> |
| <span class="sourceLineNo">167</span> /**<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> * @param chore The Chore to be rescheduled. If the chore is not scheduled with this ChoreService<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> * yet then this call is equivalent to a call to scheduleChore.<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> */<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> private synchronized void rescheduleChore(ScheduledChore chore) {<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> if (chore == null) return;<a name="line.172"></a> |
| <span class="sourceLineNo">173</span><a name="line.173"></a> |
| <span class="sourceLineNo">174</span> if (scheduledChores.containsKey(chore)) {<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> ScheduledFuture<?> future = scheduledChores.get(chore);<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> future.cancel(false);<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> }<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> scheduleChore(chore);<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> }<a name="line.179"></a> |
| <span class="sourceLineNo">180</span><a name="line.180"></a> |
| <span class="sourceLineNo">181</span> @InterfaceAudience.Private<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> @Override<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> public synchronized void cancelChore(ScheduledChore chore) {<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> cancelChore(chore, true);<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> }<a name="line.185"></a> |
| <span class="sourceLineNo">186</span><a name="line.186"></a> |
| <span class="sourceLineNo">187</span> @InterfaceAudience.Private<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> @Override<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> public synchronized void cancelChore(ScheduledChore chore, boolean mayInterruptIfRunning) {<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> if (chore != null && scheduledChores.containsKey(chore)) {<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> ScheduledFuture<?> future = scheduledChores.get(chore);<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> future.cancel(mayInterruptIfRunning);<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> scheduledChores.remove(chore);<a name="line.193"></a> |
| <span class="sourceLineNo">194</span><a name="line.194"></a> |
| <span class="sourceLineNo">195</span> // Removing a chore that was missing its start time means it may be possible<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> // to reduce the number of threads<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> if (choresMissingStartTime.containsKey(chore)) {<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> choresMissingStartTime.remove(chore);<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> requestCorePoolDecrease();<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> }<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> }<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> }<a name="line.202"></a> |
| <span class="sourceLineNo">203</span><a name="line.203"></a> |
| <span class="sourceLineNo">204</span> @InterfaceAudience.Private<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> @Override<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> public synchronized boolean isChoreScheduled(ScheduledChore chore) {<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> return chore != null && scheduledChores.containsKey(chore)<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> && !scheduledChores.get(chore).isDone();<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> @InterfaceAudience.Private<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> @Override<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> public synchronized boolean triggerNow(ScheduledChore chore) {<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> if (chore == null) {<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> return false;<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> } else {<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> rescheduleChore(chore);<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> return true;<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> }<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> }<a name="line.220"></a> |
| <span class="sourceLineNo">221</span><a name="line.221"></a> |
| <span class="sourceLineNo">222</span> /**<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> * @return number of chores that this service currently has scheduled<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> */<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> int getNumberOfScheduledChores() {<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> return scheduledChores.size();<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> }<a name="line.227"></a> |
| <span class="sourceLineNo">228</span><a name="line.228"></a> |
| <span class="sourceLineNo">229</span> /**<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> * @return number of chores that this service currently has scheduled that are missing their<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> * scheduled start time<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> */<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> int getNumberOfChoresMissingStartTime() {<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> return choresMissingStartTime.size();<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> }<a name="line.235"></a> |
| <span class="sourceLineNo">236</span><a name="line.236"></a> |
| <span class="sourceLineNo">237</span> /**<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> * @return number of threads in the core pool of the underlying ScheduledThreadPoolExecutor<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> */<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> int getCorePoolSize() {<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> return scheduler.getCorePoolSize();<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> }<a name="line.242"></a> |
| <span class="sourceLineNo">243</span><a name="line.243"></a> |
| <span class="sourceLineNo">244</span> /**<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> * Custom ThreadFactory used with the ScheduledThreadPoolExecutor so that all the threads are<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> * daemon threads, and thus, don't prevent the JVM from shutting down<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> */<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> static class ChoreServiceThreadFactory implements ThreadFactory {<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> private final String threadPrefix;<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> private final static String THREAD_NAME_SUFFIX = ".Chore.";<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> private AtomicInteger threadNumber = new AtomicInteger(1);<a name="line.251"></a> |
| <span class="sourceLineNo">252</span><a name="line.252"></a> |
| <span class="sourceLineNo">253</span> /**<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> * @param threadPrefix The prefix given to all threads created by this factory<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> */<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> public ChoreServiceThreadFactory(final String threadPrefix) {<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> this.threadPrefix = threadPrefix;<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> }<a name="line.258"></a> |
| <span class="sourceLineNo">259</span><a name="line.259"></a> |
| <span class="sourceLineNo">260</span> @Override<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> public Thread newThread(Runnable r) {<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> Thread thread =<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> new Thread(r, threadPrefix + THREAD_NAME_SUFFIX + threadNumber.getAndIncrement());<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> thread.setDaemon(true);<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> return thread;<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> }<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> }<a name="line.267"></a> |
| <span class="sourceLineNo">268</span><a name="line.268"></a> |
| <span class="sourceLineNo">269</span> /**<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> * Represents a request to increase the number of core pool threads. Typically a request<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> * originates from the fact that the current core pool size is not sufficient to service all of<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> * the currently running Chores<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> * @return true when the request to increase the core pool size succeeds<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> */<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> private synchronized boolean requestCorePoolIncrease() {<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> // There is no point in creating more threads than scheduledChores.size since scheduled runs<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> // of the same chore cannot run concurrently (i.e. happen-before behavior is enforced<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> // amongst occurrences of the same chore).<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> if (scheduler.getCorePoolSize() < scheduledChores.size()) {<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> scheduler.setCorePoolSize(scheduler.getCorePoolSize() + 1);<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> printChoreServiceDetails("requestCorePoolIncrease");<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> return true;<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> }<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> return false;<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> }<a name="line.285"></a> |
| <span class="sourceLineNo">286</span><a name="line.286"></a> |
| <span class="sourceLineNo">287</span> /**<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> * Represents a request to decrease the number of core pool threads. Typically a request<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> * originates from the fact that the current core pool size is more than sufficient to service the<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> * running Chores.<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> */<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> private synchronized void requestCorePoolDecrease() {<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> if (scheduler.getCorePoolSize() > MIN_CORE_POOL_SIZE) {<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> scheduler.setCorePoolSize(scheduler.getCorePoolSize() - 1);<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> printChoreServiceDetails("requestCorePoolDecrease");<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> }<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> }<a name="line.297"></a> |
| <span class="sourceLineNo">298</span><a name="line.298"></a> |
| <span class="sourceLineNo">299</span> @InterfaceAudience.Private<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> @Override<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> public synchronized void onChoreMissedStartTime(ScheduledChore chore) {<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> if (chore == null || !scheduledChores.containsKey(chore)) return;<a name="line.302"></a> |
| <span class="sourceLineNo">303</span><a name="line.303"></a> |
| <span class="sourceLineNo">304</span> // If the chore has not caused an increase in the size of the core thread pool then request an<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> // increase. This allows each chore missing its start time to increase the core pool size by<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> // at most 1.<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> if (!choresMissingStartTime.containsKey(chore) || !choresMissingStartTime.get(chore)) {<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> choresMissingStartTime.put(chore, requestCorePoolIncrease());<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> }<a name="line.309"></a> |
| <span class="sourceLineNo">310</span><a name="line.310"></a> |
| <span class="sourceLineNo">311</span> // Must reschedule the chore to prevent unnecessary delays of chores in the scheduler. If<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> // the chore is NOT rescheduled, future executions of this chore will be delayed more and<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> // more on each iteration. This hurts us because the ScheduledThreadPoolExecutor allocates<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> // idle threads to chores based on how delayed they are.<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> rescheduleChore(chore);<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> printChoreDetails("onChoreMissedStartTime", chore);<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> }<a name="line.317"></a> |
| <span class="sourceLineNo">318</span><a name="line.318"></a> |
| <span class="sourceLineNo">319</span> /**<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> * shutdown the service. Any chores that are scheduled for execution will be cancelled. Any chores<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> * in the middle of execution will be interrupted and shutdown. This service will be unusable<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> * after this method has been called (i.e. future scheduling attempts will fail).<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> */<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> public synchronized void shutdown() {<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> scheduler.shutdownNow();<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> if (LOG.isInfoEnabled()) {<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> LOG.info("Chore service for: " + coreThreadPoolPrefix + " had " + scheduledChores.keySet()<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> + " on shutdown");<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> }<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> cancelAllChores(true);<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> scheduledChores.clear();<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> choresMissingStartTime.clear();<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> }<a name="line.333"></a> |
| <span class="sourceLineNo">334</span><a name="line.334"></a> |
| <span class="sourceLineNo">335</span> /**<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> * @return true when the service is shutdown and thus cannot be used anymore<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> */<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> public boolean isShutdown() {<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> return scheduler.isShutdown();<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> }<a name="line.340"></a> |
| <span class="sourceLineNo">341</span><a name="line.341"></a> |
| <span class="sourceLineNo">342</span> /**<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> * @return true when the service is shutdown and all threads have terminated<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> */<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> public boolean isTerminated() {<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> return scheduler.isTerminated();<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> }<a name="line.347"></a> |
| <span class="sourceLineNo">348</span><a name="line.348"></a> |
| <span class="sourceLineNo">349</span> private void cancelAllChores(final boolean mayInterruptIfRunning) {<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> ArrayList<ScheduledChore> choresToCancel = new ArrayList<>(scheduledChores.keySet().size());<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> // Build list of chores to cancel so we can iterate through a set that won't change<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> // as chores are cancelled. If we tried to cancel each chore while iterating through<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> // keySet the results would be undefined because the keySet would be changing<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> for (ScheduledChore chore : scheduledChores.keySet()) {<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> choresToCancel.add(chore);<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> }<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> for (ScheduledChore chore : choresToCancel) {<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> cancelChore(chore, mayInterruptIfRunning);<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> }<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> choresToCancel.clear();<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> }<a name="line.361"></a> |
| <span class="sourceLineNo">362</span><a name="line.362"></a> |
| <span class="sourceLineNo">363</span> /**<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> * Prints a summary of important details about the chore. Used for debugging purposes<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> */<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> private void printChoreDetails(final String header, ScheduledChore chore) {<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> LinkedHashMap<String, String> output = new LinkedHashMap<>();<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> output.put(header, "");<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> output.put("Chore name: ", chore.getName());<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> output.put("Chore period: ", Integer.toString(chore.getPeriod()));<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> output.put("Chore timeBetweenRuns: ", Long.toString(chore.getTimeBetweenRuns()));<a name="line.371"></a> |
| <span class="sourceLineNo">372</span><a name="line.372"></a> |
| <span class="sourceLineNo">373</span> for (Entry<String, String> entry : output.entrySet()) {<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> if (LOG.isTraceEnabled()) LOG.trace(entry.getKey() + entry.getValue());<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> }<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> }<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> * Prints a summary of important details about the service. Used for debugging purposes<a name="line.379"></a> |
| <span class="sourceLineNo">380</span> */<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> private void printChoreServiceDetails(final String header) {<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> LinkedHashMap<String, String> output = new LinkedHashMap<>();<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> output.put(header, "");<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> output.put("ChoreService corePoolSize: ", Integer.toString(getCorePoolSize()));<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> output.put("ChoreService scheduledChores: ", Integer.toString(getNumberOfScheduledChores()));<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> output.put("ChoreService missingStartTimeCount: ",<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> Integer.toString(getNumberOfChoresMissingStartTime()));<a name="line.387"></a> |
| <span class="sourceLineNo">388</span><a name="line.388"></a> |
| <span class="sourceLineNo">389</span> for (Entry<String, String> entry : output.entrySet()) {<a name="line.389"></a> |
| <span class="sourceLineNo">390</span> if (LOG.isTraceEnabled()) LOG.trace(entry.getKey() + entry.getValue());<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> }<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> }<a name="line.392"></a> |
| <span class="sourceLineNo">393</span>}<a name="line.393"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
