blob: 220e4227be57b2b80b9702eede2881bdc8d8bdfc [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: RefreshableExpiringValueCache">
<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 java.io.IOException;</span>
<span class="source-line-no">021</span><span id="line-21">import java.time.Duration;</span>
<span class="source-line-no">022</span><span id="line-22">import java.util.EnumSet;</span>
<span class="source-line-no">023</span><span id="line-23">import java.util.HashMap;</span>
<span class="source-line-no">024</span><span id="line-24">import java.util.Map;</span>
<span class="source-line-no">025</span><span id="line-25">import java.util.Optional;</span>
<span class="source-line-no">026</span><span id="line-26">import java.util.concurrent.ConcurrentHashMap;</span>
<span class="source-line-no">027</span><span id="line-27">import java.util.concurrent.TimeUnit;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.ClusterMetrics;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.ClusterMetrics.Option;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.ScheduledChore;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.Stoppable;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.TableName;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.client.RegionStatesCount;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.ipc.RpcCall;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.ipc.RpcServer;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.regionserver.RegionServerServices;</span>
<span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.util.Bytes;</span>
<span class="source-line-no">039</span><span id="line-39">import org.apache.hadoop.security.UserGroupInformation;</span>
<span class="source-line-no">040</span><span id="line-40">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">041</span><span id="line-41">import org.apache.yetus.audience.InterfaceStability;</span>
<span class="source-line-no">042</span><span id="line-42">import org.slf4j.Logger;</span>
<span class="source-line-no">043</span><span id="line-43">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">044</span><span id="line-44"></span>
<span class="source-line-no">045</span><span id="line-45">import org.apache.hbase.thirdparty.com.google.common.cache.CacheBuilder;</span>
<span class="source-line-no">046</span><span id="line-46">import org.apache.hbase.thirdparty.com.google.common.cache.CacheLoader;</span>
<span class="source-line-no">047</span><span id="line-47">import org.apache.hbase.thirdparty.com.google.common.cache.LoadingCache;</span>
<span class="source-line-no">048</span><span id="line-48"></span>
<span class="source-line-no">049</span><span id="line-49">/**</span>
<span class="source-line-no">050</span><span id="line-50"> * Cache that keeps track of the quota settings for the users and tables that are interacting with</span>
<span class="source-line-no">051</span><span id="line-51"> * it.</span>
<span class="source-line-no">052</span><span id="line-52"> */</span>
<span class="source-line-no">053</span><span id="line-53">@InterfaceAudience.Private</span>
<span class="source-line-no">054</span><span id="line-54">@InterfaceStability.Evolving</span>
<span class="source-line-no">055</span><span id="line-55">public class QuotaCache implements Stoppable {</span>
<span class="source-line-no">056</span><span id="line-56"> private static final Logger LOG = LoggerFactory.getLogger(QuotaCache.class);</span>
<span class="source-line-no">057</span><span id="line-57"></span>
<span class="source-line-no">058</span><span id="line-58"> public static final String REFRESH_CONF_KEY = "hbase.quota.refresh.period";</span>
<span class="source-line-no">059</span><span id="line-59"> public static final String TABLE_REGION_STATES_CACHE_TTL_MS =</span>
<span class="source-line-no">060</span><span id="line-60"> "hbase.quota.cache.ttl.region.states.ms";</span>
<span class="source-line-no">061</span><span id="line-61"> public static final String REGION_SERVERS_SIZE_CACHE_TTL_MS =</span>
<span class="source-line-no">062</span><span id="line-62"> "hbase.quota.cache.ttl.servers.size.ms";</span>
<span class="source-line-no">063</span><span id="line-63"></span>
<span class="source-line-no">064</span><span id="line-64"> // defines the request attribute key which, when provided, will override the request's username</span>
<span class="source-line-no">065</span><span id="line-65"> // from the perspective of user quotas</span>
<span class="source-line-no">066</span><span id="line-66"> public static final String QUOTA_USER_REQUEST_ATTRIBUTE_OVERRIDE_KEY =</span>
<span class="source-line-no">067</span><span id="line-67"> "hbase.quota.user.override.key";</span>
<span class="source-line-no">068</span><span id="line-68"> private static final int REFRESH_DEFAULT_PERIOD = 43_200_000; // 12 hours</span>
<span class="source-line-no">069</span><span id="line-69"></span>
<span class="source-line-no">070</span><span id="line-70"> private final Object initializerLock = new Object();</span>
<span class="source-line-no">071</span><span id="line-71"> private volatile boolean initialized = false;</span>
<span class="source-line-no">072</span><span id="line-72"></span>
<span class="source-line-no">073</span><span id="line-73"> private volatile Map&lt;String, QuotaState&gt; namespaceQuotaCache = new HashMap&lt;&gt;();</span>
<span class="source-line-no">074</span><span id="line-74"> private volatile Map&lt;TableName, QuotaState&gt; tableQuotaCache = new HashMap&lt;&gt;();</span>
<span class="source-line-no">075</span><span id="line-75"> private volatile Map&lt;String, UserQuotaState&gt; userQuotaCache = new HashMap&lt;&gt;();</span>
<span class="source-line-no">076</span><span id="line-76"> private volatile Map&lt;String, QuotaState&gt; regionServerQuotaCache = new HashMap&lt;&gt;();</span>
<span class="source-line-no">077</span><span id="line-77"></span>
<span class="source-line-no">078</span><span id="line-78"> private volatile boolean exceedThrottleQuotaEnabled = false;</span>
<span class="source-line-no">079</span><span id="line-79"> // factors used to divide cluster scope quota into machine scope quota</span>
<span class="source-line-no">080</span><span id="line-80"> private volatile double machineQuotaFactor = 1;</span>
<span class="source-line-no">081</span><span id="line-81"> private final ConcurrentHashMap&lt;TableName, Double&gt; tableMachineQuotaFactors =</span>
<span class="source-line-no">082</span><span id="line-82"> new ConcurrentHashMap&lt;&gt;();</span>
<span class="source-line-no">083</span><span id="line-83"> private final RegionServerServices rsServices;</span>
<span class="source-line-no">084</span><span id="line-84"> private final String userOverrideRequestAttributeKey;</span>
<span class="source-line-no">085</span><span id="line-85"></span>
<span class="source-line-no">086</span><span id="line-86"> private QuotaRefresherChore refreshChore;</span>
<span class="source-line-no">087</span><span id="line-87"> private boolean stopped = true;</span>
<span class="source-line-no">088</span><span id="line-88"></span>
<span class="source-line-no">089</span><span id="line-89"> public QuotaCache(final RegionServerServices rsServices) {</span>
<span class="source-line-no">090</span><span id="line-90"> this.rsServices = rsServices;</span>
<span class="source-line-no">091</span><span id="line-91"> this.userOverrideRequestAttributeKey =</span>
<span class="source-line-no">092</span><span id="line-92"> rsServices.getConfiguration().get(QUOTA_USER_REQUEST_ATTRIBUTE_OVERRIDE_KEY);</span>
<span class="source-line-no">093</span><span id="line-93"> }</span>
<span class="source-line-no">094</span><span id="line-94"></span>
<span class="source-line-no">095</span><span id="line-95"> public void start() throws IOException {</span>
<span class="source-line-no">096</span><span id="line-96"> stopped = false;</span>
<span class="source-line-no">097</span><span id="line-97"></span>
<span class="source-line-no">098</span><span id="line-98"> Configuration conf = rsServices.getConfiguration();</span>
<span class="source-line-no">099</span><span id="line-99"> // Refresh the cache every 12 hours, and every time a quota is changed, and every time a</span>
<span class="source-line-no">100</span><span id="line-100"> // configuration reload is triggered. Periodic reloads are kept to a minimum to avoid</span>
<span class="source-line-no">101</span><span id="line-101"> // flooding the RegionServer holding the hbase:quota table with requests.</span>
<span class="source-line-no">102</span><span id="line-102"> int period = conf.getInt(REFRESH_CONF_KEY, REFRESH_DEFAULT_PERIOD);</span>
<span class="source-line-no">103</span><span id="line-103"> refreshChore = new QuotaRefresherChore(conf, period, this);</span>
<span class="source-line-no">104</span><span id="line-104"> rsServices.getChoreService().scheduleChore(refreshChore);</span>
<span class="source-line-no">105</span><span id="line-105"> }</span>
<span class="source-line-no">106</span><span id="line-106"></span>
<span class="source-line-no">107</span><span id="line-107"> @Override</span>
<span class="source-line-no">108</span><span id="line-108"> public void stop(final String why) {</span>
<span class="source-line-no">109</span><span id="line-109"> if (refreshChore != null) {</span>
<span class="source-line-no">110</span><span id="line-110"> LOG.debug("Stopping QuotaRefresherChore chore.");</span>
<span class="source-line-no">111</span><span id="line-111"> refreshChore.shutdown(true);</span>
<span class="source-line-no">112</span><span id="line-112"> }</span>
<span class="source-line-no">113</span><span id="line-113"> stopped = 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"></span>
<span class="source-line-no">116</span><span id="line-116"> @Override</span>
<span class="source-line-no">117</span><span id="line-117"> public boolean isStopped() {</span>
<span class="source-line-no">118</span><span id="line-118"> return stopped;</span>
<span class="source-line-no">119</span><span id="line-119"> }</span>
<span class="source-line-no">120</span><span id="line-120"></span>
<span class="source-line-no">121</span><span id="line-121"> private void ensureInitialized() {</span>
<span class="source-line-no">122</span><span id="line-122"> if (!initialized) {</span>
<span class="source-line-no">123</span><span id="line-123"> synchronized (initializerLock) {</span>
<span class="source-line-no">124</span><span id="line-124"> if (!initialized) {</span>
<span class="source-line-no">125</span><span id="line-125"> refreshChore.chore();</span>
<span class="source-line-no">126</span><span id="line-126"> initialized = true;</span>
<span class="source-line-no">127</span><span id="line-127"> }</span>
<span class="source-line-no">128</span><span id="line-128"> }</span>
<span class="source-line-no">129</span><span id="line-129"> }</span>
<span class="source-line-no">130</span><span id="line-130"> }</span>
<span class="source-line-no">131</span><span id="line-131"></span>
<span class="source-line-no">132</span><span id="line-132"> private Map&lt;String, UserQuotaState&gt; fetchUserQuotaStateEntries() throws IOException {</span>
<span class="source-line-no">133</span><span id="line-133"> return QuotaUtil.fetchUserQuotas(rsServices.getConnection(), tableMachineQuotaFactors,</span>
<span class="source-line-no">134</span><span id="line-134"> machineQuotaFactor);</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"> private Map&lt;String, QuotaState&gt; fetchRegionServerQuotaStateEntries() throws IOException {</span>
<span class="source-line-no">138</span><span id="line-138"> return QuotaUtil.fetchRegionServerQuotas(rsServices.getConnection());</span>
<span class="source-line-no">139</span><span id="line-139"> }</span>
<span class="source-line-no">140</span><span id="line-140"></span>
<span class="source-line-no">141</span><span id="line-141"> private Map&lt;TableName, QuotaState&gt; fetchTableQuotaStateEntries() throws IOException {</span>
<span class="source-line-no">142</span><span id="line-142"> return QuotaUtil.fetchTableQuotas(rsServices.getConnection(), tableMachineQuotaFactors);</span>
<span class="source-line-no">143</span><span id="line-143"> }</span>
<span class="source-line-no">144</span><span id="line-144"></span>
<span class="source-line-no">145</span><span id="line-145"> private Map&lt;String, QuotaState&gt; fetchNamespaceQuotaStateEntries() throws IOException {</span>
<span class="source-line-no">146</span><span id="line-146"> return QuotaUtil.fetchNamespaceQuotas(rsServices.getConnection(), machineQuotaFactor);</span>
<span class="source-line-no">147</span><span id="line-147"> }</span>
<span class="source-line-no">148</span><span id="line-148"></span>
<span class="source-line-no">149</span><span id="line-149"> /**</span>
<span class="source-line-no">150</span><span id="line-150"> * Returns the limiter associated to the specified user/table.</span>
<span class="source-line-no">151</span><span id="line-151"> * @param ugi the user to limit</span>
<span class="source-line-no">152</span><span id="line-152"> * @param table the table to limit</span>
<span class="source-line-no">153</span><span id="line-153"> * @return the limiter associated to the specified user/table</span>
<span class="source-line-no">154</span><span id="line-154"> */</span>
<span class="source-line-no">155</span><span id="line-155"> public QuotaLimiter getUserLimiter(final UserGroupInformation ugi, final TableName table) {</span>
<span class="source-line-no">156</span><span id="line-156"> if (table.isSystemTable()) {</span>
<span class="source-line-no">157</span><span id="line-157"> return NoopQuotaLimiter.get();</span>
<span class="source-line-no">158</span><span id="line-158"> }</span>
<span class="source-line-no">159</span><span id="line-159"> return getUserQuotaState(ugi).getTableLimiter(table);</span>
<span class="source-line-no">160</span><span id="line-160"> }</span>
<span class="source-line-no">161</span><span id="line-161"></span>
<span class="source-line-no">162</span><span id="line-162"> /**</span>
<span class="source-line-no">163</span><span id="line-163"> * Returns the QuotaState associated to the specified user.</span>
<span class="source-line-no">164</span><span id="line-164"> * @param ugi the user</span>
<span class="source-line-no">165</span><span id="line-165"> * @return the quota info associated to specified user</span>
<span class="source-line-no">166</span><span id="line-166"> */</span>
<span class="source-line-no">167</span><span id="line-167"> public UserQuotaState getUserQuotaState(final UserGroupInformation ugi) {</span>
<span class="source-line-no">168</span><span id="line-168"> String user = getQuotaUserName(ugi);</span>
<span class="source-line-no">169</span><span id="line-169"> ensureInitialized();</span>
<span class="source-line-no">170</span><span id="line-170"> // local reference because the chore thread may assign to userQuotaCache</span>
<span class="source-line-no">171</span><span id="line-171"> Map&lt;String, UserQuotaState&gt; cache = userQuotaCache;</span>
<span class="source-line-no">172</span><span id="line-172"> if (!cache.containsKey(user)) {</span>
<span class="source-line-no">173</span><span id="line-173"> cache.put(user, QuotaUtil.buildDefaultUserQuotaState(rsServices.getConfiguration()));</span>
<span class="source-line-no">174</span><span id="line-174"> }</span>
<span class="source-line-no">175</span><span id="line-175"> return cache.get(user);</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"> * Returns the limiter associated to the specified table.</span>
<span class="source-line-no">180</span><span id="line-180"> * @param table the table to limit</span>
<span class="source-line-no">181</span><span id="line-181"> * @return the limiter associated to the specified table</span>
<span class="source-line-no">182</span><span id="line-182"> */</span>
<span class="source-line-no">183</span><span id="line-183"> public QuotaLimiter getTableLimiter(final TableName table) {</span>
<span class="source-line-no">184</span><span id="line-184"> ensureInitialized();</span>
<span class="source-line-no">185</span><span id="line-185"> // local reference because the chore thread may assign to tableQuotaCache</span>
<span class="source-line-no">186</span><span id="line-186"> Map&lt;TableName, QuotaState&gt; cache = tableQuotaCache;</span>
<span class="source-line-no">187</span><span id="line-187"> if (!cache.containsKey(table)) {</span>
<span class="source-line-no">188</span><span id="line-188"> cache.put(table, new QuotaState());</span>
<span class="source-line-no">189</span><span id="line-189"> }</span>
<span class="source-line-no">190</span><span id="line-190"> return cache.get(table).getGlobalLimiter();</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"> /**</span>
<span class="source-line-no">194</span><span id="line-194"> * Returns the limiter associated to the specified namespace.</span>
<span class="source-line-no">195</span><span id="line-195"> * @param namespace the namespace to limit</span>
<span class="source-line-no">196</span><span id="line-196"> * @return the limiter associated to the specified namespace</span>
<span class="source-line-no">197</span><span id="line-197"> */</span>
<span class="source-line-no">198</span><span id="line-198"> public QuotaLimiter getNamespaceLimiter(final String namespace) {</span>
<span class="source-line-no">199</span><span id="line-199"> ensureInitialized();</span>
<span class="source-line-no">200</span><span id="line-200"> // local reference because the chore thread may assign to namespaceQuotaCache</span>
<span class="source-line-no">201</span><span id="line-201"> Map&lt;String, QuotaState&gt; cache = namespaceQuotaCache;</span>
<span class="source-line-no">202</span><span id="line-202"> if (!cache.containsKey(namespace)) {</span>
<span class="source-line-no">203</span><span id="line-203"> cache.put(namespace, new QuotaState());</span>
<span class="source-line-no">204</span><span id="line-204"> }</span>
<span class="source-line-no">205</span><span id="line-205"> return cache.get(namespace).getGlobalLimiter();</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"> /**</span>
<span class="source-line-no">209</span><span id="line-209"> * Returns the limiter associated to the specified region server.</span>
<span class="source-line-no">210</span><span id="line-210"> * @param regionServer the region server to limit</span>
<span class="source-line-no">211</span><span id="line-211"> * @return the limiter associated to the specified region server</span>
<span class="source-line-no">212</span><span id="line-212"> */</span>
<span class="source-line-no">213</span><span id="line-213"> public QuotaLimiter getRegionServerQuotaLimiter(final String regionServer) {</span>
<span class="source-line-no">214</span><span id="line-214"> ensureInitialized();</span>
<span class="source-line-no">215</span><span id="line-215"> // local reference because the chore thread may assign to regionServerQuotaCache</span>
<span class="source-line-no">216</span><span id="line-216"> Map&lt;String, QuotaState&gt; cache = regionServerQuotaCache;</span>
<span class="source-line-no">217</span><span id="line-217"> if (!cache.containsKey(regionServer)) {</span>
<span class="source-line-no">218</span><span id="line-218"> cache.put(regionServer, new QuotaState());</span>
<span class="source-line-no">219</span><span id="line-219"> }</span>
<span class="source-line-no">220</span><span id="line-220"> return cache.get(regionServer).getGlobalLimiter();</span>
<span class="source-line-no">221</span><span id="line-221"> }</span>
<span class="source-line-no">222</span><span id="line-222"></span>
<span class="source-line-no">223</span><span id="line-223"> protected boolean isExceedThrottleQuotaEnabled() {</span>
<span class="source-line-no">224</span><span id="line-224"> return exceedThrottleQuotaEnabled;</span>
<span class="source-line-no">225</span><span id="line-225"> }</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"> * Applies a request attribute user override if available, otherwise returns the UGI's short</span>
<span class="source-line-no">229</span><span id="line-229"> * username</span>
<span class="source-line-no">230</span><span id="line-230"> * @param ugi The request's UserGroupInformation</span>
<span class="source-line-no">231</span><span id="line-231"> */</span>
<span class="source-line-no">232</span><span id="line-232"> String getQuotaUserName(final UserGroupInformation ugi) {</span>
<span class="source-line-no">233</span><span id="line-233"> if (userOverrideRequestAttributeKey == null) {</span>
<span class="source-line-no">234</span><span id="line-234"> return ugi.getShortUserName();</span>
<span class="source-line-no">235</span><span id="line-235"> }</span>
<span class="source-line-no">236</span><span id="line-236"></span>
<span class="source-line-no">237</span><span id="line-237"> Optional&lt;RpcCall&gt; rpcCall = RpcServer.getCurrentCall();</span>
<span class="source-line-no">238</span><span id="line-238"> if (!rpcCall.isPresent()) {</span>
<span class="source-line-no">239</span><span id="line-239"> return ugi.getShortUserName();</span>
<span class="source-line-no">240</span><span id="line-240"> }</span>
<span class="source-line-no">241</span><span id="line-241"></span>
<span class="source-line-no">242</span><span id="line-242"> byte[] override = rpcCall.get().getRequestAttribute(userOverrideRequestAttributeKey);</span>
<span class="source-line-no">243</span><span id="line-243"> if (override == null) {</span>
<span class="source-line-no">244</span><span id="line-244"> return ugi.getShortUserName();</span>
<span class="source-line-no">245</span><span id="line-245"> }</span>
<span class="source-line-no">246</span><span id="line-246"> return Bytes.toString(override);</span>
<span class="source-line-no">247</span><span id="line-247"> }</span>
<span class="source-line-no">248</span><span id="line-248"></span>
<span class="source-line-no">249</span><span id="line-249"> void triggerCacheRefresh() {</span>
<span class="source-line-no">250</span><span id="line-250"> refreshChore.triggerNow();</span>
<span class="source-line-no">251</span><span id="line-251"> }</span>
<span class="source-line-no">252</span><span id="line-252"></span>
<span class="source-line-no">253</span><span id="line-253"> void forceSynchronousCacheRefresh() {</span>
<span class="source-line-no">254</span><span id="line-254"> refreshChore.chore();</span>
<span class="source-line-no">255</span><span id="line-255"> }</span>
<span class="source-line-no">256</span><span id="line-256"></span>
<span class="source-line-no">257</span><span id="line-257"> /** visible for testing */</span>
<span class="source-line-no">258</span><span id="line-258"> Map&lt;String, QuotaState&gt; getNamespaceQuotaCache() {</span>
<span class="source-line-no">259</span><span id="line-259"> return namespaceQuotaCache;</span>
<span class="source-line-no">260</span><span id="line-260"> }</span>
<span class="source-line-no">261</span><span id="line-261"></span>
<span class="source-line-no">262</span><span id="line-262"> /** visible for testing */</span>
<span class="source-line-no">263</span><span id="line-263"> Map&lt;String, QuotaState&gt; getRegionServerQuotaCache() {</span>
<span class="source-line-no">264</span><span id="line-264"> return regionServerQuotaCache;</span>
<span class="source-line-no">265</span><span id="line-265"> }</span>
<span class="source-line-no">266</span><span id="line-266"></span>
<span class="source-line-no">267</span><span id="line-267"> /** visible for testing */</span>
<span class="source-line-no">268</span><span id="line-268"> Map&lt;TableName, QuotaState&gt; getTableQuotaCache() {</span>
<span class="source-line-no">269</span><span id="line-269"> return tableQuotaCache;</span>
<span class="source-line-no">270</span><span id="line-270"> }</span>
<span class="source-line-no">271</span><span id="line-271"></span>
<span class="source-line-no">272</span><span id="line-272"> /** visible for testing */</span>
<span class="source-line-no">273</span><span id="line-273"> Map&lt;String, UserQuotaState&gt; getUserQuotaCache() {</span>
<span class="source-line-no">274</span><span id="line-274"> return userQuotaCache;</span>
<span class="source-line-no">275</span><span id="line-275"> }</span>
<span class="source-line-no">276</span><span id="line-276"></span>
<span class="source-line-no">277</span><span id="line-277"> // TODO: Remove this once we have the notification bus</span>
<span class="source-line-no">278</span><span id="line-278"> private class QuotaRefresherChore extends ScheduledChore {</span>
<span class="source-line-no">279</span><span id="line-279"> // Querying cluster metrics so often, per-RegionServer, limits horizontal scalability.</span>
<span class="source-line-no">280</span><span id="line-280"> // So we cache the results to reduce that load.</span>
<span class="source-line-no">281</span><span id="line-281"> private final RefreshableExpiringValueCache&lt;ClusterMetrics&gt; tableRegionStatesClusterMetrics;</span>
<span class="source-line-no">282</span><span id="line-282"> private final RefreshableExpiringValueCache&lt;Integer&gt; regionServersSize;</span>
<span class="source-line-no">283</span><span id="line-283"></span>
<span class="source-line-no">284</span><span id="line-284"> public QuotaRefresherChore(Configuration conf, final int period, final Stoppable stoppable) {</span>
<span class="source-line-no">285</span><span id="line-285"> super("QuotaRefresherChore", stoppable, period);</span>
<span class="source-line-no">286</span><span id="line-286"></span>
<span class="source-line-no">287</span><span id="line-287"> Duration tableRegionStatesCacheTtl =</span>
<span class="source-line-no">288</span><span id="line-288"> Duration.ofMillis(conf.getLong(TABLE_REGION_STATES_CACHE_TTL_MS, period));</span>
<span class="source-line-no">289</span><span id="line-289"> this.tableRegionStatesClusterMetrics =</span>
<span class="source-line-no">290</span><span id="line-290"> new RefreshableExpiringValueCache&lt;&gt;("tableRegionStatesClusterMetrics",</span>
<span class="source-line-no">291</span><span id="line-291"> tableRegionStatesCacheTtl, () -&gt; rsServices.getConnection().getAdmin()</span>
<span class="source-line-no">292</span><span id="line-292"> .getClusterMetrics(EnumSet.of(Option.SERVERS_NAME, Option.TABLE_TO_REGIONS_COUNT)));</span>
<span class="source-line-no">293</span><span id="line-293"></span>
<span class="source-line-no">294</span><span id="line-294"> Duration regionServersSizeCacheTtl =</span>
<span class="source-line-no">295</span><span id="line-295"> Duration.ofMillis(conf.getLong(REGION_SERVERS_SIZE_CACHE_TTL_MS, period));</span>
<span class="source-line-no">296</span><span id="line-296"> regionServersSize =</span>
<span class="source-line-no">297</span><span id="line-297"> new RefreshableExpiringValueCache&lt;&gt;("regionServersSize", regionServersSizeCacheTtl,</span>
<span class="source-line-no">298</span><span id="line-298"> () -&gt; rsServices.getConnection().getAdmin().getRegionServers().size());</span>
<span class="source-line-no">299</span><span id="line-299"> }</span>
<span class="source-line-no">300</span><span id="line-300"></span>
<span class="source-line-no">301</span><span id="line-301"> @Override</span>
<span class="source-line-no">302</span><span id="line-302"> public synchronized boolean triggerNow() {</span>
<span class="source-line-no">303</span><span id="line-303"> tableRegionStatesClusterMetrics.invalidate();</span>
<span class="source-line-no">304</span><span id="line-304"> regionServersSize.invalidate();</span>
<span class="source-line-no">305</span><span id="line-305"> return super.triggerNow();</span>
<span class="source-line-no">306</span><span id="line-306"> }</span>
<span class="source-line-no">307</span><span id="line-307"></span>
<span class="source-line-no">308</span><span id="line-308"> @Override</span>
<span class="source-line-no">309</span><span id="line-309"> protected void chore() {</span>
<span class="source-line-no">310</span><span id="line-310"> updateQuotaFactors();</span>
<span class="source-line-no">311</span><span id="line-311"></span>
<span class="source-line-no">312</span><span id="line-312"> try {</span>
<span class="source-line-no">313</span><span id="line-313"> Map&lt;String, UserQuotaState&gt; newUserQuotaCache = new HashMap&lt;&gt;(fetchUserQuotaStateEntries());</span>
<span class="source-line-no">314</span><span id="line-314"> updateNewCacheFromOld(userQuotaCache, newUserQuotaCache);</span>
<span class="source-line-no">315</span><span id="line-315"> userQuotaCache = newUserQuotaCache;</span>
<span class="source-line-no">316</span><span id="line-316"> } catch (IOException e) {</span>
<span class="source-line-no">317</span><span id="line-317"> LOG.error("Error while fetching user quotas", e);</span>
<span class="source-line-no">318</span><span id="line-318"> }</span>
<span class="source-line-no">319</span><span id="line-319"></span>
<span class="source-line-no">320</span><span id="line-320"> try {</span>
<span class="source-line-no">321</span><span id="line-321"> Map&lt;String, QuotaState&gt; newRegionServerQuotaCache =</span>
<span class="source-line-no">322</span><span id="line-322"> new HashMap&lt;&gt;(fetchRegionServerQuotaStateEntries());</span>
<span class="source-line-no">323</span><span id="line-323"> updateNewCacheFromOld(regionServerQuotaCache, newRegionServerQuotaCache);</span>
<span class="source-line-no">324</span><span id="line-324"> regionServerQuotaCache = newRegionServerQuotaCache;</span>
<span class="source-line-no">325</span><span id="line-325"> } catch (IOException e) {</span>
<span class="source-line-no">326</span><span id="line-326"> LOG.error("Error while fetching region server quotas", e);</span>
<span class="source-line-no">327</span><span id="line-327"> }</span>
<span class="source-line-no">328</span><span id="line-328"></span>
<span class="source-line-no">329</span><span id="line-329"> try {</span>
<span class="source-line-no">330</span><span id="line-330"> Map&lt;TableName, QuotaState&gt; newTableQuotaCache =</span>
<span class="source-line-no">331</span><span id="line-331"> new HashMap&lt;&gt;(fetchTableQuotaStateEntries());</span>
<span class="source-line-no">332</span><span id="line-332"> updateNewCacheFromOld(tableQuotaCache, newTableQuotaCache);</span>
<span class="source-line-no">333</span><span id="line-333"> tableQuotaCache = newTableQuotaCache;</span>
<span class="source-line-no">334</span><span id="line-334"> } catch (IOException e) {</span>
<span class="source-line-no">335</span><span id="line-335"> LOG.error("Error while refreshing table quotas", e);</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"> try {</span>
<span class="source-line-no">339</span><span id="line-339"> Map&lt;String, QuotaState&gt; newNamespaceQuotaCache =</span>
<span class="source-line-no">340</span><span id="line-340"> new HashMap&lt;&gt;(fetchNamespaceQuotaStateEntries());</span>
<span class="source-line-no">341</span><span id="line-341"> updateNewCacheFromOld(namespaceQuotaCache, newNamespaceQuotaCache);</span>
<span class="source-line-no">342</span><span id="line-342"> namespaceQuotaCache = newNamespaceQuotaCache;</span>
<span class="source-line-no">343</span><span id="line-343"> } catch (IOException e) {</span>
<span class="source-line-no">344</span><span id="line-344"> LOG.error("Error while refreshing namespace quotas", e);</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"> fetchExceedThrottleQuota();</span>
<span class="source-line-no">348</span><span id="line-348"> }</span>
<span class="source-line-no">349</span><span id="line-349"></span>
<span class="source-line-no">350</span><span id="line-350"> private void fetchExceedThrottleQuota() {</span>
<span class="source-line-no">351</span><span id="line-351"> try {</span>
<span class="source-line-no">352</span><span id="line-352"> QuotaCache.this.exceedThrottleQuotaEnabled =</span>
<span class="source-line-no">353</span><span id="line-353"> QuotaUtil.isExceedThrottleQuotaEnabled(rsServices.getConnection());</span>
<span class="source-line-no">354</span><span id="line-354"> } catch (IOException e) {</span>
<span class="source-line-no">355</span><span id="line-355"> LOG.warn("Unable to read if exceed throttle quota enabled from quota table", e);</span>
<span class="source-line-no">356</span><span id="line-356"> }</span>
<span class="source-line-no">357</span><span id="line-357"> }</span>
<span class="source-line-no">358</span><span id="line-358"></span>
<span class="source-line-no">359</span><span id="line-359"> /**</span>
<span class="source-line-no">360</span><span id="line-360"> * Update quota factors which is used to divide cluster scope quota into machine scope quota For</span>
<span class="source-line-no">361</span><span id="line-361"> * user/namespace/user over namespace quota, use [1 / RSNum] as machine factor. For table/user</span>
<span class="source-line-no">362</span><span id="line-362"> * over table quota, use [1 / TotalTableRegionNum * MachineTableRegionNum] as machine factor.</span>
<span class="source-line-no">363</span><span id="line-363"> */</span>
<span class="source-line-no">364</span><span id="line-364"> private void updateQuotaFactors() {</span>
<span class="source-line-no">365</span><span id="line-365"> boolean hasTableQuotas = !tableQuotaCache.entrySet().isEmpty()</span>
<span class="source-line-no">366</span><span id="line-366"> || userQuotaCache.values().stream().anyMatch(UserQuotaState::hasTableLimiters);</span>
<span class="source-line-no">367</span><span id="line-367"> if (hasTableQuotas) {</span>
<span class="source-line-no">368</span><span id="line-368"> updateTableMachineQuotaFactors();</span>
<span class="source-line-no">369</span><span id="line-369"> } else {</span>
<span class="source-line-no">370</span><span id="line-370"> updateOnlyMachineQuotaFactors();</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"></span>
<span class="source-line-no">374</span><span id="line-374"> /**</span>
<span class="source-line-no">375</span><span id="line-375"> * This method is cheaper than {@link #updateTableMachineQuotaFactors()} and should be used if</span>
<span class="source-line-no">376</span><span id="line-376"> * we don't have any table quotas in the cache.</span>
<span class="source-line-no">377</span><span id="line-377"> */</span>
<span class="source-line-no">378</span><span id="line-378"> private void updateOnlyMachineQuotaFactors() {</span>
<span class="source-line-no">379</span><span id="line-379"> Optional&lt;Integer&gt; rsSize = regionServersSize.get();</span>
<span class="source-line-no">380</span><span id="line-380"> if (rsSize.isPresent()) {</span>
<span class="source-line-no">381</span><span id="line-381"> updateMachineQuotaFactors(rsSize.get());</span>
<span class="source-line-no">382</span><span id="line-382"> } else {</span>
<span class="source-line-no">383</span><span id="line-383"> regionServersSize.refresh();</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"></span>
<span class="source-line-no">387</span><span id="line-387"> /**</span>
<span class="source-line-no">388</span><span id="line-388"> * This will call {@link #updateMachineQuotaFactors(int)}, and then update the table machine</span>
<span class="source-line-no">389</span><span id="line-389"> * factors as well. This relies on a more expensive query for ClusterMetrics.</span>
<span class="source-line-no">390</span><span id="line-390"> */</span>
<span class="source-line-no">391</span><span id="line-391"> private void updateTableMachineQuotaFactors() {</span>
<span class="source-line-no">392</span><span id="line-392"> Optional&lt;ClusterMetrics&gt; clusterMetricsMaybe = tableRegionStatesClusterMetrics.get();</span>
<span class="source-line-no">393</span><span id="line-393"> if (!clusterMetricsMaybe.isPresent()) {</span>
<span class="source-line-no">394</span><span id="line-394"> tableRegionStatesClusterMetrics.refresh();</span>
<span class="source-line-no">395</span><span id="line-395"> return;</span>
<span class="source-line-no">396</span><span id="line-396"> }</span>
<span class="source-line-no">397</span><span id="line-397"> ClusterMetrics clusterMetrics = clusterMetricsMaybe.get();</span>
<span class="source-line-no">398</span><span id="line-398"> updateMachineQuotaFactors(clusterMetrics.getServersName().size());</span>
<span class="source-line-no">399</span><span id="line-399"></span>
<span class="source-line-no">400</span><span id="line-400"> Map&lt;TableName, RegionStatesCount&gt; tableRegionStatesCount =</span>
<span class="source-line-no">401</span><span id="line-401"> clusterMetrics.getTableRegionStatesCount();</span>
<span class="source-line-no">402</span><span id="line-402"></span>
<span class="source-line-no">403</span><span id="line-403"> // Update table machine quota factors</span>
<span class="source-line-no">404</span><span id="line-404"> for (TableName tableName : tableQuotaCache.keySet()) {</span>
<span class="source-line-no">405</span><span id="line-405"> if (tableRegionStatesCount.containsKey(tableName)) {</span>
<span class="source-line-no">406</span><span id="line-406"> double factor = 1;</span>
<span class="source-line-no">407</span><span id="line-407"> try {</span>
<span class="source-line-no">408</span><span id="line-408"> long regionSize = tableRegionStatesCount.get(tableName).getOpenRegions();</span>
<span class="source-line-no">409</span><span id="line-409"> if (regionSize == 0) {</span>
<span class="source-line-no">410</span><span id="line-410"> factor = 0;</span>
<span class="source-line-no">411</span><span id="line-411"> } else {</span>
<span class="source-line-no">412</span><span id="line-412"> int localRegionSize = rsServices.getRegions(tableName).size();</span>
<span class="source-line-no">413</span><span id="line-413"> factor = 1.0 * localRegionSize / regionSize;</span>
<span class="source-line-no">414</span><span id="line-414"> }</span>
<span class="source-line-no">415</span><span id="line-415"> } catch (IOException e) {</span>
<span class="source-line-no">416</span><span id="line-416"> LOG.warn("Get table regions failed: {}", tableName, e);</span>
<span class="source-line-no">417</span><span id="line-417"> }</span>
<span class="source-line-no">418</span><span id="line-418"> tableMachineQuotaFactors.put(tableName, factor);</span>
<span class="source-line-no">419</span><span id="line-419"> } else {</span>
<span class="source-line-no">420</span><span id="line-420"> // TableName might have already been dropped (outdated)</span>
<span class="source-line-no">421</span><span id="line-421"> tableMachineQuotaFactors.remove(tableName);</span>
<span class="source-line-no">422</span><span id="line-422"> }</span>
<span class="source-line-no">423</span><span id="line-423"> }</span>
<span class="source-line-no">424</span><span id="line-424"> }</span>
<span class="source-line-no">425</span><span id="line-425"></span>
<span class="source-line-no">426</span><span id="line-426"> private void updateMachineQuotaFactors(int rsSize) {</span>
<span class="source-line-no">427</span><span id="line-427"> if (rsSize != 0) {</span>
<span class="source-line-no">428</span><span id="line-428"> // TODO if use rs group, the cluster limit should be shared by the rs group</span>
<span class="source-line-no">429</span><span id="line-429"> machineQuotaFactor = 1.0 / rsSize;</span>
<span class="source-line-no">430</span><span id="line-430"> }</span>
<span class="source-line-no">431</span><span id="line-431"> }</span>
<span class="source-line-no">432</span><span id="line-432"> }</span>
<span class="source-line-no">433</span><span id="line-433"></span>
<span class="source-line-no">434</span><span id="line-434"> /** visible for testing */</span>
<span class="source-line-no">435</span><span id="line-435"> static &lt;K, V extends QuotaState&gt; void updateNewCacheFromOld(Map&lt;K, V&gt; oldCache,</span>
<span class="source-line-no">436</span><span id="line-436"> Map&lt;K, V&gt; newCache) {</span>
<span class="source-line-no">437</span><span id="line-437"> for (Map.Entry&lt;K, V&gt; entry : oldCache.entrySet()) {</span>
<span class="source-line-no">438</span><span id="line-438"> K key = entry.getKey();</span>
<span class="source-line-no">439</span><span id="line-439"> if (newCache.containsKey(key)) {</span>
<span class="source-line-no">440</span><span id="line-440"> V newState = newCache.get(key);</span>
<span class="source-line-no">441</span><span id="line-441"> V oldState = entry.getValue();</span>
<span class="source-line-no">442</span><span id="line-442"> oldState.update(newState);</span>
<span class="source-line-no">443</span><span id="line-443"> newCache.put(key, oldState);</span>
<span class="source-line-no">444</span><span id="line-444"> }</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>
<span class="source-line-no">447</span><span id="line-447"></span>
<span class="source-line-no">448</span><span id="line-448"> static class RefreshableExpiringValueCache&lt;T&gt; {</span>
<span class="source-line-no">449</span><span id="line-449"> private final String name;</span>
<span class="source-line-no">450</span><span id="line-450"> private final LoadingCache&lt;String, Optional&lt;T&gt;&gt; cache;</span>
<span class="source-line-no">451</span><span id="line-451"></span>
<span class="source-line-no">452</span><span id="line-452"> RefreshableExpiringValueCache(String name, Duration refreshPeriod,</span>
<span class="source-line-no">453</span><span id="line-453"> ThrowingSupplier&lt;T&gt; supplier) {</span>
<span class="source-line-no">454</span><span id="line-454"> this.name = name;</span>
<span class="source-line-no">455</span><span id="line-455"> this.cache =</span>
<span class="source-line-no">456</span><span id="line-456"> CacheBuilder.newBuilder().expireAfterWrite(refreshPeriod.toMillis(), TimeUnit.MILLISECONDS)</span>
<span class="source-line-no">457</span><span id="line-457"> .build(new CacheLoader&lt;&gt;() {</span>
<span class="source-line-no">458</span><span id="line-458"> @Override</span>
<span class="source-line-no">459</span><span id="line-459"> public Optional&lt;T&gt; load(String key) {</span>
<span class="source-line-no">460</span><span id="line-460"> try {</span>
<span class="source-line-no">461</span><span id="line-461"> return Optional.of(supplier.get());</span>
<span class="source-line-no">462</span><span id="line-462"> } catch (Exception e) {</span>
<span class="source-line-no">463</span><span id="line-463"> LOG.warn("Failed to refresh cache {}", name, e);</span>
<span class="source-line-no">464</span><span id="line-464"> return Optional.empty();</span>
<span class="source-line-no">465</span><span id="line-465"> }</span>
<span class="source-line-no">466</span><span id="line-466"> }</span>
<span class="source-line-no">467</span><span id="line-467"> });</span>
<span class="source-line-no">468</span><span id="line-468"> }</span>
<span class="source-line-no">469</span><span id="line-469"></span>
<span class="source-line-no">470</span><span id="line-470"> Optional&lt;T&gt; get() {</span>
<span class="source-line-no">471</span><span id="line-471"> return cache.getUnchecked(name);</span>
<span class="source-line-no">472</span><span id="line-472"> }</span>
<span class="source-line-no">473</span><span id="line-473"></span>
<span class="source-line-no">474</span><span id="line-474"> void refresh() {</span>
<span class="source-line-no">475</span><span id="line-475"> cache.refresh(name);</span>
<span class="source-line-no">476</span><span id="line-476"> }</span>
<span class="source-line-no">477</span><span id="line-477"></span>
<span class="source-line-no">478</span><span id="line-478"> void invalidate() {</span>
<span class="source-line-no">479</span><span id="line-479"> cache.invalidate(name);</span>
<span class="source-line-no">480</span><span id="line-480"> }</span>
<span class="source-line-no">481</span><span id="line-481"> }</span>
<span class="source-line-no">482</span><span id="line-482"></span>
<span class="source-line-no">483</span><span id="line-483"> @FunctionalInterface</span>
<span class="source-line-no">484</span><span id="line-484"> static interface ThrowingSupplier&lt;T&gt; {</span>
<span class="source-line-no">485</span><span id="line-485"> T get() throws Exception;</span>
<span class="source-line-no">486</span><span id="line-486"> }</span>
<span class="source-line-no">487</span><span id="line-487"></span>
<span class="source-line-no">488</span><span id="line-488">}</span>
</pre>
</div>
</main>
</body>
</html>