http://git-wip-us.apache.org/repos/asf/hbase-site/blob/4f94a4c5/devapidocs/src-html/org/apache/hadoop/hbase/quotas/MasterSpaceQuotaObserver.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/quotas/MasterSpaceQuotaObserver.html b/devapidocs/src-html/org/apache/hadoop/hbase/quotas/MasterSpaceQuotaObserver.html index 1ed8fc8..6c120ea 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/quotas/MasterSpaceQuotaObserver.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/quotas/MasterSpaceQuotaObserver.html @@ -37,70 +37,67 @@ <span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.coprocessor.MasterCoprocessorEnvironment;<a name="line.29"></a> <span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.coprocessor.MasterObserver;<a name="line.30"></a> <span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.coprocessor.ObserverContext;<a name="line.31"></a> -<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.master.MasterServices;<a name="line.32"></a> -<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas;<a name="line.33"></a> -<span class="sourceLineNo">034</span><a name="line.34"></a> -<span class="sourceLineNo">035</span>/**<a name="line.35"></a> -<span class="sourceLineNo">036</span> * An observer to automatically delete space quotas when a table/namespace<a name="line.36"></a> -<span class="sourceLineNo">037</span> * are deleted.<a name="line.37"></a> -<span class="sourceLineNo">038</span> */<a name="line.38"></a> -<span class="sourceLineNo">039</span>@InterfaceAudience.Private<a name="line.39"></a> -<span class="sourceLineNo">040</span>public class MasterSpaceQuotaObserver implements MasterCoprocessor, MasterObserver {<a name="line.40"></a> -<span class="sourceLineNo">041</span> public static final String REMOVE_QUOTA_ON_TABLE_DELETE = "hbase.quota.remove.on.table.delete";<a name="line.41"></a> -<span class="sourceLineNo">042</span> public static final boolean REMOVE_QUOTA_ON_TABLE_DELETE_DEFAULT = true;<a name="line.42"></a> -<span class="sourceLineNo">043</span><a name="line.43"></a> -<span class="sourceLineNo">044</span> private CoprocessorEnvironment cpEnv;<a name="line.44"></a> -<span class="sourceLineNo">045</span> private Configuration conf;<a name="line.45"></a> -<span class="sourceLineNo">046</span> private boolean quotasEnabled = false;<a name="line.46"></a> -<span class="sourceLineNo">047</span><a name="line.47"></a> -<span class="sourceLineNo">048</span> @Override<a name="line.48"></a> -<span class="sourceLineNo">049</span> public Optional<MasterObserver> getMasterObserver() {<a name="line.49"></a> -<span class="sourceLineNo">050</span> return Optional.of(this);<a name="line.50"></a> -<span class="sourceLineNo">051</span> }<a name="line.51"></a> -<span class="sourceLineNo">052</span><a name="line.52"></a> -<span class="sourceLineNo">053</span> @Override<a name="line.53"></a> -<span class="sourceLineNo">054</span> public void start(CoprocessorEnvironment ctx) throws IOException {<a name="line.54"></a> -<span class="sourceLineNo">055</span> this.cpEnv = ctx;<a name="line.55"></a> -<span class="sourceLineNo">056</span> this.conf = cpEnv.getConfiguration();<a name="line.56"></a> -<span class="sourceLineNo">057</span> this.quotasEnabled = QuotaUtil.isQuotaEnabled(conf);<a name="line.57"></a> -<span class="sourceLineNo">058</span> }<a name="line.58"></a> -<span class="sourceLineNo">059</span><a name="line.59"></a> -<span class="sourceLineNo">060</span> @Override<a name="line.60"></a> -<span class="sourceLineNo">061</span> public void postDeleteTable(<a name="line.61"></a> -<span class="sourceLineNo">062</span> ObserverContext<MasterCoprocessorEnvironment> ctx, TableName tableName) throws IOException {<a name="line.62"></a> -<span class="sourceLineNo">063</span> // Do nothing if quotas aren't enabled<a name="line.63"></a> -<span class="sourceLineNo">064</span> if (!quotasEnabled) {<a name="line.64"></a> -<span class="sourceLineNo">065</span> return;<a name="line.65"></a> -<span class="sourceLineNo">066</span> }<a name="line.66"></a> -<span class="sourceLineNo">067</span> final MasterServices master = ctx.getEnvironment().getMasterServices();<a name="line.67"></a> -<span class="sourceLineNo">068</span> final Connection conn = master.getConnection();<a name="line.68"></a> -<span class="sourceLineNo">069</span> Quotas quotas = QuotaUtil.getTableQuota(master.getConnection(), tableName);<a name="line.69"></a> -<span class="sourceLineNo">070</span> if (quotas != null && quotas.hasSpace()) {<a name="line.70"></a> -<span class="sourceLineNo">071</span> QuotaSettings settings = QuotaSettingsFactory.removeTableSpaceLimit(tableName);<a name="line.71"></a> -<span class="sourceLineNo">072</span> try (Admin admin = conn.getAdmin()) {<a name="line.72"></a> -<span class="sourceLineNo">073</span> admin.setQuota(settings);<a name="line.73"></a> -<span class="sourceLineNo">074</span> }<a name="line.74"></a> -<span class="sourceLineNo">075</span> }<a name="line.75"></a> -<span class="sourceLineNo">076</span> }<a name="line.76"></a> -<span class="sourceLineNo">077</span><a name="line.77"></a> -<span class="sourceLineNo">078</span> @Override<a name="line.78"></a> -<span class="sourceLineNo">079</span> public void postDeleteNamespace(<a name="line.79"></a> -<span class="sourceLineNo">080</span> ObserverContext<MasterCoprocessorEnvironment> ctx, String namespace) throws IOException {<a name="line.80"></a> -<span class="sourceLineNo">081</span> // Do nothing if quotas aren't enabled<a name="line.81"></a> -<span class="sourceLineNo">082</span> if (!quotasEnabled) {<a name="line.82"></a> -<span class="sourceLineNo">083</span> return;<a name="line.83"></a> -<span class="sourceLineNo">084</span> }<a name="line.84"></a> -<span class="sourceLineNo">085</span> final MasterServices master = ctx.getEnvironment().getMasterServices();<a name="line.85"></a> -<span class="sourceLineNo">086</span> final Connection conn = master.getConnection();<a name="line.86"></a> -<span class="sourceLineNo">087</span> Quotas quotas = QuotaUtil.getNamespaceQuota(master.getConnection(), namespace);<a name="line.87"></a> -<span class="sourceLineNo">088</span> if (quotas != null && quotas.hasSpace()) {<a name="line.88"></a> -<span class="sourceLineNo">089</span> QuotaSettings settings = QuotaSettingsFactory.removeNamespaceSpaceLimit(namespace);<a name="line.89"></a> -<span class="sourceLineNo">090</span> try (Admin admin = conn.getAdmin()) {<a name="line.90"></a> -<span class="sourceLineNo">091</span> admin.setQuota(settings);<a name="line.91"></a> -<span class="sourceLineNo">092</span> }<a name="line.92"></a> -<span class="sourceLineNo">093</span> }<a name="line.93"></a> -<span class="sourceLineNo">094</span> }<a name="line.94"></a> -<span class="sourceLineNo">095</span>}<a name="line.95"></a> +<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Quotas;<a name="line.32"></a> +<span class="sourceLineNo">033</span><a name="line.33"></a> +<span class="sourceLineNo">034</span>/**<a name="line.34"></a> +<span class="sourceLineNo">035</span> * An observer to automatically delete space quotas when a table/namespace<a name="line.35"></a> +<span class="sourceLineNo">036</span> * are deleted.<a name="line.36"></a> +<span class="sourceLineNo">037</span> */<a name="line.37"></a> +<span class="sourceLineNo">038</span>@InterfaceAudience.Private<a name="line.38"></a> +<span class="sourceLineNo">039</span>public class MasterSpaceQuotaObserver implements MasterCoprocessor, MasterObserver {<a name="line.39"></a> +<span class="sourceLineNo">040</span> public static final String REMOVE_QUOTA_ON_TABLE_DELETE = "hbase.quota.remove.on.table.delete";<a name="line.40"></a> +<span class="sourceLineNo">041</span> public static final boolean REMOVE_QUOTA_ON_TABLE_DELETE_DEFAULT = true;<a name="line.41"></a> +<span class="sourceLineNo">042</span><a name="line.42"></a> +<span class="sourceLineNo">043</span> private CoprocessorEnvironment cpEnv;<a name="line.43"></a> +<span class="sourceLineNo">044</span> private Configuration conf;<a name="line.44"></a> +<span class="sourceLineNo">045</span> private boolean quotasEnabled = false;<a name="line.45"></a> +<span class="sourceLineNo">046</span><a name="line.46"></a> +<span class="sourceLineNo">047</span> @Override<a name="line.47"></a> +<span class="sourceLineNo">048</span> public Optional<MasterObserver> getMasterObserver() {<a name="line.48"></a> +<span class="sourceLineNo">049</span> return Optional.of(this);<a name="line.49"></a> +<span class="sourceLineNo">050</span> }<a name="line.50"></a> +<span class="sourceLineNo">051</span><a name="line.51"></a> +<span class="sourceLineNo">052</span> @Override<a name="line.52"></a> +<span class="sourceLineNo">053</span> public void start(CoprocessorEnvironment ctx) throws IOException {<a name="line.53"></a> +<span class="sourceLineNo">054</span> this.cpEnv = ctx;<a name="line.54"></a> +<span class="sourceLineNo">055</span> this.conf = cpEnv.getConfiguration();<a name="line.55"></a> +<span class="sourceLineNo">056</span> this.quotasEnabled = QuotaUtil.isQuotaEnabled(conf);<a name="line.56"></a> +<span class="sourceLineNo">057</span> }<a name="line.57"></a> +<span class="sourceLineNo">058</span><a name="line.58"></a> +<span class="sourceLineNo">059</span> @Override<a name="line.59"></a> +<span class="sourceLineNo">060</span> public void postDeleteTable(<a name="line.60"></a> +<span class="sourceLineNo">061</span> ObserverContext<MasterCoprocessorEnvironment> ctx, TableName tableName) throws IOException {<a name="line.61"></a> +<span class="sourceLineNo">062</span> // Do nothing if quotas aren't enabled<a name="line.62"></a> +<span class="sourceLineNo">063</span> if (!quotasEnabled) {<a name="line.63"></a> +<span class="sourceLineNo">064</span> return;<a name="line.64"></a> +<span class="sourceLineNo">065</span> }<a name="line.65"></a> +<span class="sourceLineNo">066</span> final Connection conn = ctx.getEnvironment().getConnection();<a name="line.66"></a> +<span class="sourceLineNo">067</span> Quotas quotas = QuotaUtil.getTableQuota(conn, tableName);<a name="line.67"></a> +<span class="sourceLineNo">068</span> if (quotas != null && quotas.hasSpace()) {<a name="line.68"></a> +<span class="sourceLineNo">069</span> QuotaSettings settings = QuotaSettingsFactory.removeTableSpaceLimit(tableName);<a name="line.69"></a> +<span class="sourceLineNo">070</span> try (Admin admin = conn.getAdmin()) {<a name="line.70"></a> +<span class="sourceLineNo">071</span> admin.setQuota(settings);<a name="line.71"></a> +<span class="sourceLineNo">072</span> }<a name="line.72"></a> +<span class="sourceLineNo">073</span> }<a name="line.73"></a> +<span class="sourceLineNo">074</span> }<a name="line.74"></a> +<span class="sourceLineNo">075</span><a name="line.75"></a> +<span class="sourceLineNo">076</span> @Override<a name="line.76"></a> +<span class="sourceLineNo">077</span> public void postDeleteNamespace(<a name="line.77"></a> +<span class="sourceLineNo">078</span> ObserverContext<MasterCoprocessorEnvironment> ctx, String namespace) throws IOException {<a name="line.78"></a> +<span class="sourceLineNo">079</span> // Do nothing if quotas aren't enabled<a name="line.79"></a> +<span class="sourceLineNo">080</span> if (!quotasEnabled) {<a name="line.80"></a> +<span class="sourceLineNo">081</span> return;<a name="line.81"></a> +<span class="sourceLineNo">082</span> }<a name="line.82"></a> +<span class="sourceLineNo">083</span> final Connection conn = ctx.getEnvironment().getConnection();<a name="line.83"></a> +<span class="sourceLineNo">084</span> Quotas quotas = QuotaUtil.getNamespaceQuota(conn, namespace);<a name="line.84"></a> +<span class="sourceLineNo">085</span> if (quotas != null && quotas.hasSpace()) {<a name="line.85"></a> +<span class="sourceLineNo">086</span> QuotaSettings settings = QuotaSettingsFactory.removeNamespaceSpaceLimit(namespace);<a name="line.86"></a> +<span class="sourceLineNo">087</span> try (Admin admin = conn.getAdmin()) {<a name="line.87"></a> +<span class="sourceLineNo">088</span> admin.setQuota(settings);<a name="line.88"></a> +<span class="sourceLineNo">089</span> }<a name="line.89"></a> +<span class="sourceLineNo">090</span> }<a name="line.90"></a> +<span class="sourceLineNo">091</span> }<a name="line.91"></a> +<span class="sourceLineNo">092</span>}<a name="line.92"></a>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/4f94a4c5/devapidocs/src-html/org/apache/hadoop/hbase/quotas/QuotaCache.Fetcher.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/quotas/QuotaCache.Fetcher.html b/devapidocs/src-html/org/apache/hadoop/hbase/quotas/QuotaCache.Fetcher.html index 40c9779..fc7948d 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/quotas/QuotaCache.Fetcher.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/quotas/QuotaCache.Fetcher.html @@ -6,7 +6,7 @@ </head> <body> <div class="sourceContainer"> -<pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a> +<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> @@ -28,289 +28,290 @@ <span class="sourceLineNo">020</span><a name="line.20"></a> <span class="sourceLineNo">021</span>import static org.apache.hadoop.hbase.util.CollectionUtils.computeIfAbsent;<a name="line.21"></a> <span class="sourceLineNo">022</span><a name="line.22"></a> -<span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.shaded.com.google.common.annotations.VisibleForTesting;<a name="line.23"></a> -<span class="sourceLineNo">024</span><a name="line.24"></a> -<span class="sourceLineNo">025</span>import java.io.IOException;<a name="line.25"></a> -<span class="sourceLineNo">026</span>import java.util.ArrayList;<a name="line.26"></a> -<span class="sourceLineNo">027</span>import java.util.List;<a name="line.27"></a> -<span class="sourceLineNo">028</span>import java.util.Map;<a name="line.28"></a> -<span class="sourceLineNo">029</span>import java.util.Set;<a name="line.29"></a> -<span class="sourceLineNo">030</span>import java.util.concurrent.ConcurrentHashMap;<a name="line.30"></a> -<span class="sourceLineNo">031</span><a name="line.31"></a> -<span class="sourceLineNo">032</span>import org.apache.commons.logging.Log;<a name="line.32"></a> -<span class="sourceLineNo">033</span>import org.apache.commons.logging.LogFactory;<a name="line.33"></a> -<span class="sourceLineNo">034</span>import org.apache.hadoop.conf.Configuration;<a name="line.34"></a> -<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.ScheduledChore;<a name="line.35"></a> -<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.Stoppable;<a name="line.36"></a> -<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.TableName;<a name="line.37"></a> -<span class="sourceLineNo">038</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.38"></a> -<span class="sourceLineNo">039</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.39"></a> -<span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.client.Get;<a name="line.40"></a> -<span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.regionserver.RegionServerServices;<a name="line.41"></a> -<span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;<a name="line.42"></a> -<span class="sourceLineNo">043</span>import org.apache.hadoop.security.UserGroupInformation;<a name="line.43"></a> -<span class="sourceLineNo">044</span><a name="line.44"></a> -<span class="sourceLineNo">045</span>/**<a name="line.45"></a> -<span class="sourceLineNo">046</span> * Cache that keeps track of the quota settings for the users and tables that<a name="line.46"></a> -<span class="sourceLineNo">047</span> * are interacting with it.<a name="line.47"></a> -<span class="sourceLineNo">048</span> *<a name="line.48"></a> -<span class="sourceLineNo">049</span> * To avoid blocking the operations if the requested quota is not in cache<a name="line.49"></a> -<span class="sourceLineNo">050</span> * an "empty quota" will be returned and the request to fetch the quota information<a name="line.50"></a> -<span class="sourceLineNo">051</span> * will be enqueued for the next refresh.<a name="line.51"></a> -<span class="sourceLineNo">052</span> *<a name="line.52"></a> -<span class="sourceLineNo">053</span> * TODO: At the moment the Cache has a Chore that will be triggered every 5min<a name="line.53"></a> -<span class="sourceLineNo">054</span> * or on cache-miss events. Later the Quotas will be pushed using the notification system.<a name="line.54"></a> -<span class="sourceLineNo">055</span> */<a name="line.55"></a> -<span class="sourceLineNo">056</span>@InterfaceAudience.Private<a name="line.56"></a> -<span class="sourceLineNo">057</span>@InterfaceStability.Evolving<a name="line.57"></a> -<span class="sourceLineNo">058</span>public class QuotaCache implements Stoppable {<a name="line.58"></a> -<span class="sourceLineNo">059</span> private static final Log LOG = LogFactory.getLog(QuotaCache.class);<a name="line.59"></a> -<span class="sourceLineNo">060</span><a name="line.60"></a> -<span class="sourceLineNo">061</span> public static final String REFRESH_CONF_KEY = "hbase.quota.refresh.period";<a name="line.61"></a> -<span class="sourceLineNo">062</span> private static final int REFRESH_DEFAULT_PERIOD = 5 * 60000; // 5min<a name="line.62"></a> -<span class="sourceLineNo">063</span> private static final int EVICT_PERIOD_FACTOR = 5; // N * REFRESH_DEFAULT_PERIOD<a name="line.63"></a> -<span class="sourceLineNo">064</span><a name="line.64"></a> -<span class="sourceLineNo">065</span> // for testing purpose only, enforce the cache to be always refreshed<a name="line.65"></a> -<span class="sourceLineNo">066</span> static boolean TEST_FORCE_REFRESH = false;<a name="line.66"></a> -<span class="sourceLineNo">067</span><a name="line.67"></a> -<span class="sourceLineNo">068</span> private final ConcurrentHashMap<String, QuotaState> namespaceQuotaCache = new ConcurrentHashMap<>();<a name="line.68"></a> -<span class="sourceLineNo">069</span> private final ConcurrentHashMap<TableName, QuotaState> tableQuotaCache = new ConcurrentHashMap<>();<a name="line.69"></a> -<span class="sourceLineNo">070</span> private final ConcurrentHashMap<String, UserQuotaState> userQuotaCache = new ConcurrentHashMap<>();<a name="line.70"></a> -<span class="sourceLineNo">071</span> private final RegionServerServices rsServices;<a name="line.71"></a> -<span class="sourceLineNo">072</span><a name="line.72"></a> -<span class="sourceLineNo">073</span> private QuotaRefresherChore refreshChore;<a name="line.73"></a> -<span class="sourceLineNo">074</span> private boolean stopped = true;<a name="line.74"></a> -<span class="sourceLineNo">075</span><a name="line.75"></a> -<span class="sourceLineNo">076</span> public QuotaCache(final RegionServerServices rsServices) {<a name="line.76"></a> -<span class="sourceLineNo">077</span> this.rsServices = rsServices;<a name="line.77"></a> -<span class="sourceLineNo">078</span> }<a name="line.78"></a> -<span class="sourceLineNo">079</span><a name="line.79"></a> -<span class="sourceLineNo">080</span> public void start() throws IOException {<a name="line.80"></a> -<span class="sourceLineNo">081</span> stopped = false;<a name="line.81"></a> -<span class="sourceLineNo">082</span><a name="line.82"></a> -<span class="sourceLineNo">083</span> // TODO: This will be replaced once we have the notification bus ready.<a name="line.83"></a> -<span class="sourceLineNo">084</span> Configuration conf = rsServices.getConfiguration();<a name="line.84"></a> -<span class="sourceLineNo">085</span> int period = conf.getInt(REFRESH_CONF_KEY, REFRESH_DEFAULT_PERIOD);<a name="line.85"></a> -<span class="sourceLineNo">086</span> refreshChore = new QuotaRefresherChore(period, this);<a name="line.86"></a> -<span class="sourceLineNo">087</span> rsServices.getChoreService().scheduleChore(refreshChore);<a name="line.87"></a> -<span class="sourceLineNo">088</span> }<a name="line.88"></a> -<span class="sourceLineNo">089</span><a name="line.89"></a> -<span class="sourceLineNo">090</span> @Override<a name="line.90"></a> -<span class="sourceLineNo">091</span> public void stop(final String why) {<a name="line.91"></a> -<span class="sourceLineNo">092</span> stopped = true;<a name="line.92"></a> -<span class="sourceLineNo">093</span> }<a name="line.93"></a> -<span class="sourceLineNo">094</span><a name="line.94"></a> -<span class="sourceLineNo">095</span> @Override<a name="line.95"></a> -<span class="sourceLineNo">096</span> public boolean isStopped() {<a name="line.96"></a> -<span class="sourceLineNo">097</span> return stopped;<a name="line.97"></a> -<span class="sourceLineNo">098</span> }<a name="line.98"></a> -<span class="sourceLineNo">099</span><a name="line.99"></a> -<span class="sourceLineNo">100</span> /**<a name="line.100"></a> -<span class="sourceLineNo">101</span> * Returns the limiter associated to the specified user/table.<a name="line.101"></a> -<span class="sourceLineNo">102</span> *<a name="line.102"></a> -<span class="sourceLineNo">103</span> * @param ugi the user to limit<a name="line.103"></a> -<span class="sourceLineNo">104</span> * @param table the table to limit<a name="line.104"></a> -<span class="sourceLineNo">105</span> * @return the limiter associated to the specified user/table<a name="line.105"></a> -<span class="sourceLineNo">106</span> */<a name="line.106"></a> -<span class="sourceLineNo">107</span> public QuotaLimiter getUserLimiter(final UserGroupInformation ugi, final TableName table) {<a name="line.107"></a> -<span class="sourceLineNo">108</span> if (table.isSystemTable()) {<a name="line.108"></a> -<span class="sourceLineNo">109</span> return NoopQuotaLimiter.get();<a name="line.109"></a> -<span class="sourceLineNo">110</span> }<a name="line.110"></a> -<span class="sourceLineNo">111</span> return getUserQuotaState(ugi).getTableLimiter(table);<a name="line.111"></a> -<span class="sourceLineNo">112</span> }<a name="line.112"></a> -<span class="sourceLineNo">113</span><a name="line.113"></a> -<span class="sourceLineNo">114</span> /**<a name="line.114"></a> -<span class="sourceLineNo">115</span> * Returns the QuotaState associated to the specified user.<a name="line.115"></a> -<span class="sourceLineNo">116</span> * @param ugi the user<a name="line.116"></a> -<span class="sourceLineNo">117</span> * @return the quota info associated to specified user<a name="line.117"></a> -<span class="sourceLineNo">118</span> */<a name="line.118"></a> -<span class="sourceLineNo">119</span> public UserQuotaState getUserQuotaState(final UserGroupInformation ugi) {<a name="line.119"></a> -<span class="sourceLineNo">120</span> return computeIfAbsent(userQuotaCache, ugi.getShortUserName(), UserQuotaState::new,<a name="line.120"></a> -<span class="sourceLineNo">121</span> this::triggerCacheRefresh);<a name="line.121"></a> -<span class="sourceLineNo">122</span> }<a name="line.122"></a> -<span class="sourceLineNo">123</span><a name="line.123"></a> -<span class="sourceLineNo">124</span> /**<a name="line.124"></a> -<span class="sourceLineNo">125</span> * Returns the limiter associated to the specified table.<a name="line.125"></a> -<span class="sourceLineNo">126</span> *<a name="line.126"></a> -<span class="sourceLineNo">127</span> * @param table the table to limit<a name="line.127"></a> -<span class="sourceLineNo">128</span> * @return the limiter associated to the specified table<a name="line.128"></a> -<span class="sourceLineNo">129</span> */<a name="line.129"></a> -<span class="sourceLineNo">130</span> public QuotaLimiter getTableLimiter(final TableName table) {<a name="line.130"></a> -<span class="sourceLineNo">131</span> return getQuotaState(this.tableQuotaCache, table).getGlobalLimiter();<a name="line.131"></a> -<span class="sourceLineNo">132</span> }<a name="line.132"></a> -<span class="sourceLineNo">133</span><a name="line.133"></a> -<span class="sourceLineNo">134</span> /**<a name="line.134"></a> -<span class="sourceLineNo">135</span> * Returns the limiter associated to the specified namespace.<a name="line.135"></a> -<span class="sourceLineNo">136</span> *<a name="line.136"></a> -<span class="sourceLineNo">137</span> * @param namespace the namespace to limit<a name="line.137"></a> -<span class="sourceLineNo">138</span> * @return the limiter associated to the specified namespace<a name="line.138"></a> -<span class="sourceLineNo">139</span> */<a name="line.139"></a> -<span class="sourceLineNo">140</span> public QuotaLimiter getNamespaceLimiter(final String namespace) {<a name="line.140"></a> -<span class="sourceLineNo">141</span> return getQuotaState(this.namespaceQuotaCache, namespace).getGlobalLimiter();<a name="line.141"></a> -<span class="sourceLineNo">142</span> }<a name="line.142"></a> -<span class="sourceLineNo">143</span><a name="line.143"></a> -<span class="sourceLineNo">144</span> /**<a name="line.144"></a> -<span class="sourceLineNo">145</span> * Returns the QuotaState requested. If the quota info is not in cache an empty one will be<a name="line.145"></a> -<span class="sourceLineNo">146</span> * returned and the quota request will be enqueued for the next cache refresh.<a name="line.146"></a> -<span class="sourceLineNo">147</span> */<a name="line.147"></a> -<span class="sourceLineNo">148</span> private <K> QuotaState getQuotaState(final ConcurrentHashMap<K, QuotaState> quotasMap,<a name="line.148"></a> -<span class="sourceLineNo">149</span> final K key) {<a name="line.149"></a> -<span class="sourceLineNo">150</span> return computeIfAbsent(quotasMap, key, QuotaState::new, this::triggerCacheRefresh);<a name="line.150"></a> -<span class="sourceLineNo">151</span> }<a name="line.151"></a> -<span class="sourceLineNo">152</span><a name="line.152"></a> -<span class="sourceLineNo">153</span> @VisibleForTesting<a name="line.153"></a> -<span class="sourceLineNo">154</span> void triggerCacheRefresh() {<a name="line.154"></a> -<span class="sourceLineNo">155</span> refreshChore.triggerNow();<a name="line.155"></a> -<span class="sourceLineNo">156</span> }<a name="line.156"></a> -<span class="sourceLineNo">157</span><a name="line.157"></a> -<span class="sourceLineNo">158</span> @VisibleForTesting<a name="line.158"></a> -<span class="sourceLineNo">159</span> long getLastUpdate() {<a name="line.159"></a> -<span class="sourceLineNo">160</span> return refreshChore.lastUpdate;<a name="line.160"></a> -<span class="sourceLineNo">161</span> }<a name="line.161"></a> -<span class="sourceLineNo">162</span><a name="line.162"></a> -<span class="sourceLineNo">163</span> @VisibleForTesting<a name="line.163"></a> -<span class="sourceLineNo">164</span> Map<String, QuotaState> getNamespaceQuotaCache() {<a name="line.164"></a> -<span class="sourceLineNo">165</span> return namespaceQuotaCache;<a name="line.165"></a> -<span class="sourceLineNo">166</span> }<a name="line.166"></a> -<span class="sourceLineNo">167</span><a name="line.167"></a> -<span class="sourceLineNo">168</span> @VisibleForTesting<a name="line.168"></a> -<span class="sourceLineNo">169</span> Map<TableName, QuotaState> getTableQuotaCache() {<a name="line.169"></a> -<span class="sourceLineNo">170</span> return tableQuotaCache;<a name="line.170"></a> -<span class="sourceLineNo">171</span> }<a name="line.171"></a> -<span class="sourceLineNo">172</span><a name="line.172"></a> -<span class="sourceLineNo">173</span> @VisibleForTesting<a name="line.173"></a> -<span class="sourceLineNo">174</span> Map<String, UserQuotaState> getUserQuotaCache() {<a name="line.174"></a> -<span class="sourceLineNo">175</span> return userQuotaCache;<a name="line.175"></a> -<span class="sourceLineNo">176</span> }<a name="line.176"></a> -<span class="sourceLineNo">177</span><a name="line.177"></a> -<span class="sourceLineNo">178</span> // TODO: Remove this once we have the notification bus<a name="line.178"></a> -<span class="sourceLineNo">179</span> private class QuotaRefresherChore extends ScheduledChore {<a name="line.179"></a> -<span class="sourceLineNo">180</span> private long lastUpdate = 0;<a name="line.180"></a> -<span class="sourceLineNo">181</span><a name="line.181"></a> -<span class="sourceLineNo">182</span> public QuotaRefresherChore(final int period, final Stoppable stoppable) {<a name="line.182"></a> -<span class="sourceLineNo">183</span> super("QuotaRefresherChore", stoppable, period);<a name="line.183"></a> -<span class="sourceLineNo">184</span> }<a name="line.184"></a> -<span class="sourceLineNo">185</span><a name="line.185"></a> -<span class="sourceLineNo">186</span> @Override<a name="line.186"></a> -<span class="sourceLineNo">187</span> @edu.umd.cs.findbugs.annotations.SuppressWarnings(value="GC_UNRELATED_TYPES",<a name="line.187"></a> -<span class="sourceLineNo">188</span> justification="I do not understand why the complaints, it looks good to me -- FIX")<a name="line.188"></a> -<span class="sourceLineNo">189</span> protected void chore() {<a name="line.189"></a> -<span class="sourceLineNo">190</span> // Prefetch online tables/namespaces<a name="line.190"></a> -<span class="sourceLineNo">191</span> for (TableName table: QuotaCache.this.rsServices.getOnlineTables()) {<a name="line.191"></a> -<span class="sourceLineNo">192</span> if (table.isSystemTable()) continue;<a name="line.192"></a> -<span class="sourceLineNo">193</span> if (!QuotaCache.this.tableQuotaCache.containsKey(table)) {<a name="line.193"></a> -<span class="sourceLineNo">194</span> QuotaCache.this.tableQuotaCache.putIfAbsent(table, new QuotaState());<a name="line.194"></a> -<span class="sourceLineNo">195</span> }<a name="line.195"></a> -<span class="sourceLineNo">196</span> String ns = table.getNamespaceAsString();<a name="line.196"></a> -<span class="sourceLineNo">197</span> if (!QuotaCache.this.namespaceQuotaCache.containsKey(ns)) {<a name="line.197"></a> -<span class="sourceLineNo">198</span> QuotaCache.this.namespaceQuotaCache.putIfAbsent(ns, new QuotaState());<a name="line.198"></a> -<span class="sourceLineNo">199</span> }<a name="line.199"></a> -<span class="sourceLineNo">200</span> }<a name="line.200"></a> -<span class="sourceLineNo">201</span><a name="line.201"></a> -<span class="sourceLineNo">202</span> fetchNamespaceQuotaState();<a name="line.202"></a> -<span class="sourceLineNo">203</span> fetchTableQuotaState();<a name="line.203"></a> -<span class="sourceLineNo">204</span> fetchUserQuotaState();<a name="line.204"></a> -<span class="sourceLineNo">205</span> lastUpdate = EnvironmentEdgeManager.currentTime();<a name="line.205"></a> -<span class="sourceLineNo">206</span> }<a name="line.206"></a> -<span class="sourceLineNo">207</span><a name="line.207"></a> -<span class="sourceLineNo">208</span> private void fetchNamespaceQuotaState() {<a name="line.208"></a> -<span class="sourceLineNo">209</span> fetch("namespace", QuotaCache.this.namespaceQuotaCache, new Fetcher<String, QuotaState>() {<a name="line.209"></a> -<span class="sourceLineNo">210</span> @Override<a name="line.210"></a> -<span class="sourceLineNo">211</span> public Get makeGet(final Map.Entry<String, QuotaState> entry) {<a name="line.211"></a> -<span class="sourceLineNo">212</span> return QuotaUtil.makeGetForNamespaceQuotas(entry.getKey());<a name="line.212"></a> -<span class="sourceLineNo">213</span> }<a name="line.213"></a> -<span class="sourceLineNo">214</span><a name="line.214"></a> -<span class="sourceLineNo">215</span> @Override<a name="line.215"></a> -<span class="sourceLineNo">216</span> public Map<String, QuotaState> fetchEntries(final List<Get> gets)<a name="line.216"></a> -<span class="sourceLineNo">217</span> throws IOException {<a name="line.217"></a> -<span class="sourceLineNo">218</span> return QuotaUtil.fetchNamespaceQuotas(rsServices.getConnection(), gets);<a name="line.218"></a> -<span class="sourceLineNo">219</span> }<a name="line.219"></a> -<span class="sourceLineNo">220</span> });<a name="line.220"></a> -<span class="sourceLineNo">221</span> }<a name="line.221"></a> -<span class="sourceLineNo">222</span><a name="line.222"></a> -<span class="sourceLineNo">223</span> private void fetchTableQuotaState() {<a name="line.223"></a> -<span class="sourceLineNo">224</span> fetch("table", QuotaCache.this.tableQuotaCache, new Fetcher<TableName, QuotaState>() {<a name="line.224"></a> -<span class="sourceLineNo">225</span> @Override<a name="line.225"></a> -<span class="sourceLineNo">226</span> public Get makeGet(final Map.Entry<TableName, QuotaState> entry) {<a name="line.226"></a> -<span class="sourceLineNo">227</span> return QuotaUtil.makeGetForTableQuotas(entry.getKey());<a name="line.227"></a> -<span class="sourceLineNo">228</span> }<a name="line.228"></a> -<span class="sourceLineNo">229</span><a name="line.229"></a> -<span class="sourceLineNo">230</span> @Override<a name="line.230"></a> -<span class="sourceLineNo">231</span> public Map<TableName, QuotaState> fetchEntries(final List<Get> gets)<a name="line.231"></a> -<span class="sourceLineNo">232</span> throws IOException {<a name="line.232"></a> -<span class="sourceLineNo">233</span> return QuotaUtil.fetchTableQuotas(rsServices.getConnection(), gets);<a name="line.233"></a> -<span class="sourceLineNo">234</span> }<a name="line.234"></a> -<span class="sourceLineNo">235</span> });<a name="line.235"></a> -<span class="sourceLineNo">236</span> }<a name="line.236"></a> -<span class="sourceLineNo">237</span><a name="line.237"></a> -<span class="sourceLineNo">238</span> private void fetchUserQuotaState() {<a name="line.238"></a> -<span class="sourceLineNo">239</span> final Set<String> namespaces = QuotaCache.this.namespaceQuotaCache.keySet();<a name="line.239"></a> -<span class="sourceLineNo">240</span> final Set<TableName> tables = QuotaCache.this.tableQuotaCache.keySet();<a name="line.240"></a> -<span class="sourceLineNo">241</span> fetch("user", QuotaCache.this.userQuotaCache, new Fetcher<String, UserQuotaState>() {<a name="line.241"></a> -<span class="sourceLineNo">242</span> @Override<a name="line.242"></a> -<span class="sourceLineNo">243</span> public Get makeGet(final Map.Entry<String, UserQuotaState> entry) {<a name="line.243"></a> -<span class="sourceLineNo">244</span> return QuotaUtil.makeGetForUserQuotas(entry.getKey(), tables, namespaces);<a name="line.244"></a> -<span class="sourceLineNo">245</span> }<a name="line.245"></a> -<span class="sourceLineNo">246</span><a name="line.246"></a> -<span class="sourceLineNo">247</span> @Override<a name="line.247"></a> -<span class="sourceLineNo">248</span> public Map<String, UserQuotaState> fetchEntries(final List<Get> gets)<a name="line.248"></a> -<span class="sourceLineNo">249</span> throws IOException {<a name="line.249"></a> -<span class="sourceLineNo">250</span> return QuotaUtil.fetchUserQuotas(rsServices.getConnection(), gets);<a name="line.250"></a> -<span class="sourceLineNo">251</span> }<a name="line.251"></a> -<span class="sourceLineNo">252</span> });<a name="line.252"></a> -<span class="sourceLineNo">253</span> }<a name="line.253"></a> -<span class="sourceLineNo">254</span><a name="line.254"></a> -<span class="sourceLineNo">255</span> private <K, V extends QuotaState> void fetch(final String type,<a name="line.255"></a> -<span class="sourceLineNo">256</span> final ConcurrentHashMap<K, V> quotasMap, final Fetcher<K, V> fetcher) {<a name="line.256"></a> -<span class="sourceLineNo">257</span> long now = EnvironmentEdgeManager.currentTime();<a name="line.257"></a> -<span class="sourceLineNo">258</span> long refreshPeriod = getPeriod();<a name="line.258"></a> -<span class="sourceLineNo">259</span> long evictPeriod = refreshPeriod * EVICT_PERIOD_FACTOR;<a name="line.259"></a> -<span class="sourceLineNo">260</span><a name="line.260"></a> -<span class="sourceLineNo">261</span> // Find the quota entries to update<a name="line.261"></a> -<span class="sourceLineNo">262</span> List<Get> gets = new ArrayList<>();<a name="line.262"></a> -<span class="sourceLineNo">263</span> List<K> toRemove = new ArrayList<>();<a name="line.263"></a> -<span class="sourceLineNo">264</span> for (Map.Entry<K, V> entry: quotasMap.entrySet()) {<a name="line.264"></a> -<span class="sourceLineNo">265</span> long lastUpdate = entry.getValue().getLastUpdate();<a name="line.265"></a> -<span class="sourceLineNo">266</span> long lastQuery = entry.getValue().getLastQuery();<a name="line.266"></a> -<span class="sourceLineNo">267</span> if (lastQuery > 0 && (now - lastQuery) >= evictPeriod) {<a name="line.267"></a> -<span class="sourceLineNo">268</span> toRemove.add(entry.getKey());<a name="line.268"></a> -<span class="sourceLineNo">269</span> } else if (TEST_FORCE_REFRESH || (now - lastUpdate) >= refreshPeriod) {<a name="line.269"></a> -<span class="sourceLineNo">270</span> gets.add(fetcher.makeGet(entry));<a name="line.270"></a> -<span class="sourceLineNo">271</span> }<a name="line.271"></a> -<span class="sourceLineNo">272</span> }<a name="line.272"></a> -<span class="sourceLineNo">273</span><a name="line.273"></a> -<span class="sourceLineNo">274</span> for (final K key: toRemove) {<a name="line.274"></a> -<span class="sourceLineNo">275</span> if (LOG.isTraceEnabled()) {<a name="line.275"></a> -<span class="sourceLineNo">276</span> LOG.trace("evict " + type + " key=" + key);<a name="line.276"></a> -<span class="sourceLineNo">277</span> }<a name="line.277"></a> -<span class="sourceLineNo">278</span> quotasMap.remove(key);<a name="line.278"></a> -<span class="sourceLineNo">279</span> }<a name="line.279"></a> -<span class="sourceLineNo">280</span><a name="line.280"></a> -<span class="sourceLineNo">281</span> // fetch and update the quota entries<a name="line.281"></a> -<span class="sourceLineNo">282</span> if (!gets.isEmpty()) {<a name="line.282"></a> -<span class="sourceLineNo">283</span> try {<a name="line.283"></a> -<span class="sourceLineNo">284</span> for (Map.Entry<K, V> entry: fetcher.fetchEntries(gets).entrySet()) {<a name="line.284"></a> -<span class="sourceLineNo">285</span> V quotaInfo = quotasMap.putIfAbsent(entry.getKey(), entry.getValue());<a name="line.285"></a> -<span class="sourceLineNo">286</span> if (quotaInfo != null) {<a name="line.286"></a> -<span class="sourceLineNo">287</span> quotaInfo.update(entry.getValue());<a name="line.287"></a> -<span class="sourceLineNo">288</span> }<a name="line.288"></a> -<span class="sourceLineNo">289</span><a name="line.289"></a> -<span class="sourceLineNo">290</span> if (LOG.isTraceEnabled()) {<a name="line.290"></a> -<span class="sourceLineNo">291</span> LOG.trace("refresh " + type + " key=" + entry.getKey() + " quotas=" + quotaInfo);<a name="line.291"></a> -<span class="sourceLineNo">292</span> }<a name="line.292"></a> -<span class="sourceLineNo">293</span> }<a name="line.293"></a> -<span class="sourceLineNo">294</span> } catch (IOException e) {<a name="line.294"></a> -<span class="sourceLineNo">295</span> LOG.warn("Unable to read " + type + " from quota table", e);<a name="line.295"></a> -<span class="sourceLineNo">296</span> }<a name="line.296"></a> -<span class="sourceLineNo">297</span> }<a name="line.297"></a> -<span class="sourceLineNo">298</span> }<a name="line.298"></a> -<span class="sourceLineNo">299</span> }<a name="line.299"></a> -<span class="sourceLineNo">300</span><a name="line.300"></a> -<span class="sourceLineNo">301</span> static interface Fetcher<Key, Value> {<a name="line.301"></a> -<span class="sourceLineNo">302</span> Get makeGet(Map.Entry<Key, Value> entry);<a name="line.302"></a> -<span class="sourceLineNo">303</span> Map<Key, Value> fetchEntries(List<Get> gets) throws IOException;<a name="line.303"></a> -<span class="sourceLineNo">304</span> }<a name="line.304"></a> -<span class="sourceLineNo">305</span>}<a name="line.305"></a> +<span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.regionserver.HRegionServer;<a name="line.23"></a> +<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.shaded.com.google.common.annotations.VisibleForTesting;<a name="line.24"></a> +<span class="sourceLineNo">025</span><a name="line.25"></a> +<span class="sourceLineNo">026</span>import java.io.IOException;<a name="line.26"></a> +<span class="sourceLineNo">027</span>import java.util.ArrayList;<a name="line.27"></a> +<span class="sourceLineNo">028</span>import java.util.List;<a name="line.28"></a> +<span class="sourceLineNo">029</span>import java.util.Map;<a name="line.29"></a> +<span class="sourceLineNo">030</span>import java.util.Set;<a name="line.30"></a> +<span class="sourceLineNo">031</span>import java.util.concurrent.ConcurrentHashMap;<a name="line.31"></a> +<span class="sourceLineNo">032</span><a name="line.32"></a> +<span class="sourceLineNo">033</span>import org.apache.commons.logging.Log;<a name="line.33"></a> +<span class="sourceLineNo">034</span>import org.apache.commons.logging.LogFactory;<a name="line.34"></a> +<span class="sourceLineNo">035</span>import org.apache.hadoop.conf.Configuration;<a name="line.35"></a> +<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.ScheduledChore;<a name="line.36"></a> +<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.Stoppable;<a name="line.37"></a> +<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.TableName;<a name="line.38"></a> +<span class="sourceLineNo">039</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.39"></a> +<span class="sourceLineNo">040</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.40"></a> +<span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.client.Get;<a name="line.41"></a> +<span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.regionserver.RegionServerServices;<a name="line.42"></a> +<span class="sourceLineNo">043</span>import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;<a name="line.43"></a> +<span class="sourceLineNo">044</span>import org.apache.hadoop.security.UserGroupInformation;<a name="line.44"></a> +<span class="sourceLineNo">045</span><a name="line.45"></a> +<span class="sourceLineNo">046</span>/**<a name="line.46"></a> +<span class="sourceLineNo">047</span> * Cache that keeps track of the quota settings for the users and tables that<a name="line.47"></a> +<span class="sourceLineNo">048</span> * are interacting with it.<a name="line.48"></a> +<span class="sourceLineNo">049</span> *<a name="line.49"></a> +<span class="sourceLineNo">050</span> * To avoid blocking the operations if the requested quota is not in cache<a name="line.50"></a> +<span class="sourceLineNo">051</span> * an "empty quota" will be returned and the request to fetch the quota information<a name="line.51"></a> +<span class="sourceLineNo">052</span> * will be enqueued for the next refresh.<a name="line.52"></a> +<span class="sourceLineNo">053</span> *<a name="line.53"></a> +<span class="sourceLineNo">054</span> * TODO: At the moment the Cache has a Chore that will be triggered every 5min<a name="line.54"></a> +<span class="sourceLineNo">055</span> * or on cache-miss events. Later the Quotas will be pushed using the notification system.<a name="line.55"></a> +<span class="sourceLineNo">056</span> */<a name="line.56"></a> +<span class="sourceLineNo">057</span>@InterfaceAudience.Private<a name="line.57"></a> +<span class="sourceLineNo">058</span>@InterfaceStability.Evolving<a name="line.58"></a> +<span class="sourceLineNo">059</span>public class QuotaCache implements Stoppable {<a name="line.59"></a> +<span class="sourceLineNo">060</span> private static final Log LOG = LogFactory.getLog(QuotaCache.class);<a name="line.60"></a> +<span class="sourceLineNo">061</span><a name="line.61"></a> +<span class="sourceLineNo">062</span> public static final String REFRESH_CONF_KEY = "hbase.quota.refresh.period";<a name="line.62"></a> +<span class="sourceLineNo">063</span> private static final int REFRESH_DEFAULT_PERIOD = 5 * 60000; // 5min<a name="line.63"></a> +<span class="sourceLineNo">064</span> private static final int EVICT_PERIOD_FACTOR = 5; // N * REFRESH_DEFAULT_PERIOD<a name="line.64"></a> +<span class="sourceLineNo">065</span><a name="line.65"></a> +<span class="sourceLineNo">066</span> // for testing purpose only, enforce the cache to be always refreshed<a name="line.66"></a> +<span class="sourceLineNo">067</span> static boolean TEST_FORCE_REFRESH = false;<a name="line.67"></a> +<span class="sourceLineNo">068</span><a name="line.68"></a> +<span class="sourceLineNo">069</span> private final ConcurrentHashMap<String, QuotaState> namespaceQuotaCache = new ConcurrentHashMap<>();<a name="line.69"></a> +<span class="sourceLineNo">070</span> private final ConcurrentHashMap<TableName, QuotaState> tableQuotaCache = new ConcurrentHashMap<>();<a name="line.70"></a> +<span class="sourceLineNo">071</span> private final ConcurrentHashMap<String, UserQuotaState> userQuotaCache = new ConcurrentHashMap<>();<a name="line.71"></a> +<span class="sourceLineNo">072</span> private final RegionServerServices rsServices;<a name="line.72"></a> +<span class="sourceLineNo">073</span><a name="line.73"></a> +<span class="sourceLineNo">074</span> private QuotaRefresherChore refreshChore;<a name="line.74"></a> +<span class="sourceLineNo">075</span> private boolean stopped = true;<a name="line.75"></a> +<span class="sourceLineNo">076</span><a name="line.76"></a> +<span class="sourceLineNo">077</span> public QuotaCache(final RegionServerServices rsServices) {<a name="line.77"></a> +<span class="sourceLineNo">078</span> this.rsServices = rsServices;<a name="line.78"></a> +<span class="sourceLineNo">079</span> }<a name="line.79"></a> +<span class="sourceLineNo">080</span><a name="line.80"></a> +<span class="sourceLineNo">081</span> public void start() throws IOException {<a name="line.81"></a> +<span class="sourceLineNo">082</span> stopped = false;<a name="line.82"></a> +<span class="sourceLineNo">083</span><a name="line.83"></a> +<span class="sourceLineNo">084</span> // TODO: This will be replaced once we have the notification bus ready.<a name="line.84"></a> +<span class="sourceLineNo">085</span> Configuration conf = rsServices.getConfiguration();<a name="line.85"></a> +<span class="sourceLineNo">086</span> int period = conf.getInt(REFRESH_CONF_KEY, REFRESH_DEFAULT_PERIOD);<a name="line.86"></a> +<span class="sourceLineNo">087</span> refreshChore = new QuotaRefresherChore(period, this);<a name="line.87"></a> +<span class="sourceLineNo">088</span> rsServices.getChoreService().scheduleChore(refreshChore);<a name="line.88"></a> +<span class="sourceLineNo">089</span> }<a name="line.89"></a> +<span class="sourceLineNo">090</span><a name="line.90"></a> +<span class="sourceLineNo">091</span> @Override<a name="line.91"></a> +<span class="sourceLineNo">092</span> public void stop(final String why) {<a name="line.92"></a> +<span class="sourceLineNo">093</span> stopped = true;<a name="line.93"></a> +<span class="sourceLineNo">094</span> }<a name="line.94"></a> +<span class="sourceLineNo">095</span><a name="line.95"></a> +<span class="sourceLineNo">096</span> @Override<a name="line.96"></a> +<span class="sourceLineNo">097</span> public boolean isStopped() {<a name="line.97"></a> +<span class="sourceLineNo">098</span> return stopped;<a name="line.98"></a> +<span class="sourceLineNo">099</span> }<a name="line.99"></a> +<span class="sourceLineNo">100</span><a name="line.100"></a> +<span class="sourceLineNo">101</span> /**<a name="line.101"></a> +<span class="sourceLineNo">102</span> * Returns the limiter associated to the specified user/table.<a name="line.102"></a> +<span class="sourceLineNo">103</span> *<a name="line.103"></a> +<span class="sourceLineNo">104</span> * @param ugi the user to limit<a name="line.104"></a> +<span class="sourceLineNo">105</span> * @param table the table to limit<a name="line.105"></a> +<span class="sourceLineNo">106</span> * @return the limiter associated to the specified user/table<a name="line.106"></a> +<span class="sourceLineNo">107</span> */<a name="line.107"></a> +<span class="sourceLineNo">108</span> public QuotaLimiter getUserLimiter(final UserGroupInformation ugi, final TableName table) {<a name="line.108"></a> +<span class="sourceLineNo">109</span> if (table.isSystemTable()) {<a name="line.109"></a> +<span class="sourceLineNo">110</span> return NoopQuotaLimiter.get();<a name="line.110"></a> +<span class="sourceLineNo">111</span> }<a name="line.111"></a> +<span class="sourceLineNo">112</span> return getUserQuotaState(ugi).getTableLimiter(table);<a name="line.112"></a> +<span class="sourceLineNo">113</span> }<a name="line.113"></a> +<span class="sourceLineNo">114</span><a name="line.114"></a> +<span class="sourceLineNo">115</span> /**<a name="line.115"></a> +<span class="sourceLineNo">116</span> * Returns the QuotaState associated to the specified user.<a name="line.116"></a> +<span class="sourceLineNo">117</span> * @param ugi the user<a name="line.117"></a> +<span class="sourceLineNo">118</span> * @return the quota info associated to specified user<a name="line.118"></a> +<span class="sourceLineNo">119</span> */<a name="line.119"></a> +<span class="sourceLineNo">120</span> public UserQuotaState getUserQuotaState(final UserGroupInformation ugi) {<a name="line.120"></a> +<span class="sourceLineNo">121</span> return computeIfAbsent(userQuotaCache, ugi.getShortUserName(), UserQuotaState::new,<a name="line.121"></a> +<span class="sourceLineNo">122</span> this::triggerCacheRefresh);<a name="line.122"></a> +<span class="sourceLineNo">123</span> }<a name="line.123"></a> +<span class="sourceLineNo">124</span><a name="line.124"></a> +<span class="sourceLineNo">125</span> /**<a name="line.125"></a> +<span class="sourceLineNo">126</span> * Returns the limiter associated to the specified table.<a name="line.126"></a> +<span class="sourceLineNo">127</span> *<a name="line.127"></a> +<span class="sourceLineNo">128</span> * @param table the table to limit<a name="line.128"></a> +<span class="sourceLineNo">129</span> * @return the limiter associated to the specified table<a name="line.129"></a> +<span class="sourceLineNo">130</span> */<a name="line.130"></a> +<span class="sourceLineNo">131</span> public QuotaLimiter getTableLimiter(final TableName table) {<a name="line.131"></a> +<span class="sourceLineNo">132</span> return getQuotaState(this.tableQuotaCache, table).getGlobalLimiter();<a name="line.132"></a> +<span class="sourceLineNo">133</span> }<a name="line.133"></a> +<span class="sourceLineNo">134</span><a name="line.134"></a> +<span class="sourceLineNo">135</span> /**<a name="line.135"></a> +<span class="sourceLineNo">136</span> * Returns the limiter associated to the specified namespace.<a name="line.136"></a> +<span class="sourceLineNo">137</span> *<a name="line.137"></a> +<span class="sourceLineNo">138</span> * @param namespace the namespace to limit<a name="line.138"></a> +<span class="sourceLineNo">139</span> * @return the limiter associated to the specified namespace<a name="line.139"></a> +<span class="sourceLineNo">140</span> */<a name="line.140"></a> +<span class="sourceLineNo">141</span> public QuotaLimiter getNamespaceLimiter(final String namespace) {<a name="line.141"></a> +<span class="sourceLineNo">142</span> return getQuotaState(this.namespaceQuotaCache, namespace).getGlobalLimiter();<a name="line.142"></a> +<span class="sourceLineNo">143</span> }<a name="line.143"></a> +<span class="sourceLineNo">144</span><a name="line.144"></a> +<span class="sourceLineNo">145</span> /**<a name="line.145"></a> +<span class="sourceLineNo">146</span> * Returns the QuotaState requested. If the quota info is not in cache an empty one will be<a name="line.146"></a> +<span class="sourceLineNo">147</span> * returned and the quota request will be enqueued for the next cache refresh.<a name="line.147"></a> +<span class="sourceLineNo">148</span> */<a name="line.148"></a> +<span class="sourceLineNo">149</span> private <K> QuotaState getQuotaState(final ConcurrentHashMap<K, QuotaState> quotasMap,<a name="line.149"></a> +<span class="sourceLineNo">150</span> final K key) {<a name="line.150"></a> +<span class="sourceLineNo">151</span> return computeIfAbsent(quotasMap, key, QuotaState::new, this::triggerCacheRefresh);<a name="line.151"></a> +<span class="sourceLineNo">152</span> }<a name="line.152"></a> +<span class="sourceLineNo">153</span><a name="line.153"></a> +<span class="sourceLineNo">154</span> @VisibleForTesting<a name="line.154"></a> +<span class="sourceLineNo">155</span> void triggerCacheRefresh() {<a name="line.155"></a> +<span class="sourceLineNo">156</span> refreshChore.triggerNow();<a name="line.156"></a> +<span class="sourceLineNo">157</span> }<a name="line.157"></a> +<span class="sourceLineNo">158</span><a name="line.158"></a> +<span class="sourceLineNo">159</span> @VisibleForTesting<a name="line.159"></a> +<span class="sourceLineNo">160</span> long getLastUpdate() {<a name="line.160"></a> +<span class="sourceLineNo">161</span> return refreshChore.lastUpdate;<a name="line.161"></a> +<span class="sourceLineNo">162</span> }<a name="line.162"></a> +<span class="sourceLineNo">163</span><a name="line.163"></a> +<span class="sourceLineNo">164</span> @VisibleForTesting<a name="line.164"></a> +<span class="sourceLineNo">165</span> Map<String, QuotaState> getNamespaceQuotaCache() {<a name="line.165"></a> +<span class="sourceLineNo">166</span> return namespaceQuotaCache;<a name="line.166"></a> +<span class="sourceLineNo">167</span> }<a name="line.167"></a> +<span class="sourceLineNo">168</span><a name="line.168"></a> +<span class="sourceLineNo">169</span> @VisibleForTesting<a name="line.169"></a> +<span class="sourceLineNo">170</span> Map<TableName, QuotaState> getTableQuotaCache() {<a name="line.170"></a> +<span class="sourceLineNo">171</span> return tableQuotaCache;<a name="line.171"></a> +<span class="sourceLineNo">172</span> }<a name="line.172"></a> +<span class="sourceLineNo">173</span><a name="line.173"></a> +<span class="sourceLineNo">174</span> @VisibleForTesting<a name="line.174"></a> +<span class="sourceLineNo">175</span> Map<String, UserQuotaState> getUserQuotaCache() {<a name="line.175"></a> +<span class="sourceLineNo">176</span> return userQuotaCache;<a name="line.176"></a> +<span class="sourceLineNo">177</span> }<a name="line.177"></a> +<span class="sourceLineNo">178</span><a name="line.178"></a> +<span class="sourceLineNo">179</span> // TODO: Remove this once we have the notification bus<a name="line.179"></a> +<span class="sourceLineNo">180</span> private class QuotaRefresherChore extends ScheduledChore {<a name="line.180"></a> +<span class="sourceLineNo">181</span> private long lastUpdate = 0;<a name="line.181"></a> +<span class="sourceLineNo">182</span><a name="line.182"></a> +<span class="sourceLineNo">183</span> public QuotaRefresherChore(final int period, final Stoppable stoppable) {<a name="line.183"></a> +<span class="sourceLineNo">184</span> super("QuotaRefresherChore", stoppable, period);<a name="line.184"></a> +<span class="sourceLineNo">185</span> }<a name="line.185"></a> +<span class="sourceLineNo">186</span><a name="line.186"></a> +<span class="sourceLineNo">187</span> @Override<a name="line.187"></a> +<span class="sourceLineNo">188</span> @edu.umd.cs.findbugs.annotations.SuppressWarnings(value="GC_UNRELATED_TYPES",<a name="line.188"></a> +<span class="sourceLineNo">189</span> justification="I do not understand why the complaints, it looks good to me -- FIX")<a name="line.189"></a> +<span class="sourceLineNo">190</span> protected void chore() {<a name="line.190"></a> +<span class="sourceLineNo">191</span> // Prefetch online tables/namespaces<a name="line.191"></a> +<span class="sourceLineNo">192</span> for (TableName table: ((HRegionServer)QuotaCache.this.rsServices).getOnlineTables()) {<a name="line.192"></a> +<span class="sourceLineNo">193</span> if (table.isSystemTable()) continue;<a name="line.193"></a> +<span class="sourceLineNo">194</span> if (!QuotaCache.this.tableQuotaCache.containsKey(table)) {<a name="line.194"></a> +<span class="sourceLineNo">195</span> QuotaCache.this.tableQuotaCache.putIfAbsent(table, new QuotaState());<a name="line.195"></a> +<span class="sourceLineNo">196</span> }<a name="line.196"></a> +<span class="sourceLineNo">197</span> String ns = table.getNamespaceAsString();<a name="line.197"></a> +<span class="sourceLineNo">198</span> if (!QuotaCache.this.namespaceQuotaCache.containsKey(ns)) {<a name="line.198"></a> +<span class="sourceLineNo">199</span> QuotaCache.this.namespaceQuotaCache.putIfAbsent(ns, new QuotaState());<a name="line.199"></a> +<span class="sourceLineNo">200</span> }<a name="line.200"></a> +<span class="sourceLineNo">201</span> }<a name="line.201"></a> +<span class="sourceLineNo">202</span><a name="line.202"></a> +<span class="sourceLineNo">203</span> fetchNamespaceQuotaState();<a name="line.203"></a> +<span class="sourceLineNo">204</span> fetchTableQuotaState();<a name="line.204"></a> +<span class="sourceLineNo">205</span> fetchUserQuotaState();<a name="line.205"></a> +<span class="sourceLineNo">206</span> lastUpdate = EnvironmentEdgeManager.currentTime();<a name="line.206"></a> +<span class="sourceLineNo">207</span> }<a name="line.207"></a> +<span class="sourceLineNo">208</span><a name="line.208"></a> +<span class="sourceLineNo">209</span> private void fetchNamespaceQuotaState() {<a name="line.209"></a> +<span class="sourceLineNo">210</span> fetch("namespace", QuotaCache.this.namespaceQuotaCache, new Fetcher<String, QuotaState>() {<a name="line.210"></a> +<span class="sourceLineNo">211</span> @Override<a name="line.211"></a> +<span class="sourceLineNo">212</span> public Get makeGet(final Map.Entry<String, QuotaState> entry) {<a name="line.212"></a> +<span class="sourceLineNo">213</span> return QuotaUtil.makeGetForNamespaceQuotas(entry.getKey());<a name="line.213"></a> +<span class="sourceLineNo">214</span> }<a name="line.214"></a> +<span class="sourceLineNo">215</span><a name="line.215"></a> +<span class="sourceLineNo">216</span> @Override<a name="line.216"></a> +<span class="sourceLineNo">217</span> public Map<String, QuotaState> fetchEntries(final List<Get> gets)<a name="line.217"></a> +<span class="sourceLineNo">218</span> throws IOException {<a name="line.218"></a> +<span class="sourceLineNo">219</span> return QuotaUtil.fetchNamespaceQuotas(rsServices.getConnection(), gets);<a name="line.219"></a> +<span class="sourceLineNo">220</span> }<a name="line.220"></a> +<span class="sourceLineNo">221</span> });<a name="line.221"></a> +<span class="sourceLineNo">222</span> }<a name="line.222"></a> +<span class="sourceLineNo">223</span><a name="line.223"></a> +<span class="sourceLineNo">224</span> private void fetchTableQuotaState() {<a name="line.224"></a> +<span class="sourceLineNo">225</span> fetch("table", QuotaCache.this.tableQuotaCache, new Fetcher<TableName, QuotaState>() {<a name="line.225"></a> +<span class="sourceLineNo">226</span> @Override<a name="line.226"></a> +<span class="sourceLineNo">227</span> public Get makeGet(final Map.Entry<TableName, QuotaState> entry) {<a name="line.227"></a> +<span class="sourceLineNo">228</span> return QuotaUtil.makeGetForTableQuotas(entry.getKey());<a name="line.228"></a> +<span class="sourceLineNo">229</span> }<a name="line.229"></a> +<span class="sourceLineNo">230</span><a name="line.230"></a> +<span class="sourceLineNo">231</span> @Override<a name="line.231"></a> +<span class="sourceLineNo">232</span> public Map<TableName, QuotaState> fetchEntries(final List<Get> gets)<a name="line.232"></a> +<span class="sourceLineNo">233</span> throws IOException {<a name="line.233"></a> +<span class="sourceLineNo">234</span> return QuotaUtil.fetchTableQuotas(rsServices.getConnection(), gets);<a name="line.234"></a> +<span class="sourceLineNo">235</span> }<a name="line.235"></a> +<span class="sourceLineNo">236</span> });<a name="line.236"></a> +<span class="sourceLineNo">237</span> }<a name="line.237"></a> +<span class="sourceLineNo">238</span><a name="line.238"></a> +<span class="sourceLineNo">239</span> private void fetchUserQuotaState() {<a name="line.239"></a> +<span class="sourceLineNo">240</span> final Set<String> namespaces = QuotaCache.this.namespaceQuotaCache.keySet();<a name="line.240"></a> +<span class="sourceLineNo">241</span> final Set<TableName> tables = QuotaCache.this.tableQuotaCache.keySet();<a name="line.241"></a> +<span class="sourceLineNo">242</span> fetch("user", QuotaCache.this.userQuotaCache, new Fetcher<String, UserQuotaState>() {<a name="line.242"></a> +<span class="sourceLineNo">243</span> @Override<a name="line.243"></a> +<span class="sourceLineNo">244</span> public Get makeGet(final Map.Entry<String, UserQuotaState> entry) {<a name="line.244"></a> +<span class="sourceLineNo">245</span> return QuotaUtil.makeGetForUserQuotas(entry.getKey(), tables, namespaces);<a name="line.245"></a> +<span class="sourceLineNo">246</span> }<a name="line.246"></a> +<span class="sourceLineNo">247</span><a name="line.247"></a> +<span class="sourceLineNo">248</span> @Override<a name="line.248"></a> +<span class="sourceLineNo">249</span> public Map<String, UserQuotaState> fetchEntries(final List<Get> gets)<a name="line.249"></a> +<span class="sourceLineNo">250</span> throws IOException {<a name="line.250"></a> +<span class="sourceLineNo">251</span> return QuotaUtil.fetchUserQuotas(rsServices.getConnection(), gets);<a name="line.251"></a> +<span class="sourceLineNo">252</span> }<a name="line.252"></a> +<span class="sourceLineNo">253</span> });<a name="line.253"></a> +<span class="sourceLineNo">254</span> }<a name="line.254"></a> +<span class="sourceLineNo">255</span><a name="line.255"></a> +<span class="sourceLineNo">256</span> private <K, V extends QuotaState> void fetch(final String type,<a name="line.256"></a> +<span class="sourceLineNo">257</span> final ConcurrentHashMap<K, V> quotasMap, final Fetcher<K, V> fetcher) {<a name="line.257"></a> +<span class="sourceLineNo">258</span> long now = EnvironmentEdgeManager.currentTime();<a name="line.258"></a> +<span class="sourceLineNo">259</span> long refreshPeriod = getPeriod();<a name="line.259"></a> +<span class="sourceLineNo">260</span> long evictPeriod = refreshPeriod * EVICT_PERIOD_FACTOR;<a name="line.260"></a> +<span class="sourceLineNo">261</span><a name="line.261"></a> +<span class="sourceLineNo">262</span> // Find the quota entries to update<a name="line.262"></a> +<span class="sourceLineNo">263</span> List<Get> gets = new ArrayList<>();<a name="line.263"></a> +<span class="sourceLineNo">264</span> List<K> toRemove = new ArrayList<>();<a name="line.264"></a> +<span class="sourceLineNo">265</span> for (Map.Entry<K, V> entry: quotasMap.entrySet()) {<a name="line.265"></a> +<span class="sourceLineNo">266</span> long lastUpdate = entry.getValue().getLastUpdate();<a name="line.266"></a> +<span class="sourceLineNo">267</span> long lastQuery = entry.getValue().getLastQuery();<a name="line.267"></a> +<span class="sourceLineNo">268</span> if (lastQuery > 0 && (now - lastQuery) >= evictPeriod) {<a name="line.268"></a> +<span class="sourceLineNo">269</span> toRemove.add(entry.getKey());<a name="line.269"></a> +<span class="sourceLineNo">270</span> } else if (TEST_FORCE_REFRESH || (now - lastUpdate) >= refreshPeriod) {<a name="line.270"></a> +<span class="sourceLineNo">271</span> gets.add(fetcher.makeGet(entry));<a name="line.271"></a> +<span class="sourceLineNo">272</span> }<a name="line.272"></a> +<span class="sourceLineNo">273</span> }<a name="line.273"></a> +<span class="sourceLineNo">274</span><a name="line.274"></a> +<span class="sourceLineNo">275</span> for (final K key: toRemove) {<a name="line.275"></a> +<span class="sourceLineNo">276</span> if (LOG.isTraceEnabled()) {<a name="line.276"></a> +<span class="sourceLineNo">277</span> LOG.trace("evict " + type + " key=" + key);<a name="line.277"></a> +<span class="sourceLineNo">278</span> }<a name="line.278"></a> +<span class="sourceLineNo">279</span> quotasMap.remove(key);<a name="line.279"></a> +<span class="sourceLineNo">280</span> }<a name="line.280"></a> +<span class="sourceLineNo">281</span><a name="line.281"></a> +<span class="sourceLineNo">282</span> // fetch and update the quota entries<a name="line.282"></a> +<span class="sourceLineNo">283</span> if (!gets.isEmpty()) {<a name="line.283"></a> +<span class="sourceLineNo">284</span> try {<a name="line.284"></a> +<span class="sourceLineNo">285</span> for (Map.Entry<K, V> entry: fetcher.fetchEntries(gets).entrySet()) {<a name="line.285"></a> +<span class="sourceLineNo">286</span> V quotaInfo = quotasMap.putIfAbsent(entry.getKey(), entry.getValue());<a name="line.286"></a> +<span class="sourceLineNo">287</span> if (quotaInfo != null) {<a name="line.287"></a> +<span class="sourceLineNo">288</span> quotaInfo.update(entry.getValue());<a name="line.288"></a> +<span class="sourceLineNo">289</span> }<a name="line.289"></a> +<span class="sourceLineNo">290</span><a name="line.290"></a> +<span class="sourceLineNo">291</span> if (LOG.isTraceEnabled()) {<a name="line.291"></a> +<span class="sourceLineNo">292</span> LOG.trace("refresh " + type + " key=" + entry.getKey() + " quotas=" + quotaInfo);<a name="line.292"></a> +<span class="sourceLineNo">293</span> }<a name="line.293"></a> +<span class="sourceLineNo">294</span> }<a name="line.294"></a> +<span class="sourceLineNo">295</span> } catch (IOException e) {<a name="line.295"></a> +<span class="sourceLineNo">296</span> LOG.warn("Unable to read " + type + " from quota table", e);<a name="line.296"></a> +<span class="sourceLineNo">297</span> }<a name="line.297"></a> +<span class="sourceLineNo">298</span> }<a name="line.298"></a> +<span class="sourceLineNo">299</span> }<a name="line.299"></a> +<span class="sourceLineNo">300</span> }<a name="line.300"></a> +<span class="sourceLineNo">301</span><a name="line.301"></a> +<span class="sourceLineNo">302</span> static interface Fetcher<Key, Value> {<a name="line.302"></a> +<span class="sourceLineNo">303</span> Get makeGet(Map.Entry<Key, Value> entry);<a name="line.303"></a> +<span class="sourceLineNo">304</span> Map<Key, Value> fetchEntries(List<Get> gets) throws IOException;<a name="line.304"></a> +<span class="sourceLineNo">305</span> }<a name="line.305"></a> +<span class="sourceLineNo">306</span>}<a name="line.306"></a>
