| <!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.quotas;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.Arrays;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.List;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span><a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.hadoop.conf.Configuration;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.client.Mutation;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.client.Result;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span><a name="line.29"></a> |
| <span class="sourceLineNo">030</span>@InterfaceAudience.Private<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>@InterfaceStability.Evolving<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>public class DefaultOperationQuota implements OperationQuota {<a name="line.32"></a> |
| <span class="sourceLineNo">033</span><a name="line.33"></a> |
| <span class="sourceLineNo">034</span> protected final List<QuotaLimiter> limiters;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> private final long writeCapacityUnit;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> private final long readCapacityUnit;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span><a name="line.37"></a> |
| <span class="sourceLineNo">038</span> // the available read/write quota size in bytes<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> protected long readAvailable = 0;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> // estimated quota<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> protected long writeConsumed = 0;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> protected long readConsumed = 0;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> protected long writeCapacityUnitConsumed = 0;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> protected long readCapacityUnitConsumed = 0;<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> // real consumed quota<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> private final long[] operationSize;<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> // difference between estimated quota and real consumed quota used in close method<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> // to adjust quota amount. Also used by ExceedOperationQuota which is a subclass<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> // of DefaultOperationQuota<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> protected long writeDiff = 0;<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> protected long readDiff = 0;<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> protected long writeCapacityUnitDiff = 0;<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> protected long readCapacityUnitDiff = 0;<a name="line.53"></a> |
| <span class="sourceLineNo">054</span><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> public DefaultOperationQuota(final Configuration conf, final QuotaLimiter... limiters) {<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> this(conf, Arrays.asList(limiters));<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> }<a name="line.57"></a> |
| <span class="sourceLineNo">058</span><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> /**<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * NOTE: The order matters. It should be something like [user, table, namespace, global]<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> */<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> public DefaultOperationQuota(final Configuration conf, final List<QuotaLimiter> limiters) {<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> this.writeCapacityUnit =<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> conf.getLong(QuotaUtil.WRITE_CAPACITY_UNIT_CONF_KEY, QuotaUtil.DEFAULT_WRITE_CAPACITY_UNIT);<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> this.readCapacityUnit =<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> conf.getLong(QuotaUtil.READ_CAPACITY_UNIT_CONF_KEY, QuotaUtil.DEFAULT_READ_CAPACITY_UNIT);<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> this.limiters = limiters;<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> int size = OperationType.values().length;<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> operationSize = new long[size];<a name="line.69"></a> |
| <span class="sourceLineNo">070</span><a name="line.70"></a> |
| <span class="sourceLineNo">071</span> for (int i = 0; i < size; ++i) {<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> operationSize[i] = 0;<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> }<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> }<a name="line.74"></a> |
| <span class="sourceLineNo">075</span><a name="line.75"></a> |
| <span class="sourceLineNo">076</span> @Override<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> public void checkQuota(int numWrites, int numReads, int numScans) throws RpcThrottlingException {<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> updateEstimateConsumeQuota(numWrites, numReads, numScans);<a name="line.78"></a> |
| <span class="sourceLineNo">079</span><a name="line.79"></a> |
| <span class="sourceLineNo">080</span> readAvailable = Long.MAX_VALUE;<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> for (final QuotaLimiter limiter : limiters) {<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> if (limiter.isBypass()) continue;<a name="line.82"></a> |
| <span class="sourceLineNo">083</span><a name="line.83"></a> |
| <span class="sourceLineNo">084</span> limiter.checkQuota(numWrites, writeConsumed, numReads + numScans, readConsumed,<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> writeCapacityUnitConsumed, readCapacityUnitConsumed);<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> readAvailable = Math.min(readAvailable, limiter.getReadAvailable());<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> }<a name="line.87"></a> |
| <span class="sourceLineNo">088</span><a name="line.88"></a> |
| <span class="sourceLineNo">089</span> for (final QuotaLimiter limiter : limiters) {<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> limiter.grabQuota(numWrites, writeConsumed, numReads + numScans, readConsumed,<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> writeCapacityUnitConsumed, readCapacityUnitConsumed);<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><a name="line.94"></a> |
| <span class="sourceLineNo">095</span> @Override<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> public void close() {<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> // Adjust the quota consumed for the specified operation<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> writeDiff = operationSize[OperationType.MUTATE.ordinal()] - writeConsumed;<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> readDiff = operationSize[OperationType.GET.ordinal()]<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> + operationSize[OperationType.SCAN.ordinal()] - readConsumed;<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> writeCapacityUnitDiff = calculateWriteCapacityUnitDiff(<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> operationSize[OperationType.MUTATE.ordinal()], writeConsumed);<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> readCapacityUnitDiff = calculateReadCapacityUnitDiff(<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> operationSize[OperationType.GET.ordinal()] + operationSize[OperationType.SCAN.ordinal()],<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> readConsumed);<a name="line.105"></a> |
| <span class="sourceLineNo">106</span><a name="line.106"></a> |
| <span class="sourceLineNo">107</span> for (final QuotaLimiter limiter : limiters) {<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> if (writeDiff != 0) {<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> limiter.consumeWrite(writeDiff, writeCapacityUnitDiff);<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> }<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> if (readDiff != 0) {<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> limiter.consumeRead(readDiff, readCapacityUnitDiff);<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> }<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> }<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> }<a name="line.115"></a> |
| <span class="sourceLineNo">116</span><a name="line.116"></a> |
| <span class="sourceLineNo">117</span> @Override<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> public long getReadAvailable() {<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> return readAvailable;<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> @Override<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> public void addGetResult(final Result result) {<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> operationSize[OperationType.GET.ordinal()] += QuotaUtil.calculateResultSize(result);<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> }<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 addScanResult(final List<Result> results) {<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> operationSize[OperationType.SCAN.ordinal()] += QuotaUtil.calculateResultSize(results);<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> }<a name="line.130"></a> |
| <span class="sourceLineNo">131</span><a name="line.131"></a> |
| <span class="sourceLineNo">132</span> @Override<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> public void addMutation(final Mutation mutation) {<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> operationSize[OperationType.MUTATE.ordinal()] += QuotaUtil.calculateMutationSize(mutation);<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> }<a name="line.135"></a> |
| <span class="sourceLineNo">136</span><a name="line.136"></a> |
| <span class="sourceLineNo">137</span> /**<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * Update estimate quota(read/write size/capacityUnits) which will be consumed<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * @param numWrites the number of write requests<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * @param numReads the number of read requests<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * @param numScans the number of scan requests<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> */<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> protected void updateEstimateConsumeQuota(int numWrites, int numReads, int numScans) {<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> writeConsumed = estimateConsume(OperationType.MUTATE, numWrites, 100);<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> readConsumed = estimateConsume(OperationType.GET, numReads, 100);<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> readConsumed += estimateConsume(OperationType.SCAN, numScans, 1000);<a name="line.146"></a> |
| <span class="sourceLineNo">147</span><a name="line.147"></a> |
| <span class="sourceLineNo">148</span> writeCapacityUnitConsumed = calculateWriteCapacityUnit(writeConsumed);<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> readCapacityUnitConsumed = calculateReadCapacityUnit(readConsumed);<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> private long estimateConsume(final OperationType type, int numReqs, long avgSize) {<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> if (numReqs > 0) {<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> return avgSize * numReqs;<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> }<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> return 0;<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> }<a name="line.157"></a> |
| <span class="sourceLineNo">158</span><a name="line.158"></a> |
| <span class="sourceLineNo">159</span> private long calculateWriteCapacityUnit(final long size) {<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> return (long) Math.ceil(size * 1.0 / this.writeCapacityUnit);<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> }<a name="line.161"></a> |
| <span class="sourceLineNo">162</span><a name="line.162"></a> |
| <span class="sourceLineNo">163</span> private long calculateReadCapacityUnit(final long size) {<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> return (long) Math.ceil(size * 1.0 / this.readCapacityUnit);<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> private long calculateWriteCapacityUnitDiff(final long actualSize, final long estimateSize) {<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> return calculateWriteCapacityUnit(actualSize) - calculateWriteCapacityUnit(estimateSize);<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> private long calculateReadCapacityUnitDiff(final long actualSize, final long estimateSize) {<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> return calculateReadCapacityUnit(actualSize) - calculateReadCapacityUnit(estimateSize);<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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
