blob: b98b97c0c6d323c3bc7144baf13afc0a6da6d5fb [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.quotas, class: QuotaCache, class: QuotaRefresherChore">
<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.quotas;</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.util.ConcurrentMapUtils.computeIfAbsent;</span>
<span class="source-line-no">021</span><span id="line-21"></span>
<span class="source-line-no">022</span><span id="line-22">import java.io.IOException;</span>
<span class="source-line-no">023</span><span id="line-23">import java.util.ArrayList;</span>
<span class="source-line-no">024</span><span id="line-24">import java.util.EnumSet;</span>
<span class="source-line-no">025</span><span id="line-25">import java.util.List;</span>
<span class="source-line-no">026</span><span id="line-26">import java.util.Map;</span>
<span class="source-line-no">027</span><span id="line-27">import java.util.Optional;</span>
<span class="source-line-no">028</span><span id="line-28">import java.util.Set;</span>
<span class="source-line-no">029</span><span id="line-29">import java.util.concurrent.ConcurrentHashMap;</span>
<span class="source-line-no">030</span><span id="line-30">import java.util.concurrent.ConcurrentMap;</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.ClusterMetrics;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.ClusterMetrics.Option;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.ScheduledChore;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.Stoppable;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.TableName;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.client.Get;</span>
<span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.client.RegionStatesCount;</span>
<span class="source-line-no">039</span><span id="line-39">import org.apache.hadoop.hbase.ipc.RpcCall;</span>
<span class="source-line-no">040</span><span id="line-40">import org.apache.hadoop.hbase.ipc.RpcServer;</span>
<span class="source-line-no">041</span><span id="line-41">import org.apache.hadoop.hbase.regionserver.HRegionServer;</span>
<span class="source-line-no">042</span><span id="line-42">import org.apache.hadoop.hbase.regionserver.RegionServerServices;</span>
<span class="source-line-no">043</span><span id="line-43">import org.apache.hadoop.hbase.util.Bytes;</span>
<span class="source-line-no">044</span><span id="line-44">import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;</span>
<span class="source-line-no">045</span><span id="line-45">import org.apache.hadoop.security.UserGroupInformation;</span>
<span class="source-line-no">046</span><span id="line-46">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">047</span><span id="line-47">import org.apache.yetus.audience.InterfaceStability;</span>
<span class="source-line-no">048</span><span id="line-48">import org.slf4j.Logger;</span>
<span class="source-line-no">049</span><span id="line-49">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">050</span><span id="line-50"></span>
<span class="source-line-no">051</span><span id="line-51">/**</span>
<span class="source-line-no">052</span><span id="line-52"> * Cache that keeps track of the quota settings for the users and tables that are interacting with</span>
<span class="source-line-no">053</span><span id="line-53"> * it. To avoid blocking the operations if the requested quota is not in cache an "empty quota" will</span>
<span class="source-line-no">054</span><span id="line-54"> * be returned and the request to fetch the quota information will be enqueued for the next refresh.</span>
<span class="source-line-no">055</span><span id="line-55"> * TODO: At the moment the Cache has a Chore that will be triggered every 5min or on cache-miss</span>
<span class="source-line-no">056</span><span id="line-56"> * events. Later the Quotas will be pushed using the notification system.</span>
<span class="source-line-no">057</span><span id="line-57"> */</span>
<span class="source-line-no">058</span><span id="line-58">@InterfaceAudience.Private</span>
<span class="source-line-no">059</span><span id="line-59">@InterfaceStability.Evolving</span>
<span class="source-line-no">060</span><span id="line-60">public class QuotaCache implements Stoppable {</span>
<span class="source-line-no">061</span><span id="line-61"> private static final Logger LOG = LoggerFactory.getLogger(QuotaCache.class);</span>
<span class="source-line-no">062</span><span id="line-62"></span>
<span class="source-line-no">063</span><span id="line-63"> public static final String REFRESH_CONF_KEY = "hbase.quota.refresh.period";</span>
<span class="source-line-no">064</span><span id="line-64"></span>
<span class="source-line-no">065</span><span id="line-65"> // defines the request attribute key which, when provided, will override the request's username</span>
<span class="source-line-no">066</span><span id="line-66"> // from the perspective of user quotas</span>
<span class="source-line-no">067</span><span id="line-67"> public static final String QUOTA_USER_REQUEST_ATTRIBUTE_OVERRIDE_KEY =</span>
<span class="source-line-no">068</span><span id="line-68"> "hbase.quota.user.override.key";</span>
<span class="source-line-no">069</span><span id="line-69"> private static final int REFRESH_DEFAULT_PERIOD = 5 * 60000; // 5min</span>
<span class="source-line-no">070</span><span id="line-70"> private static final int EVICT_PERIOD_FACTOR = 5; // N * REFRESH_DEFAULT_PERIOD</span>
<span class="source-line-no">071</span><span id="line-71"></span>
<span class="source-line-no">072</span><span id="line-72"> // for testing purpose only, enforce the cache to be always refreshed</span>
<span class="source-line-no">073</span><span id="line-73"> static boolean TEST_FORCE_REFRESH = false;</span>
<span class="source-line-no">074</span><span id="line-74"> // for testing purpose only, block cache refreshes to reliably verify state</span>
<span class="source-line-no">075</span><span id="line-75"> static boolean TEST_BLOCK_REFRESH = false;</span>
<span class="source-line-no">076</span><span id="line-76"></span>
<span class="source-line-no">077</span><span id="line-77"> private final ConcurrentMap&lt;String, QuotaState&gt; namespaceQuotaCache = new ConcurrentHashMap&lt;&gt;();</span>
<span class="source-line-no">078</span><span id="line-78"> private final ConcurrentMap&lt;TableName, QuotaState&gt; tableQuotaCache = new ConcurrentHashMap&lt;&gt;();</span>
<span class="source-line-no">079</span><span id="line-79"> private final ConcurrentMap&lt;String, UserQuotaState&gt; userQuotaCache = new ConcurrentHashMap&lt;&gt;();</span>
<span class="source-line-no">080</span><span id="line-80"> private final ConcurrentMap&lt;String, QuotaState&gt; regionServerQuotaCache =</span>
<span class="source-line-no">081</span><span id="line-81"> new ConcurrentHashMap&lt;&gt;();</span>
<span class="source-line-no">082</span><span id="line-82"> private volatile boolean exceedThrottleQuotaEnabled = false;</span>
<span class="source-line-no">083</span><span id="line-83"> // factors used to divide cluster scope quota into machine scope quota</span>
<span class="source-line-no">084</span><span id="line-84"> private volatile double machineQuotaFactor = 1;</span>
<span class="source-line-no">085</span><span id="line-85"> private final ConcurrentHashMap&lt;TableName, Double&gt; tableMachineQuotaFactors =</span>
<span class="source-line-no">086</span><span id="line-86"> new ConcurrentHashMap&lt;&gt;();</span>
<span class="source-line-no">087</span><span id="line-87"> private final RegionServerServices rsServices;</span>
<span class="source-line-no">088</span><span id="line-88"> private final String userOverrideRequestAttributeKey;</span>
<span class="source-line-no">089</span><span id="line-89"></span>
<span class="source-line-no">090</span><span id="line-90"> private QuotaRefresherChore refreshChore;</span>
<span class="source-line-no">091</span><span id="line-91"> private boolean stopped = true;</span>
<span class="source-line-no">092</span><span id="line-92"></span>
<span class="source-line-no">093</span><span id="line-93"> public QuotaCache(final RegionServerServices rsServices) {</span>
<span class="source-line-no">094</span><span id="line-94"> this.rsServices = rsServices;</span>
<span class="source-line-no">095</span><span id="line-95"> this.userOverrideRequestAttributeKey =</span>
<span class="source-line-no">096</span><span id="line-96"> rsServices.getConfiguration().get(QUOTA_USER_REQUEST_ATTRIBUTE_OVERRIDE_KEY);</span>
<span class="source-line-no">097</span><span id="line-97"> }</span>
<span class="source-line-no">098</span><span id="line-98"></span>
<span class="source-line-no">099</span><span id="line-99"> public void start() throws IOException {</span>
<span class="source-line-no">100</span><span id="line-100"> stopped = false;</span>
<span class="source-line-no">101</span><span id="line-101"></span>
<span class="source-line-no">102</span><span id="line-102"> // TODO: This will be replaced once we have the notification bus ready.</span>
<span class="source-line-no">103</span><span id="line-103"> Configuration conf = rsServices.getConfiguration();</span>
<span class="source-line-no">104</span><span id="line-104"> int period = conf.getInt(REFRESH_CONF_KEY, REFRESH_DEFAULT_PERIOD);</span>
<span class="source-line-no">105</span><span id="line-105"> refreshChore = new QuotaRefresherChore(period, this);</span>
<span class="source-line-no">106</span><span id="line-106"> rsServices.getChoreService().scheduleChore(refreshChore);</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"> @Override</span>
<span class="source-line-no">110</span><span id="line-110"> public void stop(final String why) {</span>
<span class="source-line-no">111</span><span id="line-111"> if (refreshChore != null) {</span>
<span class="source-line-no">112</span><span id="line-112"> LOG.debug("Stopping QuotaRefresherChore chore.");</span>
<span class="source-line-no">113</span><span id="line-113"> refreshChore.shutdown(true);</span>
<span class="source-line-no">114</span><span id="line-114"> }</span>
<span class="source-line-no">115</span><span id="line-115"> stopped = true;</span>
<span class="source-line-no">116</span><span id="line-116"> }</span>
<span class="source-line-no">117</span><span id="line-117"></span>
<span class="source-line-no">118</span><span id="line-118"> @Override</span>
<span class="source-line-no">119</span><span id="line-119"> public boolean isStopped() {</span>
<span class="source-line-no">120</span><span id="line-120"> return stopped;</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"> /**</span>
<span class="source-line-no">124</span><span id="line-124"> * Returns the limiter associated to the specified user/table.</span>
<span class="source-line-no">125</span><span id="line-125"> * @param ugi the user to limit</span>
<span class="source-line-no">126</span><span id="line-126"> * @param table the table to limit</span>
<span class="source-line-no">127</span><span id="line-127"> * @return the limiter associated to the specified user/table</span>
<span class="source-line-no">128</span><span id="line-128"> */</span>
<span class="source-line-no">129</span><span id="line-129"> public QuotaLimiter getUserLimiter(final UserGroupInformation ugi, final TableName table) {</span>
<span class="source-line-no">130</span><span id="line-130"> if (table.isSystemTable()) {</span>
<span class="source-line-no">131</span><span id="line-131"> return NoopQuotaLimiter.get();</span>
<span class="source-line-no">132</span><span id="line-132"> }</span>
<span class="source-line-no">133</span><span id="line-133"> return getUserQuotaState(ugi).getTableLimiter(table);</span>
<span class="source-line-no">134</span><span id="line-134"> }</span>
<span class="source-line-no">135</span><span id="line-135"></span>
<span class="source-line-no">136</span><span id="line-136"> /**</span>
<span class="source-line-no">137</span><span id="line-137"> * Returns the QuotaState associated to the specified user.</span>
<span class="source-line-no">138</span><span id="line-138"> * @param ugi the user</span>
<span class="source-line-no">139</span><span id="line-139"> * @return the quota info associated to specified user</span>
<span class="source-line-no">140</span><span id="line-140"> */</span>
<span class="source-line-no">141</span><span id="line-141"> public UserQuotaState getUserQuotaState(final UserGroupInformation ugi) {</span>
<span class="source-line-no">142</span><span id="line-142"> return computeIfAbsent(userQuotaCache, getQuotaUserName(ugi),</span>
<span class="source-line-no">143</span><span id="line-143"> () -&gt; QuotaUtil.buildDefaultUserQuotaState(rsServices.getConfiguration(), 0L),</span>
<span class="source-line-no">144</span><span id="line-144"> this::triggerCacheRefresh);</span>
<span class="source-line-no">145</span><span id="line-145"> }</span>
<span class="source-line-no">146</span><span id="line-146"></span>
<span class="source-line-no">147</span><span id="line-147"> /**</span>
<span class="source-line-no">148</span><span id="line-148"> * Returns the limiter associated to the specified table.</span>
<span class="source-line-no">149</span><span id="line-149"> * @param table the table to limit</span>
<span class="source-line-no">150</span><span id="line-150"> * @return the limiter associated to the specified table</span>
<span class="source-line-no">151</span><span id="line-151"> */</span>
<span class="source-line-no">152</span><span id="line-152"> public QuotaLimiter getTableLimiter(final TableName table) {</span>
<span class="source-line-no">153</span><span id="line-153"> return getQuotaState(this.tableQuotaCache, table).getGlobalLimiter();</span>
<span class="source-line-no">154</span><span id="line-154"> }</span>
<span class="source-line-no">155</span><span id="line-155"></span>
<span class="source-line-no">156</span><span id="line-156"> /**</span>
<span class="source-line-no">157</span><span id="line-157"> * Returns the limiter associated to the specified namespace.</span>
<span class="source-line-no">158</span><span id="line-158"> * @param namespace the namespace to limit</span>
<span class="source-line-no">159</span><span id="line-159"> * @return the limiter associated to the specified namespace</span>
<span class="source-line-no">160</span><span id="line-160"> */</span>
<span class="source-line-no">161</span><span id="line-161"> public QuotaLimiter getNamespaceLimiter(final String namespace) {</span>
<span class="source-line-no">162</span><span id="line-162"> return getQuotaState(this.namespaceQuotaCache, namespace).getGlobalLimiter();</span>
<span class="source-line-no">163</span><span id="line-163"> }</span>
<span class="source-line-no">164</span><span id="line-164"></span>
<span class="source-line-no">165</span><span id="line-165"> /**</span>
<span class="source-line-no">166</span><span id="line-166"> * Returns the limiter associated to the specified region server.</span>
<span class="source-line-no">167</span><span id="line-167"> * @param regionServer the region server to limit</span>
<span class="source-line-no">168</span><span id="line-168"> * @return the limiter associated to the specified region server</span>
<span class="source-line-no">169</span><span id="line-169"> */</span>
<span class="source-line-no">170</span><span id="line-170"> public QuotaLimiter getRegionServerQuotaLimiter(final String regionServer) {</span>
<span class="source-line-no">171</span><span id="line-171"> return getQuotaState(this.regionServerQuotaCache, regionServer).getGlobalLimiter();</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>
<span class="source-line-no">174</span><span id="line-174"> protected boolean isExceedThrottleQuotaEnabled() {</span>
<span class="source-line-no">175</span><span id="line-175"> return exceedThrottleQuotaEnabled;</span>
<span class="source-line-no">176</span><span id="line-176"> }</span>
<span class="source-line-no">177</span><span id="line-177"></span>
<span class="source-line-no">178</span><span id="line-178"> /**</span>
<span class="source-line-no">179</span><span id="line-179"> * Applies a request attribute user override if available, otherwise returns the UGI's short</span>
<span class="source-line-no">180</span><span id="line-180"> * username</span>
<span class="source-line-no">181</span><span id="line-181"> * @param ugi The request's UserGroupInformation</span>
<span class="source-line-no">182</span><span id="line-182"> */</span>
<span class="source-line-no">183</span><span id="line-183"> private String getQuotaUserName(final UserGroupInformation ugi) {</span>
<span class="source-line-no">184</span><span id="line-184"> if (userOverrideRequestAttributeKey == null) {</span>
<span class="source-line-no">185</span><span id="line-185"> return ugi.getShortUserName();</span>
<span class="source-line-no">186</span><span id="line-186"> }</span>
<span class="source-line-no">187</span><span id="line-187"></span>
<span class="source-line-no">188</span><span id="line-188"> Optional&lt;RpcCall&gt; rpcCall = RpcServer.getCurrentCall();</span>
<span class="source-line-no">189</span><span id="line-189"> if (!rpcCall.isPresent()) {</span>
<span class="source-line-no">190</span><span id="line-190"> return ugi.getShortUserName();</span>
<span class="source-line-no">191</span><span id="line-191"> }</span>
<span class="source-line-no">192</span><span id="line-192"></span>
<span class="source-line-no">193</span><span id="line-193"> byte[] override = rpcCall.get().getRequestAttribute(userOverrideRequestAttributeKey);</span>
<span class="source-line-no">194</span><span id="line-194"> if (override == null) {</span>
<span class="source-line-no">195</span><span id="line-195"> return ugi.getShortUserName();</span>
<span class="source-line-no">196</span><span id="line-196"> }</span>
<span class="source-line-no">197</span><span id="line-197"> return Bytes.toString(override);</span>
<span class="source-line-no">198</span><span id="line-198"> }</span>
<span class="source-line-no">199</span><span id="line-199"></span>
<span class="source-line-no">200</span><span id="line-200"> /**</span>
<span class="source-line-no">201</span><span id="line-201"> * Returns the QuotaState requested. If the quota info is not in cache an empty one will be</span>
<span class="source-line-no">202</span><span id="line-202"> * returned and the quota request will be enqueued for the next cache refresh.</span>
<span class="source-line-no">203</span><span id="line-203"> */</span>
<span class="source-line-no">204</span><span id="line-204"> private &lt;K&gt; QuotaState getQuotaState(final ConcurrentMap&lt;K, QuotaState&gt; quotasMap, final K key) {</span>
<span class="source-line-no">205</span><span id="line-205"> return computeIfAbsent(quotasMap, key, QuotaState::new, this::triggerCacheRefresh);</span>
<span class="source-line-no">206</span><span id="line-206"> }</span>
<span class="source-line-no">207</span><span id="line-207"></span>
<span class="source-line-no">208</span><span id="line-208"> void triggerCacheRefresh() {</span>
<span class="source-line-no">209</span><span id="line-209"> refreshChore.triggerNow();</span>
<span class="source-line-no">210</span><span id="line-210"> }</span>
<span class="source-line-no">211</span><span id="line-211"></span>
<span class="source-line-no">212</span><span id="line-212"> long getLastUpdate() {</span>
<span class="source-line-no">213</span><span id="line-213"> return refreshChore.lastUpdate;</span>
<span class="source-line-no">214</span><span id="line-214"> }</span>
<span class="source-line-no">215</span><span id="line-215"></span>
<span class="source-line-no">216</span><span id="line-216"> Map&lt;String, QuotaState&gt; getNamespaceQuotaCache() {</span>
<span class="source-line-no">217</span><span id="line-217"> return namespaceQuotaCache;</span>
<span class="source-line-no">218</span><span id="line-218"> }</span>
<span class="source-line-no">219</span><span id="line-219"></span>
<span class="source-line-no">220</span><span id="line-220"> Map&lt;String, QuotaState&gt; getRegionServerQuotaCache() {</span>
<span class="source-line-no">221</span><span id="line-221"> return regionServerQuotaCache;</span>
<span class="source-line-no">222</span><span id="line-222"> }</span>
<span class="source-line-no">223</span><span id="line-223"></span>
<span class="source-line-no">224</span><span id="line-224"> Map&lt;TableName, QuotaState&gt; getTableQuotaCache() {</span>
<span class="source-line-no">225</span><span id="line-225"> return tableQuotaCache;</span>
<span class="source-line-no">226</span><span id="line-226"> }</span>
<span class="source-line-no">227</span><span id="line-227"></span>
<span class="source-line-no">228</span><span id="line-228"> Map&lt;String, UserQuotaState&gt; getUserQuotaCache() {</span>
<span class="source-line-no">229</span><span id="line-229"> return userQuotaCache;</span>
<span class="source-line-no">230</span><span id="line-230"> }</span>
<span class="source-line-no">231</span><span id="line-231"></span>
<span class="source-line-no">232</span><span id="line-232"> // TODO: Remove this once we have the notification bus</span>
<span class="source-line-no">233</span><span id="line-233"> private class QuotaRefresherChore extends ScheduledChore {</span>
<span class="source-line-no">234</span><span id="line-234"> private long lastUpdate = 0;</span>
<span class="source-line-no">235</span><span id="line-235"></span>
<span class="source-line-no">236</span><span id="line-236"> public QuotaRefresherChore(final int period, final Stoppable stoppable) {</span>
<span class="source-line-no">237</span><span id="line-237"> super("QuotaRefresherChore", stoppable, period);</span>
<span class="source-line-no">238</span><span id="line-238"> }</span>
<span class="source-line-no">239</span><span id="line-239"></span>
<span class="source-line-no">240</span><span id="line-240"> @Override</span>
<span class="source-line-no">241</span><span id="line-241"> @edu.umd.cs.findbugs.annotations.SuppressWarnings(value = "GC_UNRELATED_TYPES",</span>
<span class="source-line-no">242</span><span id="line-242"> justification = "I do not understand why the complaints, it looks good to me -- FIX")</span>
<span class="source-line-no">243</span><span id="line-243"> protected void chore() {</span>
<span class="source-line-no">244</span><span id="line-244"> while (TEST_BLOCK_REFRESH) {</span>
<span class="source-line-no">245</span><span id="line-245"> LOG.info("TEST_BLOCK_REFRESH=true, so blocking QuotaCache refresh until it is false");</span>
<span class="source-line-no">246</span><span id="line-246"> try {</span>
<span class="source-line-no">247</span><span id="line-247"> Thread.sleep(10);</span>
<span class="source-line-no">248</span><span id="line-248"> } catch (InterruptedException e) {</span>
<span class="source-line-no">249</span><span id="line-249"> throw new RuntimeException(e);</span>
<span class="source-line-no">250</span><span id="line-250"> }</span>
<span class="source-line-no">251</span><span id="line-251"> }</span>
<span class="source-line-no">252</span><span id="line-252"> // Prefetch online tables/namespaces</span>
<span class="source-line-no">253</span><span id="line-253"> for (TableName table : ((HRegionServer) QuotaCache.this.rsServices).getOnlineTables()) {</span>
<span class="source-line-no">254</span><span id="line-254"> if (table.isSystemTable()) {</span>
<span class="source-line-no">255</span><span id="line-255"> continue;</span>
<span class="source-line-no">256</span><span id="line-256"> }</span>
<span class="source-line-no">257</span><span id="line-257"> QuotaCache.this.tableQuotaCache.computeIfAbsent(table, key -&gt; new QuotaState());</span>
<span class="source-line-no">258</span><span id="line-258"></span>
<span class="source-line-no">259</span><span id="line-259"> final String ns = table.getNamespaceAsString();</span>
<span class="source-line-no">260</span><span id="line-260"></span>
<span class="source-line-no">261</span><span id="line-261"> QuotaCache.this.namespaceQuotaCache.computeIfAbsent(ns, key -&gt; new QuotaState());</span>
<span class="source-line-no">262</span><span id="line-262"> }</span>
<span class="source-line-no">263</span><span id="line-263"></span>
<span class="source-line-no">264</span><span id="line-264"> QuotaCache.this.regionServerQuotaCache</span>
<span class="source-line-no">265</span><span id="line-265"> .computeIfAbsent(QuotaTableUtil.QUOTA_REGION_SERVER_ROW_KEY, key -&gt; new QuotaState());</span>
<span class="source-line-no">266</span><span id="line-266"></span>
<span class="source-line-no">267</span><span id="line-267"> updateQuotaFactors();</span>
<span class="source-line-no">268</span><span id="line-268"> fetchNamespaceQuotaState();</span>
<span class="source-line-no">269</span><span id="line-269"> fetchTableQuotaState();</span>
<span class="source-line-no">270</span><span id="line-270"> fetchUserQuotaState();</span>
<span class="source-line-no">271</span><span id="line-271"> fetchRegionServerQuotaState();</span>
<span class="source-line-no">272</span><span id="line-272"> fetchExceedThrottleQuota();</span>
<span class="source-line-no">273</span><span id="line-273"> lastUpdate = EnvironmentEdgeManager.currentTime();</span>
<span class="source-line-no">274</span><span id="line-274"> }</span>
<span class="source-line-no">275</span><span id="line-275"></span>
<span class="source-line-no">276</span><span id="line-276"> private void fetchNamespaceQuotaState() {</span>
<span class="source-line-no">277</span><span id="line-277"> fetch("namespace", QuotaCache.this.namespaceQuotaCache, new Fetcher&lt;String, QuotaState&gt;() {</span>
<span class="source-line-no">278</span><span id="line-278"> @Override</span>
<span class="source-line-no">279</span><span id="line-279"> public Get makeGet(final Map.Entry&lt;String, QuotaState&gt; entry) {</span>
<span class="source-line-no">280</span><span id="line-280"> return QuotaUtil.makeGetForNamespaceQuotas(entry.getKey());</span>
<span class="source-line-no">281</span><span id="line-281"> }</span>
<span class="source-line-no">282</span><span id="line-282"></span>
<span class="source-line-no">283</span><span id="line-283"> @Override</span>
<span class="source-line-no">284</span><span id="line-284"> public Map&lt;String, QuotaState&gt; fetchEntries(final List&lt;Get&gt; gets) throws IOException {</span>
<span class="source-line-no">285</span><span id="line-285"> return QuotaUtil.fetchNamespaceQuotas(rsServices.getConnection(), gets,</span>
<span class="source-line-no">286</span><span id="line-286"> machineQuotaFactor);</span>
<span class="source-line-no">287</span><span id="line-287"> }</span>
<span class="source-line-no">288</span><span id="line-288"> });</span>
<span class="source-line-no">289</span><span id="line-289"> }</span>
<span class="source-line-no">290</span><span id="line-290"></span>
<span class="source-line-no">291</span><span id="line-291"> private void fetchTableQuotaState() {</span>
<span class="source-line-no">292</span><span id="line-292"> fetch("table", QuotaCache.this.tableQuotaCache, new Fetcher&lt;TableName, QuotaState&gt;() {</span>
<span class="source-line-no">293</span><span id="line-293"> @Override</span>
<span class="source-line-no">294</span><span id="line-294"> public Get makeGet(final Map.Entry&lt;TableName, QuotaState&gt; entry) {</span>
<span class="source-line-no">295</span><span id="line-295"> return QuotaUtil.makeGetForTableQuotas(entry.getKey());</span>
<span class="source-line-no">296</span><span id="line-296"> }</span>
<span class="source-line-no">297</span><span id="line-297"></span>
<span class="source-line-no">298</span><span id="line-298"> @Override</span>
<span class="source-line-no">299</span><span id="line-299"> public Map&lt;TableName, QuotaState&gt; fetchEntries(final List&lt;Get&gt; gets) throws IOException {</span>
<span class="source-line-no">300</span><span id="line-300"> return QuotaUtil.fetchTableQuotas(rsServices.getConnection(), gets,</span>
<span class="source-line-no">301</span><span id="line-301"> tableMachineQuotaFactors);</span>
<span class="source-line-no">302</span><span id="line-302"> }</span>
<span class="source-line-no">303</span><span id="line-303"> });</span>
<span class="source-line-no">304</span><span id="line-304"> }</span>
<span class="source-line-no">305</span><span id="line-305"></span>
<span class="source-line-no">306</span><span id="line-306"> private void fetchUserQuotaState() {</span>
<span class="source-line-no">307</span><span id="line-307"> final Set&lt;String&gt; namespaces = QuotaCache.this.namespaceQuotaCache.keySet();</span>
<span class="source-line-no">308</span><span id="line-308"> final Set&lt;TableName&gt; tables = QuotaCache.this.tableQuotaCache.keySet();</span>
<span class="source-line-no">309</span><span id="line-309"> fetch("user", QuotaCache.this.userQuotaCache, new Fetcher&lt;String, UserQuotaState&gt;() {</span>
<span class="source-line-no">310</span><span id="line-310"> @Override</span>
<span class="source-line-no">311</span><span id="line-311"> public Get makeGet(final Map.Entry&lt;String, UserQuotaState&gt; entry) {</span>
<span class="source-line-no">312</span><span id="line-312"> return QuotaUtil.makeGetForUserQuotas(entry.getKey(), tables, namespaces);</span>
<span class="source-line-no">313</span><span id="line-313"> }</span>
<span class="source-line-no">314</span><span id="line-314"></span>
<span class="source-line-no">315</span><span id="line-315"> @Override</span>
<span class="source-line-no">316</span><span id="line-316"> public Map&lt;String, UserQuotaState&gt; fetchEntries(final List&lt;Get&gt; gets) throws IOException {</span>
<span class="source-line-no">317</span><span id="line-317"> return QuotaUtil.fetchUserQuotas(rsServices.getConnection(), gets,</span>
<span class="source-line-no">318</span><span id="line-318"> tableMachineQuotaFactors, machineQuotaFactor);</span>
<span class="source-line-no">319</span><span id="line-319"> }</span>
<span class="source-line-no">320</span><span id="line-320"> });</span>
<span class="source-line-no">321</span><span id="line-321"> }</span>
<span class="source-line-no">322</span><span id="line-322"></span>
<span class="source-line-no">323</span><span id="line-323"> private void fetchRegionServerQuotaState() {</span>
<span class="source-line-no">324</span><span id="line-324"> fetch("regionServer", QuotaCache.this.regionServerQuotaCache,</span>
<span class="source-line-no">325</span><span id="line-325"> new Fetcher&lt;String, QuotaState&gt;() {</span>
<span class="source-line-no">326</span><span id="line-326"> @Override</span>
<span class="source-line-no">327</span><span id="line-327"> public Get makeGet(final Map.Entry&lt;String, QuotaState&gt; entry) {</span>
<span class="source-line-no">328</span><span id="line-328"> return QuotaUtil.makeGetForRegionServerQuotas(entry.getKey());</span>
<span class="source-line-no">329</span><span id="line-329"> }</span>
<span class="source-line-no">330</span><span id="line-330"></span>
<span class="source-line-no">331</span><span id="line-331"> @Override</span>
<span class="source-line-no">332</span><span id="line-332"> public Map&lt;String, QuotaState&gt; fetchEntries(final List&lt;Get&gt; gets) throws IOException {</span>
<span class="source-line-no">333</span><span id="line-333"> return QuotaUtil.fetchRegionServerQuotas(rsServices.getConnection(), gets);</span>
<span class="source-line-no">334</span><span id="line-334"> }</span>
<span class="source-line-no">335</span><span id="line-335"> });</span>
<span class="source-line-no">336</span><span id="line-336"> }</span>
<span class="source-line-no">337</span><span id="line-337"></span>
<span class="source-line-no">338</span><span id="line-338"> private void fetchExceedThrottleQuota() {</span>
<span class="source-line-no">339</span><span id="line-339"> try {</span>
<span class="source-line-no">340</span><span id="line-340"> QuotaCache.this.exceedThrottleQuotaEnabled =</span>
<span class="source-line-no">341</span><span id="line-341"> QuotaUtil.isExceedThrottleQuotaEnabled(rsServices.getConnection());</span>
<span class="source-line-no">342</span><span id="line-342"> } catch (IOException e) {</span>
<span class="source-line-no">343</span><span id="line-343"> LOG.warn("Unable to read if exceed throttle quota enabled from quota table", e);</span>
<span class="source-line-no">344</span><span id="line-344"> }</span>
<span class="source-line-no">345</span><span id="line-345"> }</span>
<span class="source-line-no">346</span><span id="line-346"></span>
<span class="source-line-no">347</span><span id="line-347"> private &lt;K, V extends QuotaState&gt; void fetch(final String type,</span>
<span class="source-line-no">348</span><span id="line-348"> final ConcurrentMap&lt;K, V&gt; quotasMap, final Fetcher&lt;K, V&gt; fetcher) {</span>
<span class="source-line-no">349</span><span id="line-349"> long now = EnvironmentEdgeManager.currentTime();</span>
<span class="source-line-no">350</span><span id="line-350"> long refreshPeriod = getPeriod();</span>
<span class="source-line-no">351</span><span id="line-351"> long evictPeriod = refreshPeriod * EVICT_PERIOD_FACTOR;</span>
<span class="source-line-no">352</span><span id="line-352"></span>
<span class="source-line-no">353</span><span id="line-353"> // Find the quota entries to update</span>
<span class="source-line-no">354</span><span id="line-354"> List&lt;Get&gt; gets = new ArrayList&lt;&gt;();</span>
<span class="source-line-no">355</span><span id="line-355"> List&lt;K&gt; toRemove = new ArrayList&lt;&gt;();</span>
<span class="source-line-no">356</span><span id="line-356"> for (Map.Entry&lt;K, V&gt; entry : quotasMap.entrySet()) {</span>
<span class="source-line-no">357</span><span id="line-357"> long lastUpdate = entry.getValue().getLastUpdate();</span>
<span class="source-line-no">358</span><span id="line-358"> long lastQuery = entry.getValue().getLastQuery();</span>
<span class="source-line-no">359</span><span id="line-359"> if (lastQuery &gt; 0 &amp;&amp; (now - lastQuery) &gt;= evictPeriod) {</span>
<span class="source-line-no">360</span><span id="line-360"> toRemove.add(entry.getKey());</span>
<span class="source-line-no">361</span><span id="line-361"> } else if (TEST_FORCE_REFRESH || (now - lastUpdate) &gt;= refreshPeriod) {</span>
<span class="source-line-no">362</span><span id="line-362"> gets.add(fetcher.makeGet(entry));</span>
<span class="source-line-no">363</span><span id="line-363"> }</span>
<span class="source-line-no">364</span><span id="line-364"> }</span>
<span class="source-line-no">365</span><span id="line-365"></span>
<span class="source-line-no">366</span><span id="line-366"> for (final K key : toRemove) {</span>
<span class="source-line-no">367</span><span id="line-367"> if (LOG.isTraceEnabled()) {</span>
<span class="source-line-no">368</span><span id="line-368"> LOG.trace("evict " + type + " key=" + key);</span>
<span class="source-line-no">369</span><span id="line-369"> }</span>
<span class="source-line-no">370</span><span id="line-370"> quotasMap.remove(key);</span>
<span class="source-line-no">371</span><span id="line-371"> }</span>
<span class="source-line-no">372</span><span id="line-372"></span>
<span class="source-line-no">373</span><span id="line-373"> // fetch and update the quota entries</span>
<span class="source-line-no">374</span><span id="line-374"> if (!gets.isEmpty()) {</span>
<span class="source-line-no">375</span><span id="line-375"> try {</span>
<span class="source-line-no">376</span><span id="line-376"> for (Map.Entry&lt;K, V&gt; entry : fetcher.fetchEntries(gets).entrySet()) {</span>
<span class="source-line-no">377</span><span id="line-377"> V quotaInfo = quotasMap.putIfAbsent(entry.getKey(), entry.getValue());</span>
<span class="source-line-no">378</span><span id="line-378"> if (quotaInfo != null) {</span>
<span class="source-line-no">379</span><span id="line-379"> quotaInfo.update(entry.getValue());</span>
<span class="source-line-no">380</span><span id="line-380"> }</span>
<span class="source-line-no">381</span><span id="line-381"></span>
<span class="source-line-no">382</span><span id="line-382"> if (LOG.isTraceEnabled()) {</span>
<span class="source-line-no">383</span><span id="line-383"> LOG.trace("refresh " + type + " key=" + entry.getKey() + " quotas=" + quotaInfo);</span>
<span class="source-line-no">384</span><span id="line-384"> }</span>
<span class="source-line-no">385</span><span id="line-385"> }</span>
<span class="source-line-no">386</span><span id="line-386"> } catch (IOException e) {</span>
<span class="source-line-no">387</span><span id="line-387"> LOG.warn("Unable to read " + type + " from quota table", e);</span>
<span class="source-line-no">388</span><span id="line-388"> }</span>
<span class="source-line-no">389</span><span id="line-389"> }</span>
<span class="source-line-no">390</span><span id="line-390"> }</span>
<span class="source-line-no">391</span><span id="line-391"></span>
<span class="source-line-no">392</span><span id="line-392"> /**</span>
<span class="source-line-no">393</span><span id="line-393"> * Update quota factors which is used to divide cluster scope quota into machine scope quota For</span>
<span class="source-line-no">394</span><span id="line-394"> * user/namespace/user over namespace quota, use [1 / RSNum] as machine factor. For table/user</span>
<span class="source-line-no">395</span><span id="line-395"> * over table quota, use [1 / TotalTableRegionNum * MachineTableRegionNum] as machine factor.</span>
<span class="source-line-no">396</span><span id="line-396"> */</span>
<span class="source-line-no">397</span><span id="line-397"> private void updateQuotaFactors() {</span>
<span class="source-line-no">398</span><span id="line-398"> // Update machine quota factor</span>
<span class="source-line-no">399</span><span id="line-399"> ClusterMetrics clusterMetrics;</span>
<span class="source-line-no">400</span><span id="line-400"> try {</span>
<span class="source-line-no">401</span><span id="line-401"> clusterMetrics = rsServices.getConnection().getAdmin()</span>
<span class="source-line-no">402</span><span id="line-402"> .getClusterMetrics(EnumSet.of(Option.SERVERS_NAME, Option.TABLE_TO_REGIONS_COUNT));</span>
<span class="source-line-no">403</span><span id="line-403"> } catch (IOException e) {</span>
<span class="source-line-no">404</span><span id="line-404"> LOG.warn("Failed to get cluster metrics needed for updating quotas", e);</span>
<span class="source-line-no">405</span><span id="line-405"> return;</span>
<span class="source-line-no">406</span><span id="line-406"> }</span>
<span class="source-line-no">407</span><span id="line-407"></span>
<span class="source-line-no">408</span><span id="line-408"> int rsSize = clusterMetrics.getServersName().size();</span>
<span class="source-line-no">409</span><span id="line-409"> if (rsSize != 0) {</span>
<span class="source-line-no">410</span><span id="line-410"> // TODO if use rs group, the cluster limit should be shared by the rs group</span>
<span class="source-line-no">411</span><span id="line-411"> machineQuotaFactor = 1.0 / rsSize;</span>
<span class="source-line-no">412</span><span id="line-412"> }</span>
<span class="source-line-no">413</span><span id="line-413"></span>
<span class="source-line-no">414</span><span id="line-414"> Map&lt;TableName, RegionStatesCount&gt; tableRegionStatesCount =</span>
<span class="source-line-no">415</span><span id="line-415"> clusterMetrics.getTableRegionStatesCount();</span>
<span class="source-line-no">416</span><span id="line-416"></span>
<span class="source-line-no">417</span><span id="line-417"> // Update table machine quota factors</span>
<span class="source-line-no">418</span><span id="line-418"> for (TableName tableName : tableQuotaCache.keySet()) {</span>
<span class="source-line-no">419</span><span id="line-419"> if (tableRegionStatesCount.containsKey(tableName)) {</span>
<span class="source-line-no">420</span><span id="line-420"> double factor = 1;</span>
<span class="source-line-no">421</span><span id="line-421"> try {</span>
<span class="source-line-no">422</span><span id="line-422"> long regionSize = tableRegionStatesCount.get(tableName).getOpenRegions();</span>
<span class="source-line-no">423</span><span id="line-423"> if (regionSize == 0) {</span>
<span class="source-line-no">424</span><span id="line-424"> factor = 0;</span>
<span class="source-line-no">425</span><span id="line-425"> } else {</span>
<span class="source-line-no">426</span><span id="line-426"> int localRegionSize = rsServices.getRegions(tableName).size();</span>
<span class="source-line-no">427</span><span id="line-427"> factor = 1.0 * localRegionSize / regionSize;</span>
<span class="source-line-no">428</span><span id="line-428"> }</span>
<span class="source-line-no">429</span><span id="line-429"> } catch (IOException e) {</span>
<span class="source-line-no">430</span><span id="line-430"> LOG.warn("Get table regions failed: {}", tableName, e);</span>
<span class="source-line-no">431</span><span id="line-431"> }</span>
<span class="source-line-no">432</span><span id="line-432"> tableMachineQuotaFactors.put(tableName, factor);</span>
<span class="source-line-no">433</span><span id="line-433"> } else {</span>
<span class="source-line-no">434</span><span id="line-434"> // TableName might have already been dropped (outdated)</span>
<span class="source-line-no">435</span><span id="line-435"> tableMachineQuotaFactors.remove(tableName);</span>
<span class="source-line-no">436</span><span id="line-436"> }</span>
<span class="source-line-no">437</span><span id="line-437"> }</span>
<span class="source-line-no">438</span><span id="line-438"> }</span>
<span class="source-line-no">439</span><span id="line-439"> }</span>
<span class="source-line-no">440</span><span id="line-440"></span>
<span class="source-line-no">441</span><span id="line-441"> static interface Fetcher&lt;Key, Value&gt; {</span>
<span class="source-line-no">442</span><span id="line-442"> Get makeGet(Map.Entry&lt;Key, Value&gt; entry);</span>
<span class="source-line-no">443</span><span id="line-443"></span>
<span class="source-line-no">444</span><span id="line-444"> Map&lt;Key, Value&gt; fetchEntries(List&lt;Get&gt; gets) throws IOException;</span>
<span class="source-line-no">445</span><span id="line-445"> }</span>
<span class="source-line-no">446</span><span id="line-446">}</span>
</pre>
</div>
</main>
</body>
</html>