| <!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.ipc, class: AnnotationReadingPriorityFunction"> |
| <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.ipc;</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.lang.reflect.Method;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.util.HashMap;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.Map;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.commons.lang3.StringUtils;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.HBaseRpcServicesBase;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.HConstants;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.security.User;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">028</span><span id="line-28"></span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hbase.thirdparty.com.google.protobuf.Message;</span> |
| <span class="source-line-no">030</span><span id="line-30"></span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.RequestHeader;</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"> * Reads special method annotations and table names to figure a priority for use by QoS facility in</span> |
| <span class="source-line-no">035</span><span id="line-35"> * ipc; e.g: rpcs to hbase:meta get priority.</span> |
| <span class="source-line-no">036</span><span id="line-36"> */</span> |
| <span class="source-line-no">037</span><span id="line-37">// TODO: Remove. This is doing way too much work just to figure a priority. Do as Elliott</span> |
| <span class="source-line-no">038</span><span id="line-38">// suggests and just have the client specify a priority.</span> |
| <span class="source-line-no">039</span><span id="line-39"></span> |
| <span class="source-line-no">040</span><span id="line-40">// The logic for figuring out high priority RPCs is as follows:</span> |
| <span class="source-line-no">041</span><span id="line-41">// 1. if the method is annotated with a QosPriority of QOS_HIGH,</span> |
| <span class="source-line-no">042</span><span id="line-42">// that is honored</span> |
| <span class="source-line-no">043</span><span id="line-43">// 2. parse out the protobuf message and see if the request is for meta</span> |
| <span class="source-line-no">044</span><span id="line-44">// region, and if so, treat it as a high priority RPC</span> |
| <span class="source-line-no">045</span><span id="line-45">// Some optimizations for (2) are done in the sub classes -</span> |
| <span class="source-line-no">046</span><span id="line-46">// Clients send the argument classname as part of making the RPC. The server</span> |
| <span class="source-line-no">047</span><span id="line-47">// decides whether to deserialize the proto argument message based on the</span> |
| <span class="source-line-no">048</span><span id="line-48">// pre-established set of argument classes (knownArgumentClasses below).</span> |
| <span class="source-line-no">049</span><span id="line-49">// This prevents the server from having to deserialize all proto argument</span> |
| <span class="source-line-no">050</span><span id="line-50">// messages prematurely.</span> |
| <span class="source-line-no">051</span><span id="line-51">// All the argument classes declare a 'getRegion' method that returns a</span> |
| <span class="source-line-no">052</span><span id="line-52">// RegionSpecifier object. Methods can be invoked on the returned object</span> |
| <span class="source-line-no">053</span><span id="line-53">// to figure out whether it is a meta region or not.</span> |
| <span class="source-line-no">054</span><span id="line-54">@InterfaceAudience.Private</span> |
| <span class="source-line-no">055</span><span id="line-55">public abstract class AnnotationReadingPriorityFunction<T extends HBaseRpcServicesBase<?>></span> |
| <span class="source-line-no">056</span><span id="line-56"> implements PriorityFunction {</span> |
| <span class="source-line-no">057</span><span id="line-57"></span> |
| <span class="source-line-no">058</span><span id="line-58"> protected final Map<String, Integer> annotatedQos;</span> |
| <span class="source-line-no">059</span><span id="line-59"> // We need to mock the regionserver instance for some unit tests (set via</span> |
| <span class="source-line-no">060</span><span id="line-60"> // setRegionServer method.</span> |
| <span class="source-line-no">061</span><span id="line-61"> protected final T rpcServices;</span> |
| <span class="source-line-no">062</span><span id="line-62"></span> |
| <span class="source-line-no">063</span><span id="line-63"> /**</span> |
| <span class="source-line-no">064</span><span id="line-64"> * Constructs the priority function given the RPC server implementation and the annotations on the</span> |
| <span class="source-line-no">065</span><span id="line-65"> * methods.</span> |
| <span class="source-line-no">066</span><span id="line-66"> * @param rpcServices The RPC server implementation</span> |
| <span class="source-line-no">067</span><span id="line-67"> */</span> |
| <span class="source-line-no">068</span><span id="line-68"> public AnnotationReadingPriorityFunction(final T rpcServices) {</span> |
| <span class="source-line-no">069</span><span id="line-69"> Map<String, Integer> qosMap = new HashMap<>();</span> |
| <span class="source-line-no">070</span><span id="line-70"> for (Method m : rpcServices.getClass().getMethods()) {</span> |
| <span class="source-line-no">071</span><span id="line-71"> QosPriority p = m.getAnnotation(QosPriority.class);</span> |
| <span class="source-line-no">072</span><span id="line-72"> if (p != null) {</span> |
| <span class="source-line-no">073</span><span id="line-73"> // Since we protobuf'd, and then subsequently, when we went with pb style, method names</span> |
| <span class="source-line-no">074</span><span id="line-74"> // are capitalized. This meant that this brittle compare of method names gotten by</span> |
| <span class="source-line-no">075</span><span id="line-75"> // reflection no longer matched the method names coming in over pb.</span> |
| <span class="source-line-no">076</span><span id="line-76"> // TODO: Get rid of this check. For now, workaround is to capitalize the names we got from</span> |
| <span class="source-line-no">077</span><span id="line-77"> // reflection so they have chance of matching the pb ones.</span> |
| <span class="source-line-no">078</span><span id="line-78"> String capitalizedMethodName = StringUtils.capitalize(m.getName());</span> |
| <span class="source-line-no">079</span><span id="line-79"> qosMap.put(capitalizedMethodName, p.priority());</span> |
| <span class="source-line-no">080</span><span id="line-80"> }</span> |
| <span class="source-line-no">081</span><span id="line-81"> }</span> |
| <span class="source-line-no">082</span><span id="line-82"> this.rpcServices = rpcServices;</span> |
| <span class="source-line-no">083</span><span id="line-83"> this.annotatedQos = qosMap;</span> |
| <span class="source-line-no">084</span><span id="line-84"> }</span> |
| <span class="source-line-no">085</span><span id="line-85"></span> |
| <span class="source-line-no">086</span><span id="line-86"> /**</span> |
| <span class="source-line-no">087</span><span id="line-87"> * Returns a 'priority' based on the request type.</span> |
| <span class="source-line-no">088</span><span id="line-88"> * <p/></span> |
| <span class="source-line-no">089</span><span id="line-89"> * Currently the returned priority is used for queue selection.</span> |
| <span class="source-line-no">090</span><span id="line-90"> * <p/></span> |
| <span class="source-line-no">091</span><span id="line-91"> * See the {@code SimpleRpcScheduler} as example. It maintains a queue per 'priority type':</span> |
| <span class="source-line-no">092</span><span id="line-92"> * <ul></span> |
| <span class="source-line-no">093</span><span id="line-93"> * <li>HIGH_QOS (meta requests)</li></span> |
| <span class="source-line-no">094</span><span id="line-94"> * <li>REPLICATION_QOS (replication requests)</li></span> |
| <span class="source-line-no">095</span><span id="line-95"> * <li>NORMAL_QOS (user requests).</li></span> |
| <span class="source-line-no">096</span><span id="line-96"> * </ul></span> |
| <span class="source-line-no">097</span><span id="line-97"> */</span> |
| <span class="source-line-no">098</span><span id="line-98"> @Override</span> |
| <span class="source-line-no">099</span><span id="line-99"> public int getPriority(RequestHeader header, Message param, User user) {</span> |
| <span class="source-line-no">100</span><span id="line-100"> int priorityByAnnotation = getAnnotatedPriority(header);</span> |
| <span class="source-line-no">101</span><span id="line-101"></span> |
| <span class="source-line-no">102</span><span id="line-102"> if (priorityByAnnotation >= 0) {</span> |
| <span class="source-line-no">103</span><span id="line-103"> return priorityByAnnotation;</span> |
| <span class="source-line-no">104</span><span id="line-104"> }</span> |
| <span class="source-line-no">105</span><span id="line-105"> if (param == null) {</span> |
| <span class="source-line-no">106</span><span id="line-106"> return HConstants.NORMAL_QOS;</span> |
| <span class="source-line-no">107</span><span id="line-107"> }</span> |
| <span class="source-line-no">108</span><span id="line-108"> return getBasePriority(header, param);</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"> /**</span> |
| <span class="source-line-no">112</span><span id="line-112"> * See if the method has an annotation.</span> |
| <span class="source-line-no">113</span><span id="line-113"> * @return Return the priority from the annotation. If there isn't an annotation, this returns</span> |
| <span class="source-line-no">114</span><span id="line-114"> * something below zero.</span> |
| <span class="source-line-no">115</span><span id="line-115"> */</span> |
| <span class="source-line-no">116</span><span id="line-116"> protected int getAnnotatedPriority(RequestHeader header) {</span> |
| <span class="source-line-no">117</span><span id="line-117"> String methodName = header.getMethodName();</span> |
| <span class="source-line-no">118</span><span id="line-118"> Integer priorityByAnnotation = annotatedQos.get(methodName);</span> |
| <span class="source-line-no">119</span><span id="line-119"> if (priorityByAnnotation != null) {</span> |
| <span class="source-line-no">120</span><span id="line-120"> return normalizePriority(priorityByAnnotation);</span> |
| <span class="source-line-no">121</span><span id="line-121"> }</span> |
| <span class="source-line-no">122</span><span id="line-122"> return -1;</span> |
| <span class="source-line-no">123</span><span id="line-123"> }</span> |
| <span class="source-line-no">124</span><span id="line-124"></span> |
| <span class="source-line-no">125</span><span id="line-125"> protected abstract int normalizePriority(int priority);</span> |
| <span class="source-line-no">126</span><span id="line-126"></span> |
| <span class="source-line-no">127</span><span id="line-127"> /**</span> |
| <span class="source-line-no">128</span><span id="line-128"> * Get the priority for a given request from the header and the param.</span> |
| <span class="source-line-no">129</span><span id="line-129"> * <p/></span> |
| <span class="source-line-no">130</span><span id="line-130"> * This doesn't consider which user is sending the request at all.</span> |
| <span class="source-line-no">131</span><span id="line-131"> * <p/></span> |
| <span class="source-line-no">132</span><span id="line-132"> * This doesn't consider annotations</span> |
| <span class="source-line-no">133</span><span id="line-133"> */</span> |
| <span class="source-line-no">134</span><span id="line-134"> protected abstract int getBasePriority(RequestHeader header, Message param);</span> |
| <span class="source-line-no">135</span><span id="line-135">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
