blob: 90c9392b451656435480bac25b16e4fd4d650158 [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.client, class: AsyncBufferedMutatorImpl">
<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.client;</span>
<span class="source-line-no">019</span><span id="line-19"></span>
<span class="source-line-no">020</span><span id="line-20">import static org.apache.hadoop.hbase.client.ConnectionUtils.validatePut;</span>
<span class="source-line-no">021</span><span id="line-21">import static org.apache.hadoop.hbase.util.FutureUtils.addListener;</span>
<span class="source-line-no">022</span><span id="line-22"></span>
<span class="source-line-no">023</span><span id="line-23">import java.io.IOException;</span>
<span class="source-line-no">024</span><span id="line-24">import java.util.ArrayList;</span>
<span class="source-line-no">025</span><span id="line-25">import java.util.Iterator;</span>
<span class="source-line-no">026</span><span id="line-26">import java.util.List;</span>
<span class="source-line-no">027</span><span id="line-27">import java.util.concurrent.CompletableFuture;</span>
<span class="source-line-no">028</span><span id="line-28">import java.util.concurrent.TimeUnit;</span>
<span class="source-line-no">029</span><span id="line-29">import java.util.stream.Collectors;</span>
<span class="source-line-no">030</span><span id="line-30">import java.util.stream.Stream;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.TableName;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">034</span><span id="line-34"></span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hbase.thirdparty.io.netty.util.HashedWheelTimer;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hbase.thirdparty.io.netty.util.Timeout;</span>
<span class="source-line-no">037</span><span id="line-37"></span>
<span class="source-line-no">038</span><span id="line-38">/**</span>
<span class="source-line-no">039</span><span id="line-39"> * The implementation of {@link AsyncBufferedMutator}. Simply wrap an {@link AsyncTable}.</span>
<span class="source-line-no">040</span><span id="line-40"> */</span>
<span class="source-line-no">041</span><span id="line-41">@InterfaceAudience.Private</span>
<span class="source-line-no">042</span><span id="line-42">class AsyncBufferedMutatorImpl implements AsyncBufferedMutator {</span>
<span class="source-line-no">043</span><span id="line-43"></span>
<span class="source-line-no">044</span><span id="line-44"> private final HashedWheelTimer periodicalFlushTimer;</span>
<span class="source-line-no">045</span><span id="line-45"></span>
<span class="source-line-no">046</span><span id="line-46"> private final AsyncTable&lt;?&gt; table;</span>
<span class="source-line-no">047</span><span id="line-47"></span>
<span class="source-line-no">048</span><span id="line-48"> private final long writeBufferSize;</span>
<span class="source-line-no">049</span><span id="line-49"></span>
<span class="source-line-no">050</span><span id="line-50"> private final long periodicFlushTimeoutNs;</span>
<span class="source-line-no">051</span><span id="line-51"></span>
<span class="source-line-no">052</span><span id="line-52"> private final int maxKeyValueSize;</span>
<span class="source-line-no">053</span><span id="line-53"></span>
<span class="source-line-no">054</span><span id="line-54"> private List&lt;Mutation&gt; mutations = new ArrayList&lt;&gt;();</span>
<span class="source-line-no">055</span><span id="line-55"></span>
<span class="source-line-no">056</span><span id="line-56"> private List&lt;CompletableFuture&lt;Void&gt;&gt; futures = new ArrayList&lt;&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"> private long bufferedSize;</span>
<span class="source-line-no">059</span><span id="line-59"></span>
<span class="source-line-no">060</span><span id="line-60"> private boolean closed;</span>
<span class="source-line-no">061</span><span id="line-61"></span>
<span class="source-line-no">062</span><span id="line-62"> Timeout periodicFlushTask;</span>
<span class="source-line-no">063</span><span id="line-63"></span>
<span class="source-line-no">064</span><span id="line-64"> AsyncBufferedMutatorImpl(HashedWheelTimer periodicalFlushTimer, AsyncTable&lt;?&gt; table,</span>
<span class="source-line-no">065</span><span id="line-65"> long writeBufferSize, long periodicFlushTimeoutNs, int maxKeyValueSize) {</span>
<span class="source-line-no">066</span><span id="line-66"> this.periodicalFlushTimer = periodicalFlushTimer;</span>
<span class="source-line-no">067</span><span id="line-67"> this.table = table;</span>
<span class="source-line-no">068</span><span id="line-68"> this.writeBufferSize = writeBufferSize;</span>
<span class="source-line-no">069</span><span id="line-69"> this.periodicFlushTimeoutNs = periodicFlushTimeoutNs;</span>
<span class="source-line-no">070</span><span id="line-70"> this.maxKeyValueSize = maxKeyValueSize;</span>
<span class="source-line-no">071</span><span id="line-71"> }</span>
<span class="source-line-no">072</span><span id="line-72"></span>
<span class="source-line-no">073</span><span id="line-73"> @Override</span>
<span class="source-line-no">074</span><span id="line-74"> public TableName getName() {</span>
<span class="source-line-no">075</span><span id="line-75"> return table.getName();</span>
<span class="source-line-no">076</span><span id="line-76"> }</span>
<span class="source-line-no">077</span><span id="line-77"></span>
<span class="source-line-no">078</span><span id="line-78"> @Override</span>
<span class="source-line-no">079</span><span id="line-79"> public Configuration getConfiguration() {</span>
<span class="source-line-no">080</span><span id="line-80"> return table.getConfiguration();</span>
<span class="source-line-no">081</span><span id="line-81"> }</span>
<span class="source-line-no">082</span><span id="line-82"></span>
<span class="source-line-no">083</span><span id="line-83"> // will be overridden in test</span>
<span class="source-line-no">084</span><span id="line-84"> protected void internalFlush() {</span>
<span class="source-line-no">085</span><span id="line-85"> if (periodicFlushTask != null) {</span>
<span class="source-line-no">086</span><span id="line-86"> periodicFlushTask.cancel();</span>
<span class="source-line-no">087</span><span id="line-87"> periodicFlushTask = null;</span>
<span class="source-line-no">088</span><span id="line-88"> }</span>
<span class="source-line-no">089</span><span id="line-89"> List&lt;Mutation&gt; toSend = this.mutations;</span>
<span class="source-line-no">090</span><span id="line-90"> if (toSend.isEmpty()) {</span>
<span class="source-line-no">091</span><span id="line-91"> return;</span>
<span class="source-line-no">092</span><span id="line-92"> }</span>
<span class="source-line-no">093</span><span id="line-93"> List&lt;CompletableFuture&lt;Void&gt;&gt; toComplete = this.futures;</span>
<span class="source-line-no">094</span><span id="line-94"> assert toSend.size() == toComplete.size();</span>
<span class="source-line-no">095</span><span id="line-95"> this.mutations = new ArrayList&lt;&gt;();</span>
<span class="source-line-no">096</span><span id="line-96"> this.futures = new ArrayList&lt;&gt;();</span>
<span class="source-line-no">097</span><span id="line-97"> bufferedSize = 0L;</span>
<span class="source-line-no">098</span><span id="line-98"> Iterator&lt;CompletableFuture&lt;Void&gt;&gt; toCompleteIter = toComplete.iterator();</span>
<span class="source-line-no">099</span><span id="line-99"> for (CompletableFuture&lt;?&gt; future : table.batch(toSend)) {</span>
<span class="source-line-no">100</span><span id="line-100"> CompletableFuture&lt;Void&gt; toCompleteFuture = toCompleteIter.next();</span>
<span class="source-line-no">101</span><span id="line-101"> addListener(future, (r, e) -&gt; {</span>
<span class="source-line-no">102</span><span id="line-102"> if (e != null) {</span>
<span class="source-line-no">103</span><span id="line-103"> toCompleteFuture.completeExceptionally(e);</span>
<span class="source-line-no">104</span><span id="line-104"> } else {</span>
<span class="source-line-no">105</span><span id="line-105"> toCompleteFuture.complete(null);</span>
<span class="source-line-no">106</span><span id="line-106"> }</span>
<span class="source-line-no">107</span><span id="line-107"> });</span>
<span class="source-line-no">108</span><span id="line-108"> }</span>
<span class="source-line-no">109</span><span id="line-109"> }</span>
<span class="source-line-no">110</span><span id="line-110"></span>
<span class="source-line-no">111</span><span id="line-111"> @Override</span>
<span class="source-line-no">112</span><span id="line-112"> public List&lt;CompletableFuture&lt;Void&gt;&gt; mutate(List&lt;? extends Mutation&gt; mutations) {</span>
<span class="source-line-no">113</span><span id="line-113"> List&lt;CompletableFuture&lt;Void&gt;&gt; futures =</span>
<span class="source-line-no">114</span><span id="line-114"> Stream.&lt;CompletableFuture&lt;Void&gt;&gt; generate(CompletableFuture::new).limit(mutations.size())</span>
<span class="source-line-no">115</span><span id="line-115"> .collect(Collectors.toList());</span>
<span class="source-line-no">116</span><span id="line-116"> long heapSize = 0;</span>
<span class="source-line-no">117</span><span id="line-117"> for (Mutation mutation : mutations) {</span>
<span class="source-line-no">118</span><span id="line-118"> heapSize += mutation.heapSize();</span>
<span class="source-line-no">119</span><span id="line-119"> if (mutation instanceof Put) {</span>
<span class="source-line-no">120</span><span id="line-120"> validatePut((Put) mutation, maxKeyValueSize);</span>
<span class="source-line-no">121</span><span id="line-121"> }</span>
<span class="source-line-no">122</span><span id="line-122"> }</span>
<span class="source-line-no">123</span><span id="line-123"> synchronized (this) {</span>
<span class="source-line-no">124</span><span id="line-124"> if (closed) {</span>
<span class="source-line-no">125</span><span id="line-125"> IOException ioe = new IOException("Already closed");</span>
<span class="source-line-no">126</span><span id="line-126"> futures.forEach(f -&gt; f.completeExceptionally(ioe));</span>
<span class="source-line-no">127</span><span id="line-127"> return futures;</span>
<span class="source-line-no">128</span><span id="line-128"> }</span>
<span class="source-line-no">129</span><span id="line-129"> if (this.mutations.isEmpty() &amp;&amp; periodicFlushTimeoutNs &gt; 0) {</span>
<span class="source-line-no">130</span><span id="line-130"> periodicFlushTask = periodicalFlushTimer.newTimeout(timeout -&gt; {</span>
<span class="source-line-no">131</span><span id="line-131"> synchronized (AsyncBufferedMutatorImpl.this) {</span>
<span class="source-line-no">132</span><span id="line-132"> // confirm that we are still valid, if there is already an internalFlush call before us,</span>
<span class="source-line-no">133</span><span id="line-133"> // then we should not execute any more. And in internalFlush we will set periodicFlush</span>
<span class="source-line-no">134</span><span id="line-134"> // to null, and since we may schedule a new one, so here we check whether the references</span>
<span class="source-line-no">135</span><span id="line-135"> // are equal.</span>
<span class="source-line-no">136</span><span id="line-136"> if (timeout == periodicFlushTask) {</span>
<span class="source-line-no">137</span><span id="line-137"> periodicFlushTask = null;</span>
<span class="source-line-no">138</span><span id="line-138"> internalFlush();</span>
<span class="source-line-no">139</span><span id="line-139"> }</span>
<span class="source-line-no">140</span><span id="line-140"> }</span>
<span class="source-line-no">141</span><span id="line-141"> }, periodicFlushTimeoutNs, TimeUnit.NANOSECONDS);</span>
<span class="source-line-no">142</span><span id="line-142"> }</span>
<span class="source-line-no">143</span><span id="line-143"> this.mutations.addAll(mutations);</span>
<span class="source-line-no">144</span><span id="line-144"> this.futures.addAll(futures);</span>
<span class="source-line-no">145</span><span id="line-145"> bufferedSize += heapSize;</span>
<span class="source-line-no">146</span><span id="line-146"> if (bufferedSize &gt;= writeBufferSize) {</span>
<span class="source-line-no">147</span><span id="line-147"> internalFlush();</span>
<span class="source-line-no">148</span><span id="line-148"> }</span>
<span class="source-line-no">149</span><span id="line-149"> }</span>
<span class="source-line-no">150</span><span id="line-150"> return futures;</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"> @Override</span>
<span class="source-line-no">154</span><span id="line-154"> public synchronized void flush() {</span>
<span class="source-line-no">155</span><span id="line-155"> internalFlush();</span>
<span class="source-line-no">156</span><span id="line-156"> }</span>
<span class="source-line-no">157</span><span id="line-157"></span>
<span class="source-line-no">158</span><span id="line-158"> @Override</span>
<span class="source-line-no">159</span><span id="line-159"> public synchronized void close() {</span>
<span class="source-line-no">160</span><span id="line-160"> internalFlush();</span>
<span class="source-line-no">161</span><span id="line-161"> closed = true;</span>
<span class="source-line-no">162</span><span id="line-162"> }</span>
<span class="source-line-no">163</span><span id="line-163"></span>
<span class="source-line-no">164</span><span id="line-164"> @Override</span>
<span class="source-line-no">165</span><span id="line-165"> public long getWriteBufferSize() {</span>
<span class="source-line-no">166</span><span id="line-166"> return writeBufferSize;</span>
<span class="source-line-no">167</span><span id="line-167"> }</span>
<span class="source-line-no">168</span><span id="line-168"></span>
<span class="source-line-no">169</span><span id="line-169"> @Override</span>
<span class="source-line-no">170</span><span id="line-170"> public long getPeriodicalFlushTimeout(TimeUnit unit) {</span>
<span class="source-line-no">171</span><span id="line-171"> return unit.convert(periodicFlushTimeoutNs, TimeUnit.NANOSECONDS);</span>
<span class="source-line-no">172</span><span id="line-172"> }</span>
<span class="source-line-no">173</span><span id="line-173">}</span>
</pre>
</div>
</main>
</body>
</html>