Google Git
Sign in
apache / hbase-site / dc97eead565e541d38e7e85d1ba797b56b79bbf5 / . / testdevapidocs / src-html / org / apache / hadoop / hbase / util / MultiThreadedWriterBase.html
blob: b115d058d8a4c51ad0a1b9a2cf1484e8c12a6753 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a>
<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a>
<span class="sourceLineNo">017</span> */<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>package org.apache.hadoop.hbase.util;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.io.IOException;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.PriorityQueue;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.Queue;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.Set;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.concurrent.ArrayBlockingQueue;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.concurrent.BlockingQueue;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.concurrent.ConcurrentSkipListSet;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.concurrent.TimeUnit;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.concurrent.atomic.AtomicLong;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.conf.Configuration;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.HRegionLocation;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.TableName;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.client.RegionLocator;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.client.Table;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.util.test.LoadTestDataGenerator;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.slf4j.Logger;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.slf4j.LoggerFactory;<a name="line.37"></a>
<span class="sourceLineNo">038</span><a name="line.38"></a>
<span class="sourceLineNo">039</span>/** Creates multiple threads that write key/values into the */<a name="line.39"></a>
<span class="sourceLineNo">040</span>public abstract class MultiThreadedWriterBase extends MultiThreadedAction {<a name="line.40"></a>
<span class="sourceLineNo">041</span> private static final Logger LOG = LoggerFactory.getLogger(MultiThreadedWriterBase.class);<a name="line.41"></a>
<span class="sourceLineNo">042</span><a name="line.42"></a>
<span class="sourceLineNo">043</span> /**<a name="line.43"></a>
<span class="sourceLineNo">044</span> * A temporary place to keep track of inserted/updated keys. This is written to by<a name="line.44"></a>
<span class="sourceLineNo">045</span> * all writers and is drained on a separate thread that populates<a name="line.45"></a>
<span class="sourceLineNo">046</span> * {@link #wroteUpToKey}, the maximum key in the contiguous range of keys<a name="line.46"></a>
<span class="sourceLineNo">047</span> * being inserted/updated. This queue is supposed to stay small.<a name="line.47"></a>
<span class="sourceLineNo">048</span> */<a name="line.48"></a>
<span class="sourceLineNo">049</span> protected BlockingQueue&lt;Long&gt; wroteKeys;<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> /**<a name="line.51"></a>
<span class="sourceLineNo">052</span> * This is the current key to be inserted/updated by any thread. Each thread does an<a name="line.52"></a>
<span class="sourceLineNo">053</span> * atomic get and increment operation and inserts the current value.<a name="line.53"></a>
<span class="sourceLineNo">054</span> */<a name="line.54"></a>
<span class="sourceLineNo">055</span> protected AtomicLong nextKeyToWrite = new AtomicLong();<a name="line.55"></a>
<span class="sourceLineNo">056</span><a name="line.56"></a>
<span class="sourceLineNo">057</span> /**<a name="line.57"></a>
<span class="sourceLineNo">058</span> * The highest key in the contiguous range of keys .<a name="line.58"></a>
<span class="sourceLineNo">059</span> */<a name="line.59"></a>
<span class="sourceLineNo">060</span> protected AtomicLong wroteUpToKey = new AtomicLong();<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span> /** The sorted set of keys NOT inserted/updated by the writers */<a name="line.62"></a>
<span class="sourceLineNo">063</span> protected Set&lt;Long&gt; failedKeySet = new ConcurrentSkipListSet&lt;&gt;();<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> /**<a name="line.65"></a>
<span class="sourceLineNo">066</span> * The total size of the temporary inserted/updated key set that have not yet lined<a name="line.66"></a>
<span class="sourceLineNo">067</span> * up in a our contiguous sequence starting from startKey. Supposed to stay<a name="line.67"></a>
<span class="sourceLineNo">068</span> * small.<a name="line.68"></a>
<span class="sourceLineNo">069</span> */<a name="line.69"></a>
<span class="sourceLineNo">070</span> protected AtomicLong wroteKeyQueueSize = new AtomicLong();<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span> /** Enable this if used in conjunction with a concurrent reader. */<a name="line.72"></a>
<span class="sourceLineNo">073</span> protected boolean trackWroteKeys;<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span> public MultiThreadedWriterBase(LoadTestDataGenerator dataGen, Configuration conf,<a name="line.75"></a>
<span class="sourceLineNo">076</span> TableName tableName, String actionLetter) throws IOException {<a name="line.76"></a>
<span class="sourceLineNo">077</span> super(dataGen, conf, tableName, actionLetter);<a name="line.77"></a>
<span class="sourceLineNo">078</span> this.wroteKeys = createWriteKeysQueue(conf);<a name="line.78"></a>
<span class="sourceLineNo">079</span> }<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span> protected BlockingQueue&lt;Long&gt; createWriteKeysQueue(Configuration conf) {<a name="line.81"></a>
<span class="sourceLineNo">082</span> return new ArrayBlockingQueue&lt;&gt;(10000);<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> @Override<a name="line.85"></a>
<span class="sourceLineNo">086</span> public void start(long startKey, long endKey, int numThreads) throws IOException {<a name="line.86"></a>
<span class="sourceLineNo">087</span> super.start(startKey, endKey, numThreads);<a name="line.87"></a>
<span class="sourceLineNo">088</span> nextKeyToWrite.set(startKey);<a name="line.88"></a>
<span class="sourceLineNo">089</span> wroteUpToKey.set(startKey - 1);<a name="line.89"></a>
<span class="sourceLineNo">090</span><a name="line.90"></a>
<span class="sourceLineNo">091</span> if (trackWroteKeys) {<a name="line.91"></a>
<span class="sourceLineNo">092</span> new Thread(new WroteKeysTracker(),<a name="line.92"></a>
<span class="sourceLineNo">093</span> "MultiThreadedWriterBase-WroteKeysTracker-" + System.currentTimeMillis()).start();<a name="line.93"></a>
<span class="sourceLineNo">094</span> numThreadsWorking.incrementAndGet();<a name="line.94"></a>
<span class="sourceLineNo">095</span> }<a name="line.95"></a>
<span class="sourceLineNo">096</span> }<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span> protected String getRegionDebugInfoSafe(Table table, byte[] rowKey) {<a name="line.98"></a>
<span class="sourceLineNo">099</span> HRegionLocation cached = null, real = null;<a name="line.99"></a>
<span class="sourceLineNo">100</span> try (RegionLocator locator = connection.getRegionLocator(tableName)) {<a name="line.100"></a>
<span class="sourceLineNo">101</span> cached = locator.getRegionLocation(rowKey, false);<a name="line.101"></a>
<span class="sourceLineNo">102</span> real = locator.getRegionLocation(rowKey, true);<a name="line.102"></a>
<span class="sourceLineNo">103</span> } catch (Throwable t) {<a name="line.103"></a>
<span class="sourceLineNo">104</span> // Cannot obtain region information for another catch block - too bad!<a name="line.104"></a>
<span class="sourceLineNo">105</span> }<a name="line.105"></a>
<span class="sourceLineNo">106</span> String result = "no information can be obtained";<a name="line.106"></a>
<span class="sourceLineNo">107</span> if (cached != null) {<a name="line.107"></a>
<span class="sourceLineNo">108</span> result = "cached: " + cached.toString();<a name="line.108"></a>
<span class="sourceLineNo">109</span> }<a name="line.109"></a>
<span class="sourceLineNo">110</span> if (real != null &amp;&amp; real.getServerName() != null) {<a name="line.110"></a>
<span class="sourceLineNo">111</span> if (cached != null &amp;&amp; cached.getServerName() != null &amp;&amp; real.equals(cached)) {<a name="line.111"></a>
<span class="sourceLineNo">112</span> result += "; cache is up to date";<a name="line.112"></a>
<span class="sourceLineNo">113</span> } else {<a name="line.113"></a>
<span class="sourceLineNo">114</span> result = (cached != null) ? (result + "; ") : "";<a name="line.114"></a>
<span class="sourceLineNo">115</span> result += "real: " + real.toString();<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<a name="line.116"></a>
<span class="sourceLineNo">117</span> }<a name="line.117"></a>
<span class="sourceLineNo">118</span> return result;<a name="line.118"></a>
<span class="sourceLineNo">119</span> }<a name="line.119"></a>
<span class="sourceLineNo">120</span><a name="line.120"></a>
<span class="sourceLineNo">121</span> /**<a name="line.121"></a>
<span class="sourceLineNo">122</span> * A thread that keeps track of the highest key in the contiguous range of<a name="line.122"></a>
<span class="sourceLineNo">123</span> * inserted/updated keys.<a name="line.123"></a>
<span class="sourceLineNo">124</span> */<a name="line.124"></a>
<span class="sourceLineNo">125</span> private class WroteKeysTracker implements Runnable {<a name="line.125"></a>
<span class="sourceLineNo">126</span><a name="line.126"></a>
<span class="sourceLineNo">127</span> @Override<a name="line.127"></a>
<span class="sourceLineNo">128</span> public void run() {<a name="line.128"></a>
<span class="sourceLineNo">129</span> Thread.currentThread().setName(getClass().getSimpleName());<a name="line.129"></a>
<span class="sourceLineNo">130</span> try {<a name="line.130"></a>
<span class="sourceLineNo">131</span> long expectedKey = startKey;<a name="line.131"></a>
<span class="sourceLineNo">132</span> Queue&lt;Long&gt; sortedKeys = new PriorityQueue&lt;&gt;();<a name="line.132"></a>
<span class="sourceLineNo">133</span> while (expectedKey &lt; endKey) {<a name="line.133"></a>
<span class="sourceLineNo">134</span> // Block until a new element is available.<a name="line.134"></a>
<span class="sourceLineNo">135</span> Long k;<a name="line.135"></a>
<span class="sourceLineNo">136</span> try {<a name="line.136"></a>
<span class="sourceLineNo">137</span> k = wroteKeys.poll(1, TimeUnit.SECONDS);<a name="line.137"></a>
<span class="sourceLineNo">138</span> } catch (InterruptedException e) {<a name="line.138"></a>
<span class="sourceLineNo">139</span> LOG.info("Inserted key tracker thread interrupted", e);<a name="line.139"></a>
<span class="sourceLineNo">140</span> break;<a name="line.140"></a>
<span class="sourceLineNo">141</span> }<a name="line.141"></a>
<span class="sourceLineNo">142</span> if (k == null) {<a name="line.142"></a>
<span class="sourceLineNo">143</span> continue;<a name="line.143"></a>
<span class="sourceLineNo">144</span> }<a name="line.144"></a>
<span class="sourceLineNo">145</span> if (k == expectedKey) {<a name="line.145"></a>
<span class="sourceLineNo">146</span> // Skip the "sorted key" queue and consume this key.<a name="line.146"></a>
<span class="sourceLineNo">147</span> wroteUpToKey.set(k);<a name="line.147"></a>
<span class="sourceLineNo">148</span> ++expectedKey;<a name="line.148"></a>
<span class="sourceLineNo">149</span> } else {<a name="line.149"></a>
<span class="sourceLineNo">150</span> sortedKeys.add(k);<a name="line.150"></a>
<span class="sourceLineNo">151</span> }<a name="line.151"></a>
<span class="sourceLineNo">152</span><a name="line.152"></a>
<span class="sourceLineNo">153</span> // See if we have a sequence of contiguous keys lined up.<a name="line.153"></a>
<span class="sourceLineNo">154</span> while (!sortedKeys.isEmpty()<a name="line.154"></a>
<span class="sourceLineNo">155</span> &amp;&amp; ((k = sortedKeys.peek()) == expectedKey)) {<a name="line.155"></a>
<span class="sourceLineNo">156</span> sortedKeys.poll();<a name="line.156"></a>
<span class="sourceLineNo">157</span> wroteUpToKey.set(k);<a name="line.157"></a>
<span class="sourceLineNo">158</span> ++expectedKey;<a name="line.158"></a>
<span class="sourceLineNo">159</span> }<a name="line.159"></a>
<span class="sourceLineNo">160</span><a name="line.160"></a>
<span class="sourceLineNo">161</span> wroteKeyQueueSize.set(wroteKeys.size() + sortedKeys.size());<a name="line.161"></a>
<span class="sourceLineNo">162</span> }<a name="line.162"></a>
<span class="sourceLineNo">163</span> } catch (Exception ex) {<a name="line.163"></a>
<span class="sourceLineNo">164</span> LOG.error("Error in inserted/updaed key tracker", ex);<a name="line.164"></a>
<span class="sourceLineNo">165</span> } finally {<a name="line.165"></a>
<span class="sourceLineNo">166</span> numThreadsWorking.decrementAndGet();<a name="line.166"></a>
<span class="sourceLineNo">167</span> }<a name="line.167"></a>
<span class="sourceLineNo">168</span> }<a name="line.168"></a>
<span class="sourceLineNo">169</span> }<a name="line.169"></a>
<span class="sourceLineNo">170</span><a name="line.170"></a>
<span class="sourceLineNo">171</span> public int getNumWriteFailures() {<a name="line.171"></a>
<span class="sourceLineNo">172</span> return failedKeySet.size();<a name="line.172"></a>
<span class="sourceLineNo">173</span> }<a name="line.173"></a>
<span class="sourceLineNo">174</span><a name="line.174"></a>
<span class="sourceLineNo">175</span> /**<a name="line.175"></a>
<span class="sourceLineNo">176</span> * The max key until which all keys have been inserted/updated (successfully or not).<a name="line.176"></a>
<span class="sourceLineNo">177</span> * @return the last key that we have inserted/updated all keys up to (inclusive)<a name="line.177"></a>
<span class="sourceLineNo">178</span> */<a name="line.178"></a>
<span class="sourceLineNo">179</span> public long wroteUpToKey() {<a name="line.179"></a>
<span class="sourceLineNo">180</span> return wroteUpToKey.get();<a name="line.180"></a>
<span class="sourceLineNo">181</span> }<a name="line.181"></a>
<span class="sourceLineNo">182</span><a name="line.182"></a>
<span class="sourceLineNo">183</span> public boolean failedToWriteKey(long k) {<a name="line.183"></a>
<span class="sourceLineNo">184</span> return failedKeySet.contains(k);<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> @Override<a name="line.187"></a>
<span class="sourceLineNo">188</span> protected String progressInfo() {<a name="line.188"></a>
<span class="sourceLineNo">189</span> StringBuilder sb = new StringBuilder();<a name="line.189"></a>
<span class="sourceLineNo">190</span> appendToStatus(sb, "wroteUpTo", wroteUpToKey.get());<a name="line.190"></a>
<span class="sourceLineNo">191</span> appendToStatus(sb, "wroteQSize", wroteKeyQueueSize.get());<a name="line.191"></a>
<span class="sourceLineNo">192</span> return sb.toString();<a name="line.192"></a>
<span class="sourceLineNo">193</span> }<a name="line.193"></a>
<span class="sourceLineNo">194</span><a name="line.194"></a>
<span class="sourceLineNo">195</span> /**<a name="line.195"></a>
<span class="sourceLineNo">196</span> * Used for a joint write/read workload. Enables tracking the last inserted/updated<a name="line.196"></a>
<span class="sourceLineNo">197</span> * key, which requires a blocking queue and a consumer thread.<a name="line.197"></a>
<span class="sourceLineNo">198</span> * @param enable whether to enable tracking the last inserted/updated key<a name="line.198"></a>
<span class="sourceLineNo">199</span> */<a name="line.199"></a>
<span class="sourceLineNo">200</span> public void setTrackWroteKeys(boolean enable) {<a name="line.200"></a>
<span class="sourceLineNo">201</span> trackWroteKeys = enable;<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>
</pre>
</div>
</body>
</html>