Google Git
Sign in
apache / hbase-site / 0082cda45f48d1755543336c908ec6d80d4ec0a9 / . / apidocs / src-html / org / apache / hadoop / hbase / util / Threads.html
blob: 2746f43d402642d5e1522305edf978f73e6099c9 [file] [log] [blame]
<!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.util, class: Threads">
<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.util;</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 java.io.PrintStream;</span>
<span class="source-line-no">021</span><span id="line-21">import java.lang.Thread.UncaughtExceptionHandler;</span>
<span class="source-line-no">022</span><span id="line-22">import java.util.Set;</span>
<span class="source-line-no">023</span><span id="line-23">import java.util.concurrent.LinkedBlockingQueue;</span>
<span class="source-line-no">024</span><span id="line-24">import java.util.concurrent.ThreadFactory;</span>
<span class="source-line-no">025</span><span id="line-25">import java.util.concurrent.ThreadPoolExecutor;</span>
<span class="source-line-no">026</span><span id="line-26">import java.util.concurrent.TimeUnit;</span>
<span class="source-line-no">027</span><span id="line-27">import java.util.concurrent.atomic.AtomicInteger;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.util.StringUtils;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">030</span><span id="line-30">import org.slf4j.Logger;</span>
<span class="source-line-no">031</span><span id="line-31">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">032</span><span id="line-32"></span>
<span class="source-line-no">033</span><span id="line-33">/**</span>
<span class="source-line-no">034</span><span id="line-34"> * Thread Utility</span>
<span class="source-line-no">035</span><span id="line-35"> */</span>
<span class="source-line-no">036</span><span id="line-36">@InterfaceAudience.Private</span>
<span class="source-line-no">037</span><span id="line-37">public class Threads {</span>
<span class="source-line-no">038</span><span id="line-38"> private static final Logger LOG = LoggerFactory.getLogger(Threads.class);</span>
<span class="source-line-no">039</span><span id="line-39"></span>
<span class="source-line-no">040</span><span id="line-40"> public static final UncaughtExceptionHandler LOGGING_EXCEPTION_HANDLER =</span>
<span class="source-line-no">041</span><span id="line-41"> (t, e) -&gt; LOG.warn("Thread:{} exited with Exception:{}", t, StringUtils.stringifyException(e));</span>
<span class="source-line-no">042</span><span id="line-42"></span>
<span class="source-line-no">043</span><span id="line-43"> /**</span>
<span class="source-line-no">044</span><span id="line-44"> * Utility method that sets name, daemon status and starts passed thread.</span>
<span class="source-line-no">045</span><span id="line-45"> * @param t thread to run</span>
<span class="source-line-no">046</span><span id="line-46"> * @return Returns the passed Thread &lt;code&gt;t&lt;/code&gt;.</span>
<span class="source-line-no">047</span><span id="line-47"> */</span>
<span class="source-line-no">048</span><span id="line-48"> public static &lt;T extends Thread&gt; T setDaemonThreadRunning(T t) {</span>
<span class="source-line-no">049</span><span id="line-49"> return setDaemonThreadRunning(t, t.getName());</span>
<span class="source-line-no">050</span><span id="line-50"> }</span>
<span class="source-line-no">051</span><span id="line-51"></span>
<span class="source-line-no">052</span><span id="line-52"> /**</span>
<span class="source-line-no">053</span><span id="line-53"> * Utility method that sets name, daemon status and starts passed thread.</span>
<span class="source-line-no">054</span><span id="line-54"> * @param t thread to frob</span>
<span class="source-line-no">055</span><span id="line-55"> * @param name new name</span>
<span class="source-line-no">056</span><span id="line-56"> * @return Returns the passed Thread &lt;code&gt;t&lt;/code&gt;.</span>
<span class="source-line-no">057</span><span id="line-57"> */</span>
<span class="source-line-no">058</span><span id="line-58"> public static &lt;T extends Thread&gt; T setDaemonThreadRunning(T t, String name) {</span>
<span class="source-line-no">059</span><span id="line-59"> return setDaemonThreadRunning(t, name, null);</span>
<span class="source-line-no">060</span><span id="line-60"> }</span>
<span class="source-line-no">061</span><span id="line-61"></span>
<span class="source-line-no">062</span><span id="line-62"> /**</span>
<span class="source-line-no">063</span><span id="line-63"> * Utility method that sets name, daemon status and starts passed thread.</span>
<span class="source-line-no">064</span><span id="line-64"> * @param t thread to frob</span>
<span class="source-line-no">065</span><span id="line-65"> * @param name new name</span>
<span class="source-line-no">066</span><span id="line-66"> * @param handler A handler to set on the thread. Pass null if want to use default handler.</span>
<span class="source-line-no">067</span><span id="line-67"> * @return Returns the passed Thread &lt;code&gt;t&lt;/code&gt;.</span>
<span class="source-line-no">068</span><span id="line-68"> */</span>
<span class="source-line-no">069</span><span id="line-69"> public static &lt;T extends Thread&gt; T setDaemonThreadRunning(T t, String name,</span>
<span class="source-line-no">070</span><span id="line-70"> UncaughtExceptionHandler handler) {</span>
<span class="source-line-no">071</span><span id="line-71"> t.setName(name);</span>
<span class="source-line-no">072</span><span id="line-72"> if (handler != null) {</span>
<span class="source-line-no">073</span><span id="line-73"> t.setUncaughtExceptionHandler(handler);</span>
<span class="source-line-no">074</span><span id="line-74"> }</span>
<span class="source-line-no">075</span><span id="line-75"> t.setDaemon(true);</span>
<span class="source-line-no">076</span><span id="line-76"> t.start();</span>
<span class="source-line-no">077</span><span id="line-77"> return t;</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"> * Shutdown passed thread using isAlive and join.</span>
<span class="source-line-no">082</span><span id="line-82"> * @param t Thread to shutdown</span>
<span class="source-line-no">083</span><span id="line-83"> */</span>
<span class="source-line-no">084</span><span id="line-84"> public static void shutdown(final Thread t) {</span>
<span class="source-line-no">085</span><span id="line-85"> shutdown(t, 0);</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"> /**</span>
<span class="source-line-no">089</span><span id="line-89"> * Shutdown passed thread using isAlive and join.</span>
<span class="source-line-no">090</span><span id="line-90"> * @param joinwait Pass 0 if we're to wait forever.</span>
<span class="source-line-no">091</span><span id="line-91"> * @param t Thread to shutdown</span>
<span class="source-line-no">092</span><span id="line-92"> */</span>
<span class="source-line-no">093</span><span id="line-93"> public static void shutdown(final Thread t, final long joinwait) {</span>
<span class="source-line-no">094</span><span id="line-94"> if (t == null) return;</span>
<span class="source-line-no">095</span><span id="line-95"> while (t.isAlive()) {</span>
<span class="source-line-no">096</span><span id="line-96"> try {</span>
<span class="source-line-no">097</span><span id="line-97"> t.join(joinwait);</span>
<span class="source-line-no">098</span><span id="line-98"> } catch (InterruptedException e) {</span>
<span class="source-line-no">099</span><span id="line-99"> LOG.warn(t.getName() + "; joinwait=" + joinwait, 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"> }</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"> /** Waits on the passed thread to die dumping a threaddump every minute while its up. */</span>
<span class="source-line-no">105</span><span id="line-105"> public static void threadDumpingIsAlive(final Thread t) throws InterruptedException {</span>
<span class="source-line-no">106</span><span id="line-106"> if (t == null) {</span>
<span class="source-line-no">107</span><span id="line-107"> return;</span>
<span class="source-line-no">108</span><span id="line-108"> }</span>
<span class="source-line-no">109</span><span id="line-109"></span>
<span class="source-line-no">110</span><span id="line-110"> while (t.isAlive()) {</span>
<span class="source-line-no">111</span><span id="line-111"> t.join(60 * 1000);</span>
<span class="source-line-no">112</span><span id="line-112"> if (t.isAlive()) {</span>
<span class="source-line-no">113</span><span id="line-113"> printThreadInfo(System.out,</span>
<span class="source-line-no">114</span><span id="line-114"> "Automatic Stack Trace every 60 seconds waiting on " + t.getName());</span>
<span class="source-line-no">115</span><span id="line-115"> }</span>
<span class="source-line-no">116</span><span id="line-116"> }</span>
<span class="source-line-no">117</span><span id="line-117"> }</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"> * If interrupted, just prints out the interrupt on STDOUT, resets interrupt and returns</span>
<span class="source-line-no">121</span><span id="line-121"> * @param millis How long to sleep for in milliseconds.</span>
<span class="source-line-no">122</span><span id="line-122"> */</span>
<span class="source-line-no">123</span><span id="line-123"> public static void sleep(long millis) {</span>
<span class="source-line-no">124</span><span id="line-124"> try {</span>
<span class="source-line-no">125</span><span id="line-125"> Thread.sleep(millis);</span>
<span class="source-line-no">126</span><span id="line-126"> } catch (InterruptedException e) {</span>
<span class="source-line-no">127</span><span id="line-127"> LOG.warn("sleep interrupted", e);</span>
<span class="source-line-no">128</span><span id="line-128"> Thread.currentThread().interrupt();</span>
<span class="source-line-no">129</span><span id="line-129"> }</span>
<span class="source-line-no">130</span><span id="line-130"> }</span>
<span class="source-line-no">131</span><span id="line-131"></span>
<span class="source-line-no">132</span><span id="line-132"> /**</span>
<span class="source-line-no">133</span><span id="line-133"> * Sleeps for the given amount of time even if interrupted. Preserves the interrupt status.</span>
<span class="source-line-no">134</span><span id="line-134"> * @param msToWait the amount of time to sleep in milliseconds</span>
<span class="source-line-no">135</span><span id="line-135"> */</span>
<span class="source-line-no">136</span><span id="line-136"> public static void sleepWithoutInterrupt(final long msToWait) {</span>
<span class="source-line-no">137</span><span id="line-137"> long timeMillis = EnvironmentEdgeManager.currentTime();</span>
<span class="source-line-no">138</span><span id="line-138"> long endTime = timeMillis + msToWait;</span>
<span class="source-line-no">139</span><span id="line-139"> boolean interrupted = false;</span>
<span class="source-line-no">140</span><span id="line-140"> while (timeMillis &lt; endTime) {</span>
<span class="source-line-no">141</span><span id="line-141"> try {</span>
<span class="source-line-no">142</span><span id="line-142"> Thread.sleep(endTime - timeMillis);</span>
<span class="source-line-no">143</span><span id="line-143"> } catch (InterruptedException ex) {</span>
<span class="source-line-no">144</span><span id="line-144"> interrupted = true;</span>
<span class="source-line-no">145</span><span id="line-145"> }</span>
<span class="source-line-no">146</span><span id="line-146"> timeMillis = EnvironmentEdgeManager.currentTime();</span>
<span class="source-line-no">147</span><span id="line-147"> }</span>
<span class="source-line-no">148</span><span id="line-148"></span>
<span class="source-line-no">149</span><span id="line-149"> if (interrupted) {</span>
<span class="source-line-no">150</span><span id="line-150"> Thread.currentThread().interrupt();</span>
<span class="source-line-no">151</span><span id="line-151"> }</span>
<span class="source-line-no">152</span><span id="line-152"> }</span>
<span class="source-line-no">153</span><span id="line-153"></span>
<span class="source-line-no">154</span><span id="line-154"> /**</span>
<span class="source-line-no">155</span><span id="line-155"> * Create a new CachedThreadPool with a bounded number as the maximum thread size in the pool.</span>
<span class="source-line-no">156</span><span id="line-156"> * @param maxCachedThread the maximum thread could be created in the pool</span>
<span class="source-line-no">157</span><span id="line-157"> * @param timeout the maximum time to wait</span>
<span class="source-line-no">158</span><span id="line-158"> * @param unit the time unit of the timeout argument</span>
<span class="source-line-no">159</span><span id="line-159"> * @param threadFactory the factory to use when creating new threads</span>
<span class="source-line-no">160</span><span id="line-160"> * @return threadPoolExecutor the cachedThreadPool with a bounded number as the maximum thread</span>
<span class="source-line-no">161</span><span id="line-161"> * size in the pool.</span>
<span class="source-line-no">162</span><span id="line-162"> */</span>
<span class="source-line-no">163</span><span id="line-163"> public static ThreadPoolExecutor getBoundedCachedThreadPool(int maxCachedThread, long timeout,</span>
<span class="source-line-no">164</span><span id="line-164"> TimeUnit unit, ThreadFactory threadFactory) {</span>
<span class="source-line-no">165</span><span id="line-165"> ThreadPoolExecutor boundedCachedThreadPool = new ThreadPoolExecutor(maxCachedThread,</span>
<span class="source-line-no">166</span><span id="line-166"> maxCachedThread, timeout, unit, new LinkedBlockingQueue&lt;&gt;(), threadFactory);</span>
<span class="source-line-no">167</span><span id="line-167"> // allow the core pool threads timeout and terminate</span>
<span class="source-line-no">168</span><span id="line-168"> boundedCachedThreadPool.allowCoreThreadTimeOut(true);</span>
<span class="source-line-no">169</span><span id="line-169"> return boundedCachedThreadPool;</span>
<span class="source-line-no">170</span><span id="line-170"> }</span>
<span class="source-line-no">171</span><span id="line-171"></span>
<span class="source-line-no">172</span><span id="line-172"> /**</span>
<span class="source-line-no">173</span><span id="line-173"> * Sets an UncaughtExceptionHandler for the thread which logs the Exception stack if the thread</span>
<span class="source-line-no">174</span><span id="line-174"> * dies.</span>
<span class="source-line-no">175</span><span id="line-175"> */</span>
<span class="source-line-no">176</span><span id="line-176"> public static void setLoggingUncaughtExceptionHandler(Thread t) {</span>
<span class="source-line-no">177</span><span id="line-177"> t.setUncaughtExceptionHandler(LOGGING_EXCEPTION_HANDLER);</span>
<span class="source-line-no">178</span><span id="line-178"> }</span>
<span class="source-line-no">179</span><span id="line-179"></span>
<span class="source-line-no">180</span><span id="line-180"> /**</span>
<span class="source-line-no">181</span><span id="line-181"> * Print all of the thread's information and stack traces. Wrapper around Hadoop's method.</span>
<span class="source-line-no">182</span><span id="line-182"> * @param stream the stream to</span>
<span class="source-line-no">183</span><span id="line-183"> * @param title a string title for the stack trace</span>
<span class="source-line-no">184</span><span id="line-184"> */</span>
<span class="source-line-no">185</span><span id="line-185"> public static void printThreadInfo(PrintStream stream, String title) {</span>
<span class="source-line-no">186</span><span id="line-186"> ReflectionUtils.printThreadInfo(stream, title);</span>
<span class="source-line-no">187</span><span id="line-187"> }</span>
<span class="source-line-no">188</span><span id="line-188"></span>
<span class="source-line-no">189</span><span id="line-189"> /**</span>
<span class="source-line-no">190</span><span id="line-190"> * Checks whether any non-daemon thread is running.</span>
<span class="source-line-no">191</span><span id="line-191"> * @return true if there are non daemon threads running, otherwise false</span>
<span class="source-line-no">192</span><span id="line-192"> */</span>
<span class="source-line-no">193</span><span id="line-193"> public static boolean isNonDaemonThreadRunning() {</span>
<span class="source-line-no">194</span><span id="line-194"> AtomicInteger nonDaemonThreadCount = new AtomicInteger();</span>
<span class="source-line-no">195</span><span id="line-195"> Set&lt;Thread&gt; threads = Thread.getAllStackTraces().keySet();</span>
<span class="source-line-no">196</span><span id="line-196"> threads.forEach(t -&gt; {</span>
<span class="source-line-no">197</span><span id="line-197"> // Exclude current thread</span>
<span class="source-line-no">198</span><span id="line-198"> if (t.getId() != Thread.currentThread().getId() &amp;&amp; !t.isDaemon()) {</span>
<span class="source-line-no">199</span><span id="line-199"> nonDaemonThreadCount.getAndIncrement();</span>
<span class="source-line-no">200</span><span id="line-200"> LOG.info("Non daemon thread {} is still alive", t.getName());</span>
<span class="source-line-no">201</span><span id="line-201"> LOG.info(printStackTrace(t));</span>
<span class="source-line-no">202</span><span id="line-202"> }</span>
<span class="source-line-no">203</span><span id="line-203"> });</span>
<span class="source-line-no">204</span><span id="line-204"> return nonDaemonThreadCount.get() &gt; 0;</span>
<span class="source-line-no">205</span><span id="line-205"> }</span>
<span class="source-line-no">206</span><span id="line-206"></span>
<span class="source-line-no">207</span><span id="line-207"> /*</span>
<span class="source-line-no">208</span><span id="line-208"> * Print stack trace of the passed thread</span>
<span class="source-line-no">209</span><span id="line-209"> */</span>
<span class="source-line-no">210</span><span id="line-210"> public static String printStackTrace(Thread t) {</span>
<span class="source-line-no">211</span><span id="line-211"> StringBuilder sb = new StringBuilder();</span>
<span class="source-line-no">212</span><span id="line-212"> for (StackTraceElement frame : t.getStackTrace()) {</span>
<span class="source-line-no">213</span><span id="line-213"> sb.append("\n").append(" ").append(frame.toString());</span>
<span class="source-line-no">214</span><span id="line-214"> }</span>
<span class="source-line-no">215</span><span id="line-215"> return sb.toString();</span>
<span class="source-line-no">216</span><span id="line-216"> }</span>
<span class="source-line-no">217</span><span id="line-217">}</span>
</pre>
</div>
</main>
</body>
</html>