blob: d70d159818d102d22edeb7e9496aa257f1276952 [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>package org.apache.hadoop.hbase.regionserver;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.lang.reflect.Method;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.HashMap;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.Map;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.hadoop.conf.Configuration;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.HConstants;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.ipc.AnnotationReadingPriorityFunction;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.slf4j.Logger;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.slf4j.LoggerFactory;<a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hbase.thirdparty.com.google.protobuf.Message;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hbase.thirdparty.com.google.protobuf.TextFormat;<a name="line.31"></a>
<span class="sourceLineNo">032</span><a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.CloseRegionRequest;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.CompactRegionRequest;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.FlushRegionRequest;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.GetRegionInfoRequest;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.GetStoreFileRequest;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.BulkLoadHFileRequest;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.GetRequest;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.MutateRequest;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ScanRequest;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos.RegionSpecifier;<a name="line.42"></a>
<span class="sourceLineNo">043</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.RequestHeader;<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span>/**<a name="line.45"></a>
<span class="sourceLineNo">046</span> * Priority function specifically for the region server.<a name="line.46"></a>
<span class="sourceLineNo">047</span> */<a name="line.47"></a>
<span class="sourceLineNo">048</span>@InterfaceAudience.Private<a name="line.48"></a>
<span class="sourceLineNo">049</span>class RSAnnotationReadingPriorityFunction extends AnnotationReadingPriorityFunction&lt;RSRpcServices&gt; {<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> private static final Logger LOG =<a name="line.51"></a>
<span class="sourceLineNo">052</span> LoggerFactory.getLogger(RSAnnotationReadingPriorityFunction.class);<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span> /** Used to control the scan delay, currently sqrt(numNextCall * weight) */<a name="line.54"></a>
<span class="sourceLineNo">055</span> public static final String SCAN_VTIME_WEIGHT_CONF_KEY = "hbase.ipc.server.scan.vtime.weight";<a name="line.55"></a>
<span class="sourceLineNo">056</span><a name="line.56"></a>
<span class="sourceLineNo">057</span> @SuppressWarnings("unchecked")<a name="line.57"></a>
<span class="sourceLineNo">058</span> private final Class&lt;? extends Message&gt;[] knownArgumentClasses =<a name="line.58"></a>
<span class="sourceLineNo">059</span> new Class[] { GetRegionInfoRequest.class, GetStoreFileRequest.class, CloseRegionRequest.class,<a name="line.59"></a>
<span class="sourceLineNo">060</span> FlushRegionRequest.class, CompactRegionRequest.class, GetRequest.class, MutateRequest.class,<a name="line.60"></a>
<span class="sourceLineNo">061</span> ScanRequest.class };<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span> // Some caches for helping performance<a name="line.63"></a>
<span class="sourceLineNo">064</span> private final Map&lt;String, Class&lt;? extends Message&gt;&gt; argumentToClassMap = new HashMap&lt;&gt;();<a name="line.64"></a>
<span class="sourceLineNo">065</span> private final Map&lt;String, Map&lt;Class&lt;? extends Message&gt;, Method&gt;&gt; methodMap = new HashMap&lt;&gt;();<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span> private final float scanVirtualTimeWeight;<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span> RSAnnotationReadingPriorityFunction(RSRpcServices rpcServices) {<a name="line.69"></a>
<span class="sourceLineNo">070</span> super(rpcServices);<a name="line.70"></a>
<span class="sourceLineNo">071</span> if (methodMap.get("getRegion") == null) {<a name="line.71"></a>
<span class="sourceLineNo">072</span> methodMap.put("hasRegion", new HashMap&lt;&gt;());<a name="line.72"></a>
<span class="sourceLineNo">073</span> methodMap.put("getRegion", new HashMap&lt;&gt;());<a name="line.73"></a>
<span class="sourceLineNo">074</span> }<a name="line.74"></a>
<span class="sourceLineNo">075</span> for (Class&lt;? extends Message&gt; cls : knownArgumentClasses) {<a name="line.75"></a>
<span class="sourceLineNo">076</span> argumentToClassMap.put(cls.getName(), cls);<a name="line.76"></a>
<span class="sourceLineNo">077</span> try {<a name="line.77"></a>
<span class="sourceLineNo">078</span> methodMap.get("hasRegion").put(cls, cls.getDeclaredMethod("hasRegion"));<a name="line.78"></a>
<span class="sourceLineNo">079</span> methodMap.get("getRegion").put(cls, cls.getDeclaredMethod("getRegion"));<a name="line.79"></a>
<span class="sourceLineNo">080</span> } catch (Exception e) {<a name="line.80"></a>
<span class="sourceLineNo">081</span> throw new RuntimeException(e);<a name="line.81"></a>
<span class="sourceLineNo">082</span> }<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> Configuration conf = rpcServices.getConfiguration();<a name="line.85"></a>
<span class="sourceLineNo">086</span> scanVirtualTimeWeight = conf.getFloat(SCAN_VTIME_WEIGHT_CONF_KEY, 1.0f);<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> @Override<a name="line.89"></a>
<span class="sourceLineNo">090</span> protected int normalizePriority(int priority) {<a name="line.90"></a>
<span class="sourceLineNo">091</span> return priority;<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> @Override<a name="line.94"></a>
<span class="sourceLineNo">095</span> protected int getBasePriority(RequestHeader header, Message param) {<a name="line.95"></a>
<span class="sourceLineNo">096</span> // Trust the client-set priorities if set<a name="line.96"></a>
<span class="sourceLineNo">097</span> if (header.hasPriority()) {<a name="line.97"></a>
<span class="sourceLineNo">098</span> return header.getPriority();<a name="line.98"></a>
<span class="sourceLineNo">099</span> }<a name="line.99"></a>
<span class="sourceLineNo">100</span> if (param instanceof BulkLoadHFileRequest) {<a name="line.100"></a>
<span class="sourceLineNo">101</span> return HConstants.BULKLOAD_QOS;<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> String cls = param.getClass().getName();<a name="line.104"></a>
<span class="sourceLineNo">105</span> Class&lt;? extends Message&gt; rpcArgClass = argumentToClassMap.get(cls);<a name="line.105"></a>
<span class="sourceLineNo">106</span> RegionSpecifier regionSpecifier = null;<a name="line.106"></a>
<span class="sourceLineNo">107</span> // check whether the request has reference to meta region or now.<a name="line.107"></a>
<span class="sourceLineNo">108</span> try {<a name="line.108"></a>
<span class="sourceLineNo">109</span> // Check if the param has a region specifier; the pb methods are hasRegion and getRegion if<a name="line.109"></a>
<span class="sourceLineNo">110</span> // hasRegion returns true. Not all listed methods have region specifier each time. For<a name="line.110"></a>
<span class="sourceLineNo">111</span> // example, the ScanRequest has it on setup but thereafter relies on the scannerid rather than<a name="line.111"></a>
<span class="sourceLineNo">112</span> // send the region over every time.<a name="line.112"></a>
<span class="sourceLineNo">113</span> Method hasRegion = methodMap.get("hasRegion").get(rpcArgClass);<a name="line.113"></a>
<span class="sourceLineNo">114</span> if (hasRegion != null &amp;&amp; (Boolean) hasRegion.invoke(param, (Object[]) null)) {<a name="line.114"></a>
<span class="sourceLineNo">115</span> Method getRegion = methodMap.get("getRegion").get(rpcArgClass);<a name="line.115"></a>
<span class="sourceLineNo">116</span> regionSpecifier = (RegionSpecifier) getRegion.invoke(param, (Object[]) null);<a name="line.116"></a>
<span class="sourceLineNo">117</span> Region region = rpcServices.getRegion(regionSpecifier);<a name="line.117"></a>
<span class="sourceLineNo">118</span> if (region.getRegionInfo().getTable().isSystemTable()) {<a name="line.118"></a>
<span class="sourceLineNo">119</span> if (LOG.isTraceEnabled()) {<a name="line.119"></a>
<span class="sourceLineNo">120</span> LOG.trace(<a name="line.120"></a>
<span class="sourceLineNo">121</span> "High priority because region=" + region.getRegionInfo().getRegionNameAsString());<a name="line.121"></a>
<span class="sourceLineNo">122</span> }<a name="line.122"></a>
<span class="sourceLineNo">123</span> return HConstants.SYSTEMTABLE_QOS;<a name="line.123"></a>
<span class="sourceLineNo">124</span> }<a name="line.124"></a>
<span class="sourceLineNo">125</span> }<a name="line.125"></a>
<span class="sourceLineNo">126</span> } catch (Exception ex) {<a name="line.126"></a>
<span class="sourceLineNo">127</span> // Not good throwing an exception out of here, a runtime anyways. Let the query go into the<a name="line.127"></a>
<span class="sourceLineNo">128</span> // server and have it throw the exception if still an issue. Just mark it normal priority.<a name="line.128"></a>
<span class="sourceLineNo">129</span> if (LOG.isTraceEnabled()) LOG.trace("Marking normal priority after getting exception=" + ex);<a name="line.129"></a>
<span class="sourceLineNo">130</span> return HConstants.NORMAL_QOS;<a name="line.130"></a>
<span class="sourceLineNo">131</span> }<a name="line.131"></a>
<span class="sourceLineNo">132</span><a name="line.132"></a>
<span class="sourceLineNo">133</span> if (param instanceof ScanRequest) { // scanner methods...<a name="line.133"></a>
<span class="sourceLineNo">134</span> ScanRequest request = (ScanRequest) param;<a name="line.134"></a>
<span class="sourceLineNo">135</span> if (!request.hasScannerId()) {<a name="line.135"></a>
<span class="sourceLineNo">136</span> return HConstants.NORMAL_QOS;<a name="line.136"></a>
<span class="sourceLineNo">137</span> }<a name="line.137"></a>
<span class="sourceLineNo">138</span> RegionScanner scanner = rpcServices.getScanner(request.getScannerId());<a name="line.138"></a>
<span class="sourceLineNo">139</span> if (scanner != null &amp;&amp; scanner.getRegionInfo().getTable().isSystemTable()) {<a name="line.139"></a>
<span class="sourceLineNo">140</span> if (LOG.isTraceEnabled()) {<a name="line.140"></a>
<span class="sourceLineNo">141</span> // Scanner requests are small in size so TextFormat version should not overwhelm log.<a name="line.141"></a>
<span class="sourceLineNo">142</span> LOG.trace("High priority scanner request " + TextFormat.shortDebugString(request));<a name="line.142"></a>
<span class="sourceLineNo">143</span> }<a name="line.143"></a>
<span class="sourceLineNo">144</span> return HConstants.SYSTEMTABLE_QOS;<a name="line.144"></a>
<span class="sourceLineNo">145</span> }<a name="line.145"></a>
<span class="sourceLineNo">146</span> }<a name="line.146"></a>
<span class="sourceLineNo">147</span><a name="line.147"></a>
<span class="sourceLineNo">148</span> return HConstants.NORMAL_QOS;<a name="line.148"></a>
<span class="sourceLineNo">149</span> }<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> * Based on the request content, returns the deadline of the request.<a name="line.152"></a>
<span class="sourceLineNo">153</span> * @return Deadline of this request. 0 now, otherwise msec of 'delay'<a name="line.153"></a>
<span class="sourceLineNo">154</span> */<a name="line.154"></a>
<span class="sourceLineNo">155</span> @Override<a name="line.155"></a>
<span class="sourceLineNo">156</span> public long getDeadline(RequestHeader header, Message param) {<a name="line.156"></a>
<span class="sourceLineNo">157</span> if (param instanceof ScanRequest) {<a name="line.157"></a>
<span class="sourceLineNo">158</span> ScanRequest request = (ScanRequest) param;<a name="line.158"></a>
<span class="sourceLineNo">159</span> if (!request.hasScannerId()) {<a name="line.159"></a>
<span class="sourceLineNo">160</span> return 0;<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> // get the 'virtual time' of the scanner, and applies sqrt() to get a<a name="line.163"></a>
<span class="sourceLineNo">164</span> // nice curve for the delay. More a scanner is used the less priority it gets.<a name="line.164"></a>
<span class="sourceLineNo">165</span> // The weight is used to have more control on the delay.<a name="line.165"></a>
<span class="sourceLineNo">166</span> long vtime = rpcServices.getScannerVirtualTime(request.getScannerId());<a name="line.166"></a>
<span class="sourceLineNo">167</span> return Math.round(Math.sqrt(vtime * scanVirtualTimeWeight));<a name="line.167"></a>
<span class="sourceLineNo">168</span> }<a name="line.168"></a>
<span class="sourceLineNo">169</span> return 0;<a name="line.169"></a>
<span class="sourceLineNo">170</span> }<a name="line.170"></a>
<span class="sourceLineNo">171</span>}<a name="line.171"></a>
</pre>
</div>
</body>
</html>