http://git-wip-us.apache.org/repos/asf/hbase-site/blob/476c54ed/devapidocs/src-html/org/apache/hadoop/hbase/quotas/SnapshotQuotaObserverChore.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/quotas/SnapshotQuotaObserverChore.html b/devapidocs/src-html/org/apache/hadoop/hbase/quotas/SnapshotQuotaObserverChore.html new file mode 100644 index 0000000..b7ca7d9 --- /dev/null +++ b/devapidocs/src-html/org/apache/hadoop/hbase/quotas/SnapshotQuotaObserverChore.html @@ -0,0 +1,615 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<html lang="en"> +<head> +<title>Source code</title> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +</head> +<body> +<div class="sourceContainer"> +<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> +<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> +<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> +<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a> +<span class="sourceLineNo">005</span> * The ASF licenses this file to you under the Apache License, Version 2.0<a name="line.5"></a> +<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> +<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a> +<span class="sourceLineNo">008</span> *<a name="line.8"></a> +<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> +<span class="sourceLineNo">010</span> *<a name="line.10"></a> +<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> +<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> +<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> +<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a> +<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a> +<span class="sourceLineNo">016</span> */<a name="line.16"></a> +<span class="sourceLineNo">017</span>package org.apache.hadoop.hbase.quotas;<a name="line.17"></a> +<span class="sourceLineNo">018</span><a name="line.18"></a> +<span class="sourceLineNo">019</span>import java.io.IOException;<a name="line.19"></a> +<span class="sourceLineNo">020</span>import java.util.ArrayList;<a name="line.20"></a> +<span class="sourceLineNo">021</span>import java.util.Arrays;<a name="line.21"></a> +<span class="sourceLineNo">022</span>import java.util.Collection;<a name="line.22"></a> +<span class="sourceLineNo">023</span>import java.util.Collections;<a name="line.23"></a> +<span class="sourceLineNo">024</span>import java.util.HashSet;<a name="line.24"></a> +<span class="sourceLineNo">025</span>import java.util.List;<a name="line.25"></a> +<span class="sourceLineNo">026</span>import java.util.Map;<a name="line.26"></a> +<span class="sourceLineNo">027</span>import java.util.Map.Entry;<a name="line.27"></a> +<span class="sourceLineNo">028</span>import java.util.Objects;<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.TimeUnit;<a name="line.30"></a> +<span class="sourceLineNo">031</span>import java.util.function.Predicate;<a name="line.31"></a> +<span class="sourceLineNo">032</span>import java.util.stream.Collectors;<a name="line.32"></a> +<span class="sourceLineNo">033</span><a name="line.33"></a> +<span class="sourceLineNo">034</span>import org.apache.commons.lang.builder.HashCodeBuilder;<a name="line.34"></a> +<span class="sourceLineNo">035</span>import org.apache.commons.logging.Log;<a name="line.35"></a> +<span class="sourceLineNo">036</span>import org.apache.commons.logging.LogFactory;<a name="line.36"></a> +<span class="sourceLineNo">037</span>import org.apache.hadoop.conf.Configuration;<a name="line.37"></a> +<span class="sourceLineNo">038</span>import org.apache.hadoop.fs.FileStatus;<a name="line.38"></a> +<span class="sourceLineNo">039</span>import org.apache.hadoop.fs.FileSystem;<a name="line.39"></a> +<span class="sourceLineNo">040</span>import org.apache.hadoop.fs.Path;<a name="line.40"></a> +<span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.HRegionInfo;<a name="line.41"></a> +<span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.ScheduledChore;<a name="line.42"></a> +<span class="sourceLineNo">043</span>import org.apache.hadoop.hbase.Stoppable;<a name="line.43"></a> +<span class="sourceLineNo">044</span>import org.apache.hadoop.hbase.TableName;<a name="line.44"></a> +<span class="sourceLineNo">045</span>import org.apache.hadoop.hbase.classification.InterfaceAudience;<a name="line.45"></a> +<span class="sourceLineNo">046</span>import org.apache.hadoop.hbase.client.Admin;<a name="line.46"></a> +<span class="sourceLineNo">047</span>import org.apache.hadoop.hbase.client.Connection;<a name="line.47"></a> +<span class="sourceLineNo">048</span>import org.apache.hadoop.hbase.client.Table;<a name="line.48"></a> +<span class="sourceLineNo">049</span>import org.apache.hadoop.hbase.master.HMaster;<a name="line.49"></a> +<span class="sourceLineNo">050</span>import org.apache.hadoop.hbase.master.MetricsMaster;<a name="line.50"></a> +<span class="sourceLineNo">051</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription;<a name="line.51"></a> +<span class="sourceLineNo">052</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotRegionManifest;<a name="line.52"></a> +<span class="sourceLineNo">053</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotRegionManifest.FamilyFiles;<a name="line.53"></a> +<span class="sourceLineNo">054</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotRegionManifest.StoreFile;<a name="line.54"></a> +<span class="sourceLineNo">055</span>import org.apache.hadoop.hbase.snapshot.SnapshotDescriptionUtils;<a name="line.55"></a> +<span class="sourceLineNo">056</span>import org.apache.hadoop.hbase.snapshot.SnapshotManifest;<a name="line.56"></a> +<span class="sourceLineNo">057</span>import org.apache.hadoop.hbase.util.FSUtils;<a name="line.57"></a> +<span class="sourceLineNo">058</span>import org.apache.hadoop.hbase.util.HFileArchiveUtil;<a name="line.58"></a> +<span class="sourceLineNo">059</span>import org.apache.hadoop.util.StringUtils;<a name="line.59"></a> +<span class="sourceLineNo">060</span><a name="line.60"></a> +<span class="sourceLineNo">061</span>import com.google.common.collect.HashMultimap;<a name="line.61"></a> +<span class="sourceLineNo">062</span>import com.google.common.collect.Multimap;<a name="line.62"></a> +<span class="sourceLineNo">063</span><a name="line.63"></a> +<span class="sourceLineNo">064</span>/**<a name="line.64"></a> +<span class="sourceLineNo">065</span> * A Master-invoked {@code Chore} that computes the size of each snapshot which was created from<a name="line.65"></a> +<span class="sourceLineNo">066</span> * a table which has a space quota.<a name="line.66"></a> +<span class="sourceLineNo">067</span> */<a name="line.67"></a> +<span class="sourceLineNo">068</span>@InterfaceAudience.Private<a name="line.68"></a> +<span class="sourceLineNo">069</span>public class SnapshotQuotaObserverChore extends ScheduledChore {<a name="line.69"></a> +<span class="sourceLineNo">070</span> private static final Log LOG = LogFactory.getLog(SnapshotQuotaObserverChore.class);<a name="line.70"></a> +<span class="sourceLineNo">071</span> static final String SNAPSHOT_QUOTA_CHORE_PERIOD_KEY =<a name="line.71"></a> +<span class="sourceLineNo">072</span> "hbase.master.quotas.snapshot.chore.period";<a name="line.72"></a> +<span class="sourceLineNo">073</span> static final int SNAPSHOT_QUOTA_CHORE_PERIOD_DEFAULT = 1000 * 60 * 5; // 5 minutes in millis<a name="line.73"></a> +<span class="sourceLineNo">074</span><a name="line.74"></a> +<span class="sourceLineNo">075</span> static final String SNAPSHOT_QUOTA_CHORE_DELAY_KEY =<a name="line.75"></a> +<span class="sourceLineNo">076</span> "hbase.master.quotas.snapshot.chore.delay";<a name="line.76"></a> +<span class="sourceLineNo">077</span> static final long SNAPSHOT_QUOTA_CHORE_DELAY_DEFAULT = 1000L * 60L; // 1 minute in millis<a name="line.77"></a> +<span class="sourceLineNo">078</span><a name="line.78"></a> +<span class="sourceLineNo">079</span> static final String SNAPSHOT_QUOTA_CHORE_TIMEUNIT_KEY =<a name="line.79"></a> +<span class="sourceLineNo">080</span> "hbase.master.quotas.snapshot.chore.timeunit";<a name="line.80"></a> +<span class="sourceLineNo">081</span> static final String SNAPSHOT_QUOTA_CHORE_TIMEUNIT_DEFAULT = TimeUnit.MILLISECONDS.name();<a name="line.81"></a> +<span class="sourceLineNo">082</span><a name="line.82"></a> +<span class="sourceLineNo">083</span> private final Connection conn;<a name="line.83"></a> +<span class="sourceLineNo">084</span> private final Configuration conf;<a name="line.84"></a> +<span class="sourceLineNo">085</span> private final MetricsMaster metrics;<a name="line.85"></a> +<span class="sourceLineNo">086</span> private final FileSystem fs;<a name="line.86"></a> +<span class="sourceLineNo">087</span><a name="line.87"></a> +<span class="sourceLineNo">088</span> public SnapshotQuotaObserverChore(HMaster master, MetricsMaster metrics) {<a name="line.88"></a> +<span class="sourceLineNo">089</span> this(<a name="line.89"></a> +<span class="sourceLineNo">090</span> master.getConnection(), master.getConfiguration(), master.getFileSystem(), master, metrics);<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> +<span class="sourceLineNo">093</span> SnapshotQuotaObserverChore(<a name="line.93"></a> +<span class="sourceLineNo">094</span> Connection conn, Configuration conf, FileSystem fs, Stoppable stopper,<a name="line.94"></a> +<span class="sourceLineNo">095</span> MetricsMaster metrics) {<a name="line.95"></a> +<span class="sourceLineNo">096</span> super(<a name="line.96"></a> +<span class="sourceLineNo">097</span> QuotaObserverChore.class.getSimpleName(), stopper, getPeriod(conf),<a name="line.97"></a> +<span class="sourceLineNo">098</span> getInitialDelay(conf), getTimeUnit(conf));<a name="line.98"></a> +<span class="sourceLineNo">099</span> this.conn = conn;<a name="line.99"></a> +<span class="sourceLineNo">100</span> this.conf = conf;<a name="line.100"></a> +<span class="sourceLineNo">101</span> this.metrics = metrics;<a name="line.101"></a> +<span class="sourceLineNo">102</span> this.fs = fs;<a name="line.102"></a> +<span class="sourceLineNo">103</span> }<a name="line.103"></a> +<span class="sourceLineNo">104</span><a name="line.104"></a> +<span class="sourceLineNo">105</span> @Override<a name="line.105"></a> +<span class="sourceLineNo">106</span> protected void chore() {<a name="line.106"></a> +<span class="sourceLineNo">107</span> try {<a name="line.107"></a> +<span class="sourceLineNo">108</span> if (LOG.isTraceEnabled()) {<a name="line.108"></a> +<span class="sourceLineNo">109</span> LOG.trace("Computing sizes of snapshots for quota management.");<a name="line.109"></a> +<span class="sourceLineNo">110</span> }<a name="line.110"></a> +<span class="sourceLineNo">111</span> long start = System.nanoTime();<a name="line.111"></a> +<span class="sourceLineNo">112</span> _chore();<a name="line.112"></a> +<span class="sourceLineNo">113</span> if (null != metrics) {<a name="line.113"></a> +<span class="sourceLineNo">114</span> metrics.incrementSnapshotObserverTime((System.nanoTime() - start) / 1_000_000);<a name="line.114"></a> +<span class="sourceLineNo">115</span> }<a name="line.115"></a> +<span class="sourceLineNo">116</span> } catch (IOException e) {<a name="line.116"></a> +<span class="sourceLineNo">117</span> LOG.warn("Failed to compute the size of snapshots, will retry", e);<a name="line.117"></a> +<span class="sourceLineNo">118</span> }<a name="line.118"></a> +<span class="sourceLineNo">119</span> }<a name="line.119"></a> +<span class="sourceLineNo">120</span><a name="line.120"></a> +<span class="sourceLineNo">121</span> void _chore() throws IOException {<a name="line.121"></a> +<span class="sourceLineNo">122</span> // Gets all tables with quotas that also have snapshots.<a name="line.122"></a> +<span class="sourceLineNo">123</span> // This values are all of the snapshots that we need to compute the size of.<a name="line.123"></a> +<span class="sourceLineNo">124</span> long start = System.nanoTime();<a name="line.124"></a> +<span class="sourceLineNo">125</span> Multimap<TableName,String> snapshotsToComputeSize = getSnapshotsToComputeSize();<a name="line.125"></a> +<span class="sourceLineNo">126</span> if (null != metrics) {<a name="line.126"></a> +<span class="sourceLineNo">127</span> metrics.incrementSnapshotFetchTime((System.nanoTime() - start) / 1_000_000);<a name="line.127"></a> +<span class="sourceLineNo">128</span> }<a name="line.128"></a> +<span class="sourceLineNo">129</span><a name="line.129"></a> +<span class="sourceLineNo">130</span> // For each table, compute the size of each snapshot<a name="line.130"></a> +<span class="sourceLineNo">131</span> Multimap<TableName,SnapshotWithSize> snapshotsWithSize = computeSnapshotSizes(<a name="line.131"></a> +<span class="sourceLineNo">132</span> snapshotsToComputeSize);<a name="line.132"></a> +<span class="sourceLineNo">133</span><a name="line.133"></a> +<span class="sourceLineNo">134</span> // Write the size data to the quota table.<a name="line.134"></a> +<span class="sourceLineNo">135</span> persistSnapshotSizes(snapshotsWithSize);<a name="line.135"></a> +<span class="sourceLineNo">136</span> }<a name="line.136"></a> +<span class="sourceLineNo">137</span><a name="line.137"></a> +<span class="sourceLineNo">138</span> /**<a name="line.138"></a> +<span class="sourceLineNo">139</span> * Fetches each table with a quota (table or namespace quota), and then fetch the name of each<a name="line.139"></a> +<span class="sourceLineNo">140</span> * snapshot which was created from that table.<a name="line.140"></a> +<span class="sourceLineNo">141</span> *<a name="line.141"></a> +<span class="sourceLineNo">142</span> * @return A mapping of table to snapshots created from that table<a name="line.142"></a> +<span class="sourceLineNo">143</span> */<a name="line.143"></a> +<span class="sourceLineNo">144</span> Multimap<TableName,String> getSnapshotsToComputeSize() throws IOException {<a name="line.144"></a> +<span class="sourceLineNo">145</span> Set<TableName> tablesToFetchSnapshotsFrom = new HashSet<>();<a name="line.145"></a> +<span class="sourceLineNo">146</span> QuotaFilter filter = new QuotaFilter();<a name="line.146"></a> +<span class="sourceLineNo">147</span> filter.addTypeFilter(QuotaType.SPACE);<a name="line.147"></a> +<span class="sourceLineNo">148</span> try (Admin admin = conn.getAdmin()) {<a name="line.148"></a> +<span class="sourceLineNo">149</span> // Pull all of the tables that have quotas (direct, or from namespace)<a name="line.149"></a> +<span class="sourceLineNo">150</span> for (QuotaSettings qs : QuotaRetriever.open(conf, filter)) {<a name="line.150"></a> +<span class="sourceLineNo">151</span> String ns = qs.getNamespace();<a name="line.151"></a> +<span class="sourceLineNo">152</span> TableName tn = qs.getTableName();<a name="line.152"></a> +<span class="sourceLineNo">153</span> if ((null == ns && null == tn) || (null != ns && null != tn)) {<a name="line.153"></a> +<span class="sourceLineNo">154</span> throw new IllegalStateException(<a name="line.154"></a> +<span class="sourceLineNo">155</span> "Expected only one of namespace and tablename to be null");<a name="line.155"></a> +<span class="sourceLineNo">156</span> }<a name="line.156"></a> +<span class="sourceLineNo">157</span> // Collect either the table name itself, or all of the tables in the namespace<a name="line.157"></a> +<span class="sourceLineNo">158</span> if (null != ns) {<a name="line.158"></a> +<span class="sourceLineNo">159</span> tablesToFetchSnapshotsFrom.addAll(Arrays.asList(admin.listTableNamesByNamespace(ns)));<a name="line.159"></a> +<span class="sourceLineNo">160</span> } else {<a name="line.160"></a> +<span class="sourceLineNo">161</span> tablesToFetchSnapshotsFrom.add(tn);<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> // Fetch all snapshots that were created from these tables<a name="line.164"></a> +<span class="sourceLineNo">165</span> return getSnapshotsFromTables(admin, tablesToFetchSnapshotsFrom);<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><a name="line.168"></a> +<span class="sourceLineNo">169</span> /**<a name="line.169"></a> +<span class="sourceLineNo">170</span> * Computes a mapping of originating {@code TableName} to snapshots, when the {@code TableName}<a name="line.170"></a> +<span class="sourceLineNo">171</span> * exists in the provided {@code Set}.<a name="line.171"></a> +<span class="sourceLineNo">172</span> */<a name="line.172"></a> +<span class="sourceLineNo">173</span> Multimap<TableName,String> getSnapshotsFromTables(<a name="line.173"></a> +<span class="sourceLineNo">174</span> Admin admin, Set<TableName> tablesToFetchSnapshotsFrom) throws IOException {<a name="line.174"></a> +<span class="sourceLineNo">175</span> Multimap<TableName,String> snapshotsToCompute = HashMultimap.create();<a name="line.175"></a> +<span class="sourceLineNo">176</span> for (org.apache.hadoop.hbase.client.SnapshotDescription sd : admin.listSnapshots()) {<a name="line.176"></a> +<span class="sourceLineNo">177</span> TableName tn = sd.getTableName();<a name="line.177"></a> +<span class="sourceLineNo">178</span> if (tablesToFetchSnapshotsFrom.contains(tn)) {<a name="line.178"></a> +<span class="sourceLineNo">179</span> snapshotsToCompute.put(tn, sd.getName());<a name="line.179"></a> +<span class="sourceLineNo">180</span> }<a name="line.180"></a> +<span class="sourceLineNo">181</span> }<a name="line.181"></a> +<span class="sourceLineNo">182</span> return snapshotsToCompute;<a name="line.182"></a> +<span class="sourceLineNo">183</span> }<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> * Computes the size of each snapshot provided given the current files referenced by the table.<a name="line.186"></a> +<span class="sourceLineNo">187</span> *<a name="line.187"></a> +<span class="sourceLineNo">188</span> * @param snapshotsToComputeSize The snapshots to compute the size of<a name="line.188"></a> +<span class="sourceLineNo">189</span> * @return A mapping of table to snapshot created from that table and the snapshot's size.<a name="line.189"></a> +<span class="sourceLineNo">190</span> */<a name="line.190"></a> +<span class="sourceLineNo">191</span> Multimap<TableName,SnapshotWithSize> computeSnapshotSizes(<a name="line.191"></a> +<span class="sourceLineNo">192</span> Multimap<TableName,String> snapshotsToComputeSize) throws IOException {<a name="line.192"></a> +<span class="sourceLineNo">193</span> Multimap<TableName,SnapshotWithSize> snapshotSizes = HashMultimap.create();<a name="line.193"></a> +<span class="sourceLineNo">194</span> for (Entry<TableName,Collection<String>> entry : snapshotsToComputeSize.asMap().entrySet()) {<a name="line.194"></a> +<span class="sourceLineNo">195</span> final TableName tn = entry.getKey();<a name="line.195"></a> +<span class="sourceLineNo">196</span> final List<String> snapshotNames = new ArrayList<>(entry.getValue());<a name="line.196"></a> +<span class="sourceLineNo">197</span> // Sort the snapshots so we process them in lexicographic order. This ensures that multiple<a name="line.197"></a> +<span class="sourceLineNo">198</span> // invocations of this Chore do not more the size ownership of some files between snapshots<a name="line.198"></a> +<span class="sourceLineNo">199</span> // that reference the file (prevents size ownership from moving between snapshots).<a name="line.199"></a> +<span class="sourceLineNo">200</span> Collections.sort(snapshotNames);<a name="line.200"></a> +<span class="sourceLineNo">201</span> final Path rootDir = FSUtils.getRootDir(conf);<a name="line.201"></a> +<span class="sourceLineNo">202</span> // Get the map of store file names to store file path for this table<a name="line.202"></a> +<span class="sourceLineNo">203</span> // TODO is the store-file name unique enough? Does this need to be region+family+storefile?<a name="line.203"></a> +<span class="sourceLineNo">204</span> final Set<String> tableReferencedStoreFiles;<a name="line.204"></a> +<span class="sourceLineNo">205</span> try {<a name="line.205"></a> +<span class="sourceLineNo">206</span> tableReferencedStoreFiles = FSUtils.getTableStoreFilePathMap(fs, rootDir).keySet();<a name="line.206"></a> +<span class="sourceLineNo">207</span> } catch (InterruptedException e) {<a name="line.207"></a> +<span class="sourceLineNo">208</span> Thread.currentThread().interrupt();<a name="line.208"></a> +<span class="sourceLineNo">209</span> return null;<a name="line.209"></a> +<span class="sourceLineNo">210</span> }<a name="line.210"></a> +<span class="sourceLineNo">211</span><a name="line.211"></a> +<span class="sourceLineNo">212</span> if (LOG.isTraceEnabled()) {<a name="line.212"></a> +<span class="sourceLineNo">213</span> LOG.trace("Paths for " + tn + ": " + tableReferencedStoreFiles);<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> // For each snapshot on this table, get the files which the snapshot references which<a name="line.216"></a> +<span class="sourceLineNo">217</span> // the table does not.<a name="line.217"></a> +<span class="sourceLineNo">218</span> Set<String> snapshotReferencedFiles = new HashSet<>();<a name="line.218"></a> +<span class="sourceLineNo">219</span> for (String snapshotName : snapshotNames) {<a name="line.219"></a> +<span class="sourceLineNo">220</span> final long start = System.nanoTime();<a name="line.220"></a> +<span class="sourceLineNo">221</span> Path snapshotDir = SnapshotDescriptionUtils.getCompletedSnapshotDir(snapshotName, rootDir);<a name="line.221"></a> +<span class="sourceLineNo">222</span> SnapshotDescription sd = SnapshotDescriptionUtils.readSnapshotInfo(fs, snapshotDir);<a name="line.222"></a> +<span class="sourceLineNo">223</span> SnapshotManifest manifest = SnapshotManifest.open(conf, fs, snapshotDir, sd);<a name="line.223"></a> +<span class="sourceLineNo">224</span><a name="line.224"></a> +<span class="sourceLineNo">225</span> if (LOG.isTraceEnabled()) {<a name="line.225"></a> +<span class="sourceLineNo">226</span> LOG.trace("Files referenced by other snapshots: " + snapshotReferencedFiles);<a name="line.226"></a> +<span class="sourceLineNo">227</span> }<a name="line.227"></a> +<span class="sourceLineNo">228</span><a name="line.228"></a> +<span class="sourceLineNo">229</span> // Get the set of files from the manifest that this snapshot references which are not also<a name="line.229"></a> +<span class="sourceLineNo">230</span> // referenced by the originating table.<a name="line.230"></a> +<span class="sourceLineNo">231</span> Set<StoreFileReference> unreferencedStoreFileNames = getStoreFilesFromSnapshot(<a name="line.231"></a> +<span class="sourceLineNo">232</span> manifest, (sfn) -> !tableReferencedStoreFiles.contains(sfn)<a name="line.232"></a> +<span class="sourceLineNo">233</span> && !snapshotReferencedFiles.contains(sfn));<a name="line.233"></a> +<span class="sourceLineNo">234</span><a name="line.234"></a> +<span class="sourceLineNo">235</span> if (LOG.isTraceEnabled()) {<a name="line.235"></a> +<span class="sourceLineNo">236</span> LOG.trace("Snapshot " + snapshotName + " solely references the files: "<a name="line.236"></a> +<span class="sourceLineNo">237</span> + unreferencedStoreFileNames);<a name="line.237"></a> +<span class="sourceLineNo">238</span> }<a name="line.238"></a> +<span class="sourceLineNo">239</span><a name="line.239"></a> +<span class="sourceLineNo">240</span> // Compute the size of the store files for this snapshot<a name="line.240"></a> +<span class="sourceLineNo">241</span> long size = getSizeOfStoreFiles(tn, unreferencedStoreFileNames);<a name="line.241"></a> +<span class="sourceLineNo">242</span> if (LOG.isTraceEnabled()) {<a name="line.242"></a> +<span class="sourceLineNo">243</span> LOG.trace("Computed size of " + snapshotName + " to be " + size);<a name="line.243"></a> +<span class="sourceLineNo">244</span> }<a name="line.244"></a> +<span class="sourceLineNo">245</span><a name="line.245"></a> +<span class="sourceLineNo">246</span> // Persist this snapshot's size into the map<a name="line.246"></a> +<span class="sourceLineNo">247</span> snapshotSizes.put(tn, new SnapshotWithSize(snapshotName, size));<a name="line.247"></a> +<span class="sourceLineNo">248</span><a name="line.248"></a> +<span class="sourceLineNo">249</span> // Make sure that we don't double-count the same file<a name="line.249"></a> +<span class="sourceLineNo">250</span> for (StoreFileReference ref : unreferencedStoreFileNames) {<a name="line.250"></a> +<span class="sourceLineNo">251</span> for (String fileName : ref.getFamilyToFilesMapping().values()) {<a name="line.251"></a> +<span class="sourceLineNo">252</span> snapshotReferencedFiles.add(fileName);<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> // Update the amount of time it took to compute the snapshot's size<a name="line.255"></a> +<span class="sourceLineNo">256</span> if (null != metrics) {<a name="line.256"></a> +<span class="sourceLineNo">257</span> metrics.incrementSnapshotSizeComputationTime((System.nanoTime() - start) / 1_000_000);<a name="line.257"></a> +<span class="sourceLineNo">258</span> }<a name="line.258"></a> +<span class="sourceLineNo">259</span> }<a name="line.259"></a> +<span class="sourceLineNo">260</span> }<a name="line.260"></a> +<span class="sourceLineNo">261</span> return snapshotSizes;<a name="line.261"></a> +<span class="sourceLineNo">262</span> }<a name="line.262"></a> +<span class="sourceLineNo">263</span><a name="line.263"></a> +<span class="sourceLineNo">264</span> /**<a name="line.264"></a> +<span class="sourceLineNo">265</span> * Extracts the names of the store files referenced by this snapshot which satisfy the given<a name="line.265"></a> +<span class="sourceLineNo">266</span> * predicate (the predicate returns {@code true}).<a name="line.266"></a> +<span class="sourceLineNo">267</span> */<a name="line.267"></a> +<span class="sourceLineNo">268</span> Set<StoreFileReference> getStoreFilesFromSnapshot(<a name="line.268"></a> +<span class="sourceLineNo">269</span> SnapshotManifest manifest, Predicate<String> filter) {<a name="line.269"></a> +<span class="sourceLineNo">270</span> Set<StoreFileReference> references = new HashSet<>();<a name="line.270"></a> +<span class="sourceLineNo">271</span> // For each region referenced by the snapshot<a name="line.271"></a> +<span class="sourceLineNo">272</span> for (SnapshotRegionManifest rm : manifest.getRegionManifests()) {<a name="line.272"></a> +<span class="sourceLineNo">273</span> StoreFileReference regionReference = new StoreFileReference(<a name="line.273"></a> +<span class="sourceLineNo">274</span> HRegionInfo.convert(rm.getRegionInfo()).getEncodedName());<a name="line.274"></a> +<span class="sourceLineNo">275</span><a name="line.275"></a> +<span class="sourceLineNo">276</span> // For each column family in this region<a name="line.276"></a> +<span class="sourceLineNo">277</span> for (FamilyFiles ff : rm.getFamilyFilesList()) {<a name="line.277"></a> +<span class="sourceLineNo">278</span> final String familyName = ff.getFamilyName().toStringUtf8();<a name="line.278"></a> +<span class="sourceLineNo">279</span> // And each store file in that family<a name="line.279"></a> +<span class="sourceLineNo">280</span> for (StoreFile sf : ff.getStoreFilesList()) {<a name="line.280"></a> +<span class="sourceLineNo">281</span> String storeFileName = sf.getName();<a name="line.281"></a> +<span class="sourceLineNo">282</span> // A snapshot only "inherits" a files size if it uniquely refers to it (no table<a name="line.282"></a> +<span class="sourceLineNo">283</span> // and no other snapshot references it).<a name="line.283"></a> +<span class="sourceLineNo">284</span> if (filter.test(storeFileName)) {<a name="line.284"></a> +<span class="sourceLineNo">285</span> regionReference.addFamilyStoreFile(familyName, storeFileName);<a name="line.285"></a> +<span class="sourceLineNo">286</span> }<a name="line.286"></a> +<span class="sourceLineNo">287</span> }<a name="line.287"></a> +<span class="sourceLineNo">288</span> }<a name="line.288"></a> +<span class="sourceLineNo">289</span> // Only add this Region reference if we retained any files.<a name="line.289"></a> +<span class="sourceLineNo">290</span> if (!regionReference.getFamilyToFilesMapping().isEmpty()) {<a name="line.290"></a> +<span class="sourceLineNo">291</span> references.add(regionReference);<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> return references;<a name="line.294"></a> +<span class="sourceLineNo">295</span> }<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> * Calculates the directory in HDFS for a table based on the configuration.<a name="line.298"></a> +<span class="sourceLineNo">299</span> */<a name="line.299"></a> +<span class="sourceLineNo">300</span> Path getTableDir(TableName tn) throws IOException {<a name="line.300"></a> +<span class="sourceLineNo">301</span> Path rootDir = FSUtils.getRootDir(conf);<a name="line.301"></a> +<span class="sourceLineNo">302</span> return FSUtils.getTableDir(rootDir, tn);<a name="line.302"></a> +<span class="sourceLineNo">303</span> }<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">306</span> * Computes the size of each store file in {@code storeFileNames}<a name="line.306"></a> +<span class="sourceLineNo">307</span> */<a name="line.307"></a> +<span class="sourceLineNo">308</span> long getSizeOfStoreFiles(TableName tn, Set<StoreFileReference> storeFileNames) {<a name="line.308"></a> +<span class="sourceLineNo">309</span> return storeFileNames.stream()<a name="line.309"></a> +<span class="sourceLineNo">310</span> .collect(Collectors.summingLong((sfr) -> getSizeOfStoreFile(tn, sfr)));<a name="line.310"></a> +<span class="sourceLineNo">311</span> }<a name="line.311"></a> +<span class="sourceLineNo">312</span><a name="line.312"></a> +<span class="sourceLineNo">313</span> /**<a name="line.313"></a> +<span class="sourceLineNo">314</span> * Computes the size of the store files for a single region.<a name="line.314"></a> +<span class="sourceLineNo">315</span> */<a name="line.315"></a> +<span class="sourceLineNo">316</span> long getSizeOfStoreFile(TableName tn, StoreFileReference storeFileName) {<a name="line.316"></a> +<span class="sourceLineNo">317</span> String regionName = storeFileName.getRegionName();<a name="line.317"></a> +<span class="sourceLineNo">318</span> return storeFileName.getFamilyToFilesMapping()<a name="line.318"></a> +<span class="sourceLineNo">319</span> .entries().stream()<a name="line.319"></a> +<span class="sourceLineNo">320</span> .collect(Collectors.summingLong((e) -><a name="line.320"></a> +<span class="sourceLineNo">321</span> getSizeOfStoreFile(tn, regionName, e.getKey(), e.getValue())));<a name="line.321"></a> +<span class="sourceLineNo">322</span> }<a name="line.322"></a> +<span class="sourceLineNo">323</span><a name="line.323"></a> +<span class="sourceLineNo">324</span> /**<a name="line.324"></a> +<span class="sourceLineNo">325</span> * Computes the size of the store file given its name, region and family name in<a name="line.325"></a> +<span class="sourceLineNo">326</span> * the archive directory.<a name="line.326"></a> +<span class="sourceLineNo">327</span> */<a name="line.327"></a> +<span class="sourceLineNo">328</span> long getSizeOfStoreFile(<a name="line.328"></a> +<span class="sourceLineNo">329</span> TableName tn, String regionName, String family, String storeFile) {<a name="line.329"></a> +<span class="sourceLineNo">330</span> Path familyArchivePath;<a name="line.330"></a> +<span class="sourceLineNo">331</span> try {<a name="line.331"></a> +<span class="sourceLineNo">332</span> familyArchivePath = HFileArchiveUtil.getStoreArchivePath(conf, tn, regionName, family);<a name="line.332"></a> +<span class="sourceLineNo">333</span> } catch (IOException e) {<a name="line.333"></a> +<span class="sourceLineNo">334</span> LOG.warn("Could not compute path for the archive directory for the region", e);<a name="line.334"></a> +<span class="sourceLineNo">335</span> return 0L;<a name="line.335"></a> +<span class="sourceLineNo">336</span> }<a name="line.336"></a> +<span class="sourceLineNo">337</span> Path fileArchivePath = new Path(familyArchivePath, storeFile);<a name="line.337"></a> +<span class="sourceLineNo">338</span> try {<a name="line.338"></a> +<span class="sourceLineNo">339</span> if (fs.exists(fileArchivePath)) {<a name="line.339"></a> +<span class="sourceLineNo">340</span> FileStatus[] status = fs.listStatus(fileArchivePath);<a name="line.340"></a> +<span class="sourceLineNo">341</span> if (1 != status.length) {<a name="line.341"></a> +<span class="sourceLineNo">342</span> LOG.warn("Expected " + fileArchivePath +<a name="line.342"></a> +<span class="sourceLineNo">343</span> " to be a file but was a directory, ignoring reference");<a name="line.343"></a> +<span class="sourceLineNo">344</span> return 0L;<a name="line.344"></a> +<span class="sourceLineNo">345</span> }<a name="line.345"></a> +<span class="sourceLineNo">346</span> return status[0].getLen();<a name="line.346"></a> +<span class="sourceLineNo">347</span> }<a name="line.347"></a> +<span class="sourceLineNo">348</span> } catch (IOException e) {<a name="line.348"></a> +<span class="sourceLineNo">349</span> LOG.warn("Could not obtain the status of " + fileArchivePath, e);<a name="line.349"></a> +<span class="sourceLineNo">350</span> return 0L;<a name="line.350"></a> +<span class="sourceLineNo">351</span> }<a name="line.351"></a> +<span class="sourceLineNo">352</span> LOG.warn("Expected " + fileArchivePath + " to exist but does not, ignoring reference.");<a name="line.352"></a> +<span class="sourceLineNo">353</span> return 0L;<a name="line.353"></a> +<span class="sourceLineNo">354</span> }<a name="line.354"></a> +<span class="sourceLineNo">355</span><a name="line.355"></a> +<span class="sourceLineNo">356</span> /**<a name="line.356"></a> +<span class="sourceLineNo">357</span> * Writes the snapshot sizes to the {@code hbase:quota} table.<a name="line.357"></a> +<span class="sourceLineNo">358</span> *<a name="line.358"></a> +<span class="sourceLineNo">359</span> * @param snapshotsWithSize The snapshot sizes to write.<a name="line.359"></a> +<span class="sourceLineNo">360</span> */<a name="line.360"></a> +<span class="sourceLineNo">361</span> void persistSnapshotSizes(<a name="line.361"></a> +<span class="sourceLineNo">362</span> Multimap<TableName,SnapshotWithSize> snapshotsWithSize) throws IOException {<a name="line.362"></a> +<span class="sourceLineNo">363</span> try (Table quotaTable = conn.getTable(QuotaTableUtil.QUOTA_TABLE_NAME)) {<a name="line.363"></a> +<span class="sourceLineNo">364</span> // Write each snapshot size for the table<a name="line.364"></a> +<span class="sourceLineNo">365</span> persistSnapshotSizes(quotaTable, snapshotsWithSize);<a name="line.365"></a> +<span class="sourceLineNo">366</span> // Write a size entry for all snapshots in a namespace<a name="line.366"></a> +<span class="sourceLineNo">367</span> persistSnapshotSizesByNS(quotaTable, snapshotsWithSize);<a name="line.367"></a> +<span class="sourceLineNo">368</span> }<a name="line.368"></a> +<span class="sourceLineNo">369</span> }<a name="line.369"></a> +<span class="sourceLineNo">370</span><a name="line.370"></a> +<span class="sourceLineNo">371</span> /**<a name="line.371"></a> +<span class="sourceLineNo">372</span> * Writes the snapshot sizes to the provided {@code table}.<a name="line.372"></a> +<span class="sourceLineNo">373</span> */<a name="line.373"></a> +<span class="sourceLineNo">374</span> void persistSnapshotSizes(<a name="line.374"></a> +<span class="sourceLineNo">375</span> Table table, Multimap<TableName,SnapshotWithSize> snapshotsWithSize) throws IOException {<a name="line.375"></a> +<span class="sourceLineNo">376</span> // Convert each entry in the map to a Put and write them to the quota table<a name="line.376"></a> +<span class="sourceLineNo">377</span> table.put(snapshotsWithSize.entries()<a name="line.377"></a> +<span class="sourceLineNo">378</span> .stream()<a name="line.378"></a> +<span class="sourceLineNo">379</span> .map(e -> QuotaTableUtil.createPutForSnapshotSize(<a name="line.379"></a> +<span class="sourceLineNo">380</span> e.getKey(), e.getValue().getName(), e.getValue().getSize()))<a name="line.380"></a> +<span class="sourceLineNo">381</span> .collect(Collectors.toList()));<a name="line.381"></a> +<span class="sourceLineNo">382</span> }<a name="line.382"></a> +<span class="sourceLineNo">383</span><a name="line.383"></a> +<span class="sourceLineNo">384</span> /**<a name="line.384"></a> +<span class="sourceLineNo">385</span> * Rolls up the snapshot sizes by namespace and writes a single record for each namespace<a name="line.385"></a> +<span class="sourceLineNo">386</span> * which is the size of all snapshots in that namespace.<a name="line.386"></a> +<span class="sourceLineNo">387</span> */<a name="line.387"></a> +<span class="sourceLineNo">388</span> void persistSnapshotSizesByNS(<a name="line.388"></a> +<span class="sourceLineNo">389</span> Table quotaTable, Multimap<TableName,SnapshotWithSize> snapshotsWithSize) throws IOException {<a name="line.389"></a> +<span class="sourceLineNo">390</span> Map<String,Long> namespaceSnapshotSizes = groupSnapshotSizesByNamespace(snapshotsWithSize);<a name="line.390"></a> +<span class="sourceLineNo">391</span> quotaTable.put(namespaceSnapshotSizes.entrySet().stream()<a name="line.391"></a> +<span class="sourceLineNo">392</span> .map(e -> QuotaTableUtil.createPutForNamespaceSnapshotSize(<a name="line.392"></a> +<span class="sourceLineNo">393</span> e.getKey(), e.getValue()))<a name="line.393"></a> +<span class="sourceLineNo">394</span> .collect(Collectors.toList()));<a name="line.394"></a> +<span class="sourceLineNo">395</span> }<a name="line.395"></a> +<span class="sourceLineNo">396</span><a name="line.396"></a> +<span class="sourceLineNo">397</span> /**<a name="line.397"></a> +<span class="sourceLineNo">398</span> * Sums the snapshot sizes for each namespace.<a name="line.398"></a> +<span class="sourceLineNo">399</span> */<a name="line.399"></a> +<span class="sourceLineNo">400</span> Map<String,Long> groupSnapshotSizesByNamespace(<a name="line.400"></a> +<span class="sourceLineNo">401</span> Multimap<TableName,SnapshotWithSize> snapshotsWithSize) {<a name="line.401"></a> +<span class="sourceLineNo">402</span> return snapshotsWithSize.entries().stream()<a name="line.402"></a> +<span class="sourceLineNo">403</span> .collect(Collectors.groupingBy(<a name="line.403"></a> +<span class="sourceLineNo">404</span> // Convert TableName into the namespace string<a name="line.404"></a> +<span class="sourceLineNo">405</span> (e) -> e.getKey().getNamespaceAsString(),<a name="line.405"></a> +<span class="sourceLineNo">406</span> // Sum the values for namespace<a name="line.406"></a> +<span class="sourceLineNo">407</span> Collectors.mapping(<a name="line.407"></a> +<span class="sourceLineNo">408</span> Map.Entry::getValue, Collectors.summingLong((sws) -> sws.getSize()))));<a name="line.408"></a> +<span class="sourceLineNo">409</span> }<a name="line.409"></a> +<span class="sourceLineNo">410</span><a name="line.410"></a> +<span class="sourceLineNo">411</span> /**<a name="line.411"></a> +<span class="sourceLineNo">412</span> * A struct encapsulating the name of a snapshot and its "size" on the filesystem. This size is<a name="line.412"></a> +<span class="sourceLineNo">413</span> * defined as the amount of filesystem space taken by the files the snapshot refers to which<a name="line.413"></a> +<span class="sourceLineNo">414</span> * the originating table no longer refers to.<a name="line.414"></a> +<span class="sourceLineNo">415</span> */<a name="line.415"></a> +<span class="sourceLineNo">416</span> static class SnapshotWithSize {<a name="line.416"></a> +<span class="sourceLineNo">417</span> private final String name;<a name="line.417"></a> +<span class="sourceLineNo">418</span> private final long size;<a name="line.418"></a> +<span class="sourceLineNo">419</span><a name="line.419"></a> +<span class="sourceLineNo">420</span> SnapshotWithSize(String name, long size) {<a name="line.420"></a> +<span class="sourceLineNo">421</span> this.name = Objects.requireNonNull(name);<a name="line.421"></a> +<span class="sourceLineNo">422</span> this.size = size;<a name="line.422"></a> +<span class="sourceLineNo">423</span> }<a name="line.423"></a> +<span class="sourceLineNo">424</span><a name="line.424"></a> +<span class="sourceLineNo">425</span> String getName() {<a name="line.425"></a> +<span class="sourceLineNo">426</span> return name;<a name="line.426"></a> +<span class="sourceLineNo">427</span> }<a name="line.427"></a> +<span class="sourceLineNo">428</span><a name="line.428"></a> +<span class="sourceLineNo">429</span> long getSize() {<a name="line.429"></a> +<span class="sourceLineNo">430</span> return size;<a name="line.430"></a> +<span class="sourceLineNo">431</span> }<a name="line.431"></a> +<span class="sourceLineNo">432</span><a name="line.432"></a> +<span class="sourceLineNo">433</span> @Override<a name="line.433"></a> +<span class="sourceLineNo">434</span> public int hashCode() {<a name="line.434"></a> +<span class="sourceLineNo">435</span> return new HashCodeBuilder().append(name).append(size).toHashCode();<a name="line.435"></a> +<span class="sourceLineNo">436</span> }<a name="line.436"></a> +<span class="sourceLineNo">437</span><a name="line.437"></a> +<span class="sourceLineNo">438</span> @Override<a name="line.438"></a> +<span class="sourceLineNo">439</span> public boolean equals(Object o) {<a name="line.439"></a> +<span class="sourceLineNo">440</span> if (this == o) {<a name="line.440"></a> +<span class="sourceLineNo">441</span> return true;<a name="line.441"></a> +<span class="sourceLineNo">442</span> }<a name="line.442"></a> +<span class="sourceLineNo">443</span><a name="line.443"></a> +<span class="sourceLineNo">444</span> if (!(o instanceof SnapshotWithSize)) {<a name="line.444"></a> +<span class="sourceLineNo">445</span> return false;<a name="line.445"></a> +<span class="sourceLineNo">446</span> }<a name="line.446"></a> +<span class="sourceLineNo">447</span><a name="line.447"></a> +<span class="sourceLineNo">448</span> SnapshotWithSize other = (SnapshotWithSize) o;<a name="line.448"></a> +<span class="sourceLineNo">449</span> return name.equals(other.name) && size == other.size;<a name="line.449"></a> +<span class="sourceLineNo">450</span> }<a name="line.450"></a> +<span class="sourceLineNo">451</span><a name="line.451"></a> +<span class="sourceLineNo">452</span> @Override<a name="line.452"></a> +<span class="sourceLineNo">453</span> public String toString() {<a name="line.453"></a> +<span class="sourceLineNo">454</span> StringBuilder sb = new StringBuilder(32);<a name="line.454"></a> +<span class="sourceLineNo">455</span> return sb.append("SnapshotWithSize:[").append(name).append(" ")<a name="line.455"></a> +<span class="sourceLineNo">456</span> .append(StringUtils.byteDesc(size)).append("]").toString();<a name="line.456"></a> +<span class="sourceLineNo">457</span> }<a name="line.457"></a> +<span class="sourceLineNo">458</span> }<a name="line.458"></a> +<span class="sourceLineNo">459</span><a name="line.459"></a> +<span class="sourceLineNo">460</span> /**<a name="line.460"></a> +<span class="sourceLineNo">461</span> * A reference to a collection of files in the archive directory for a single region.<a name="line.461"></a> +<span class="sourceLineNo">462</span> */<a name="line.462"></a> +<span class="sourceLineNo">463</span> static class StoreFileReference {<a name="line.463"></a> +<span class="sourceLineNo">464</span> private final String regionName;<a name="line.464"></a> +<span class="sourceLineNo">465</span> private final Multimap<String,String> familyToFiles;<a name="line.465"></a> +<span class="sourceLineNo">466</span><a name="line.466"></a> +<span class="sourceLineNo">467</span> StoreFileReference(String regionName) {<a name="line.467"></a> +<span class="sourceLineNo">468</span> this.regionName = Objects.requireNonNull(regionName);<a name="line.468"></a> +<span class="sourceLineNo">469</span> familyToFiles = HashMultimap.create();<a name="line.469"></a> +<span class="sourceLineNo">470</span> }<a name="line.470"></a> +<span class="sourceLineNo">471</span><a name="line.471"></a> +<span class="sourceLineNo">472</span> String getRegionName() {<a name="line.472"></a> +<span class="sourceLineNo">473</span> return regionName;<a name="line.473"></a> +<span class="sourceLineNo">474</span> }<a name="line.474"></a> +<span class="sourceLineNo">475</span><a name="line.475"></a> +<span class="sourceLineNo">476</span> Multimap<String,String> getFamilyToFilesMapping() {<a name="line.476"></a> +<span class="sourceLineNo">477</span> return familyToFiles;<a name="line.477"></a> +<span class="sourceLineNo">478</span> }<a name="line.478"></a> +<span class="sourceLineNo">479</span><a name="line.479"></a> +<span class="sourceLineNo">480</span> void addFamilyStoreFile(String family, String storeFileName) {<a name="line.480"></a> +<span class="sourceLineNo">481</span> familyToFiles.put(family, storeFileName);<a name="line.481"></a> +<span class="sourceLineNo">482</span> }<a name="line.482"></a> +<span class="sourceLineNo">483</span><a name="line.483"></a> +<span class="sourceLineNo">484</span> @Override<a name="line.484"></a> +<span class="sourceLineNo">485</span> public int hashCode() {<a name="line.485"></a> +<span class="sourceLineNo">486</span> return new HashCodeBuilder().append(regionName).append(familyToFiles).toHashCode();<a name="line.486"></a> +<span class="sourceLineNo">487</span> }<a name="line.487"></a> +<span class="sourceLineNo">488</span><a name="line.488"></a> +<span class="sourceLineNo">489</span> @Override<a name="line.489"></a> +<span class="sourceLineNo">490</span> public boolean equals(Object o) {<a name="line.490"></a> +<span class="sourceLineNo">491</span> if (this == o) {<a name="line.491"></a> +<span class="sourceLineNo">492</span> return true;<a name="line.492"></a> +<span class="sourceLineNo">493</span> }<a name="line.493"></a> +<span class="sourceLineNo">494</span> if (!(o instanceof StoreFileReference)) {<a name="line.494"></a> +<span class="sourceLineNo">495</span> return false;<a name="line.495"></a> +<span class="sourceLineNo">496</span> }<a name="line.496"></a> +<span class="sourceLineNo">497</span> StoreFileReference other = (StoreFileReference) o;<a name="line.497"></a> +<span class="sourceLineNo">498</span> return regionName.equals(other.regionName) && familyToFiles.equals(other.familyToFiles);<a name="line.498"></a> +<span class="sourceLineNo">499</span> }<a name="line.499"></a> +<span class="sourceLineNo">500</span><a name="line.500"></a> +<span class="sourceLineNo">501</span> @Override<a name="line.501"></a> +<span class="sourceLineNo">502</span> public String toString() {<a name="line.502"></a> +<span class="sourceLineNo">503</span> StringBuilder sb = new StringBuilder();<a name="line.503"></a> +<span class="sourceLineNo">504</span> return sb.append("StoreFileReference[region=").append(regionName).append(", files=")<a name="line.504"></a> +<span class="sourceLineNo">505</span> .append(familyToFiles).append("]").toString();<a name="line.505"></a> +<span class="sourceLineNo">506</span> }<a name="line.506"></a> +<span class="sourceLineNo">507</span> }<a name="line.507"></a> +<span class="sourceLineNo">508</span><a name="line.508"></a> +<span class="sourceLineNo">509</span> /**<a name="line.509"></a> +<span class="sourceLineNo">510</span> * Extracts the period for the chore from the configuration.<a name="line.510"></a> +<span class="sourceLineNo">511</span> *<a name="line.511"></a> +<span class="sourceLineNo">512</span> * @param conf The configuration object.<a name="line.512"></a> +<span class="sourceLineNo">513</span> * @return The configured chore period or the default value.<a name="line.513"></a> +<span class="sourceLineNo">514</span> */<a name="line.514"></a> +<span class="sourceLineNo">515</span> static int getPeriod(Configuration conf) {<a name="line.515"></a> +<span class="sourceLineNo">516</span> return conf.getInt(SNAPSHOT_QUOTA_CHORE_PERIOD_KEY,<a name="line.516"></a> +<span class="sourceLineNo">517</span> SNAPSHOT_QUOTA_CHORE_PERIOD_DEFAULT);<a name="line.517"></a> +<span class="sourceLineNo">518</span> }<a name="line.518"></a> +<span class="sourceLineNo">519</span><a name="line.519"></a> +<span class="sourceLineNo">520</span> /**<a name="line.520"></a> +<span class="sourceLineNo">521</span> * Extracts the initial delay for the chore from the configuration.<a name="line.521"></a> +<span class="sourceLineNo">522</span> *<a name="line.522"></a> +<span class="sourceLineNo">523</span> * @param conf The configuration object.<a name="line.523"></a> +<span class="sourceLineNo">524</span> * @return The configured chore initial delay or the default value.<a name="line.524"></a> +<span class="sourceLineNo">525</span> */<a name="line.525"></a> +<span class="sourceLineNo">526</span> static long getInitialDelay(Configuration conf) {<a name="line.526"></a> +<span class="sourceLineNo">527</span> return conf.getLong(SNAPSHOT_QUOTA_CHORE_DELAY_KEY,<a name="line.527"></a> +<span class="sourceLineNo">528</span> SNAPSHOT_QUOTA_CHORE_DELAY_DEFAULT);<a name="line.528"></a> +<span class="sourceLineNo">529</span> }<a name="line.529"></a> +<span class="sourceLineNo">530</span><a name="line.530"></a> +<span class="sourceLineNo">531</span> /**<a name="line.531"></a> +<span class="sourceLineNo">532</span> * Extracts the time unit for the chore period and initial delay from the configuration. The<a name="line.532"></a> +<span class="sourceLineNo">533</span> * configuration value for {@link #SNAPSHOT_QUOTA_CHORE_TIMEUNIT_KEY} must correspond to<a name="line.533"></a> +<span class="sourceLineNo">534</span> * a {@link TimeUnit} value.<a name="line.534"></a> +<span class="sourceLineNo">535</span> *<a name="line.535"></a> +<span class="sourceLineNo">536</span> * @param conf The configuration object.<a name="line.536"></a> +<span class="sourceLineNo">537</span> * @return The configured time unit for the chore period and initial delay or the default value.<a name="line.537"></a> +<span class="sourceLineNo">538</span> */<a name="line.538"></a> +<span class="sourceLineNo">539</span> static TimeUnit getTimeUnit(Configuration conf) {<a name="line.539"></a> +<span class="sourceLineNo">540</span> return TimeUnit.valueOf(conf.get(SNAPSHOT_QUOTA_CHORE_TIMEUNIT_KEY,<a name="line.540"></a> +<span class="sourceLineNo">541</span> SNAPSHOT_QUOTA_CHORE_TIMEUNIT_DEFAULT));<a name="line.541"></a> +<span class="sourceLineNo">542</span> }<a name="line.542"></a> +<span class="sourceLineNo">543</span>}<a name="line.543"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/476c54ed/devapidocs/src-html/org/apache/hadoop/hbase/quotas/SpaceQuotaSnapshot.SpaceQuotaStatus.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/quotas/SpaceQuotaSnapshot.SpaceQuotaStatus.html b/devapidocs/src-html/org/apache/hadoop/hbase/quotas/SpaceQuotaSnapshot.SpaceQuotaStatus.html index 3a57bbd..b408e5f 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/quotas/SpaceQuotaSnapshot.SpaceQuotaStatus.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/quotas/SpaceQuotaSnapshot.SpaceQuotaStatus.html @@ -30,182 +30,184 @@ <span class="sourceLineNo">022</span>import org.apache.hadoop.hbase.classification.InterfaceAudience;<a name="line.22"></a> <span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.shaded.protobuf.ProtobufUtil;<a name="line.23"></a> <span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos;<a name="line.24"></a> -<span class="sourceLineNo">025</span><a name="line.25"></a> -<span class="sourceLineNo">026</span>/**<a name="line.26"></a> -<span class="sourceLineNo">027</span> * A point-in-time view of a space quota on a table.<a name="line.27"></a> -<span class="sourceLineNo">028</span> */<a name="line.28"></a> -<span class="sourceLineNo">029</span>@InterfaceAudience.Private<a name="line.29"></a> -<span class="sourceLineNo">030</span>public class SpaceQuotaSnapshot {<a name="line.30"></a> -<span class="sourceLineNo">031</span> private static final SpaceQuotaSnapshot NO_SUCH_SNAPSHOT = new SpaceQuotaSnapshot(<a name="line.31"></a> -<span class="sourceLineNo">032</span> SpaceQuotaStatus.notInViolation(), 0, Long.MAX_VALUE);<a name="line.32"></a> -<span class="sourceLineNo">033</span> private final SpaceQuotaStatus quotaStatus;<a name="line.33"></a> -<span class="sourceLineNo">034</span> private final long usage;<a name="line.34"></a> -<span class="sourceLineNo">035</span> private final long limit;<a name="line.35"></a> -<span class="sourceLineNo">036</span><a name="line.36"></a> -<span class="sourceLineNo">037</span> /**<a name="line.37"></a> -<span class="sourceLineNo">038</span> * Encapsulates the state of a quota on a table. The quota may or may not be in violation.<a name="line.38"></a> -<span class="sourceLineNo">039</span> * If the quota is not in violation, the violation may be null. If the quota is in violation,<a name="line.39"></a> -<span class="sourceLineNo">040</span> * there is guaranteed to be a non-null violation policy.<a name="line.40"></a> -<span class="sourceLineNo">041</span> */<a name="line.41"></a> -<span class="sourceLineNo">042</span> @InterfaceAudience.Private<a name="line.42"></a> -<span class="sourceLineNo">043</span> public static class SpaceQuotaStatus {<a name="line.43"></a> -<span class="sourceLineNo">044</span> private static final SpaceQuotaStatus NOT_IN_VIOLATION = new SpaceQuotaStatus(null, false);<a name="line.44"></a> -<span class="sourceLineNo">045</span> final SpaceViolationPolicy policy;<a name="line.45"></a> -<span class="sourceLineNo">046</span> final boolean inViolation;<a name="line.46"></a> -<span class="sourceLineNo">047</span><a name="line.47"></a> -<span class="sourceLineNo">048</span> /**<a name="line.48"></a> -<span class="sourceLineNo">049</span> * Constructs a {@code SpaceQuotaSnapshot} which is in violation of the provided {@code policy}.<a name="line.49"></a> -<span class="sourceLineNo">050</span> *<a name="line.50"></a> -<span class="sourceLineNo">051</span> * Use {@link #notInViolation()} to obtain an instance of this class for the cases when the<a name="line.51"></a> -<span class="sourceLineNo">052</span> * quota is not in violation.<a name="line.52"></a> -<span class="sourceLineNo">053</span> *<a name="line.53"></a> -<span class="sourceLineNo">054</span> * @param policy The non-null policy being violated.<a name="line.54"></a> -<span class="sourceLineNo">055</span> */<a name="line.55"></a> -<span class="sourceLineNo">056</span> public SpaceQuotaStatus(SpaceViolationPolicy policy) {<a name="line.56"></a> -<span class="sourceLineNo">057</span> // If the caller is instantiating a status, the policy must be non-null<a name="line.57"></a> -<span class="sourceLineNo">058</span> this (Objects.requireNonNull(policy), true);<a name="line.58"></a> -<span class="sourceLineNo">059</span> }<a name="line.59"></a> -<span class="sourceLineNo">060</span><a name="line.60"></a> -<span class="sourceLineNo">061</span> private SpaceQuotaStatus(SpaceViolationPolicy policy, boolean inViolation) {<a name="line.61"></a> -<span class="sourceLineNo">062</span> this.policy = policy;<a name="line.62"></a> -<span class="sourceLineNo">063</span> this.inViolation = inViolation;<a name="line.63"></a> -<span class="sourceLineNo">064</span> }<a name="line.64"></a> -<span class="sourceLineNo">065</span><a name="line.65"></a> -<span class="sourceLineNo">066</span> /**<a name="line.66"></a> -<span class="sourceLineNo">067</span> * Returns the violation policy, which may be null. It is guaranteed to be non-null if<a name="line.67"></a> -<span class="sourceLineNo">068</span> * {@link #isInViolation()} is {@code true}, but may be null otherwise.<a name="line.68"></a> -<span class="sourceLineNo">069</span> */<a name="line.69"></a> -<span class="sourceLineNo">070</span> public SpaceViolationPolicy getPolicy() {<a name="line.70"></a> -<span class="sourceLineNo">071</span> return policy;<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> * @return {@code true} if the quota is being violated, {@code false} otherwise.<a name="line.75"></a> -<span class="sourceLineNo">076</span> */<a name="line.76"></a> -<span class="sourceLineNo">077</span> public boolean isInViolation() {<a name="line.77"></a> -<span class="sourceLineNo">078</span> return inViolation;<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> /**<a name="line.81"></a> -<span class="sourceLineNo">082</span> * Returns a singleton referring to a quota which is not in violation.<a name="line.82"></a> -<span class="sourceLineNo">083</span> */<a name="line.83"></a> -<span class="sourceLineNo">084</span> public static SpaceQuotaStatus notInViolation() {<a name="line.84"></a> -<span class="sourceLineNo">085</span> return NOT_IN_VIOLATION;<a name="line.85"></a> -<span class="sourceLineNo">086</span> }<a name="line.86"></a> -<span class="sourceLineNo">087</span><a name="line.87"></a> -<span class="sourceLineNo">088</span> @Override<a name="line.88"></a> -<span class="sourceLineNo">089</span> public int hashCode() {<a name="line.89"></a> -<span class="sourceLineNo">090</span> return new HashCodeBuilder().append(policy == null ? 0 : policy.hashCode())<a name="line.90"></a> -<span class="sourceLineNo">091</span> .append(inViolation).toHashCode();<a name="line.91"></a> -<span class="sourceLineNo">092</span> }<a name="line.92"></a> -<span class="sourceLineNo">093</span><a name="line.93"></a> -<span class="sourceLineNo">094</span> @Override<a name="line.94"></a> -<span class="sourceLineNo">095</span> public boolean equals(Object o) {<a name="line.95"></a> -<span class="sourceLineNo">096</span> if (o instanceof SpaceQuotaStatus) {<a name="line.96"></a> -<span class="sourceLineNo">097</span> SpaceQuotaStatus other = (SpaceQuotaStatus) o;<a name="line.97"></a> -<span class="sourceLineNo">098</span> return Objects.equals(policy, other.policy) && inViolation == other.inViolation;<a name="line.98"></a> -<span class="sourceLineNo">099</span> }<a name="line.99"></a> -<span class="sourceLineNo">100</span> return false;<a name="line.100"></a> -<span class="sourceLineNo">101</span> }<a name="line.101"></a> -<span class="sourceLineNo">102</span><a name="line.102"></a> -<span class="sourceLineNo">103</span> @Override<a name="line.103"></a> -<span class="sourceLineNo">104</span> public String toString() {<a name="line.104"></a> -<span class="sourceLineNo">105</span> StringBuilder sb = new StringBuilder(getClass().getSimpleName());<a name="line.105"></a> -<span class="sourceLineNo">106</span> sb.append("[policy=").append(policy);<a name="line.106"></a> -<span class="sourceLineNo">107</span> sb.append(", inViolation=").append(inViolation).append("]");<a name="line.107"></a> -<span class="sourceLineNo">108</span> return sb.toString();<a name="line.108"></a> -<span class="sourceLineNo">109</span> }<a name="line.109"></a> -<span class="sourceLineNo">110</span><a name="line.110"></a> -<span class="sourceLineNo">111</span> public static QuotaProtos.SpaceQuotaStatus toProto(SpaceQuotaStatus status) {<a name="line.111"></a> -<span class="sourceLineNo">112</span> QuotaProtos.SpaceQuotaStatus.Builder builder = QuotaProtos.SpaceQuotaStatus.newBuilder();<a name="line.112"></a> -<span class="sourceLineNo">113</span> builder.setInViolation(status.inViolation);<a name="line.113"></a> -<span class="sourceLineNo">114</span> if (status.isInViolation()) {<a name="line.114"></a> -<span class="sourceLineNo">115</span> builder.setViolationPolicy(ProtobufUtil.toProtoViolationPolicy(status.getPolicy()));<a name="line.115"></a> -<span class="sourceLineNo">116</span> }<a name="line.116"></a> -<span class="sourceLineNo">117</span> return builder.build();<a name="line.117"></a> -<span class="sourceLineNo">118</span> }<a name="line.118"></a> -<span class="sourceLineNo">119</span><a name="line.119"></a> -<span class="sourceLineNo">120</span> public static SpaceQuotaStatus toStatus(QuotaProtos.SpaceQuotaStatus proto) {<a name="line.120"></a> -<span class="sourceLineNo">121</span> if (proto.getInViolation()) {<a name="line.121"></a> -<span class="sourceLineNo">122</span> return new SpaceQuotaStatus(ProtobufUtil.toViolationPolicy(proto.getViolationPolicy()));<a name="line.122"></a> -<span class="sourceLineNo">123</span> } else {<a name="line.123"></a> -<span class="sourceLineNo">124</span> return NOT_IN_VIOLATION;<a name="line.124"></a> -<span class="sourceLineNo">125</span> }<a name="line.125"></a> -<span class="sourceLineNo">126</span> }<a name="line.126"></a> -<span class="sourceLineNo">127</span> }<a name="line.127"></a> -<span class="sourceLineNo">128</span><a name="line.128"></a> -<span class="sourceLineNo">129</span> public SpaceQuotaSnapshot(SpaceQuotaStatus quotaStatus, long usage, long limit) {<a name="line.129"></a> -<span class="sourceLineNo">130</span> this.quotaStatus = Objects.requireNonNull(quotaStatus);<a name="line.130"></a> -<span class="sourceLineNo">131</span> this.usage = usage;<a name="line.131"></a> -<span class="sourceLineNo">132</span> this.limit = limit;<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 status of the quota.<a name="line.136"></a> -<span class="sourceLineNo">137</span> */<a name="line.137"></a> -<span class="sourceLineNo">138</span> public SpaceQuotaStatus getQuotaStatus() {<a name="line.138"></a> -<span class="sourceLineNo">139</span> return quotaStatus;<a name="line.139"></a> -<span class="sourceLineNo">140</span> }<a name="line.140"></a> -<span class="sourceLineNo">141</span><a name="line.141"></a> -<span class="sourceLineNo">142</span> /**<a name="line.142"></a> -<span class="sourceLineNo">143</span> * Returns the current usage, in bytes, of the target (e.g. table, namespace).<a name="line.143"></a> -<span class="sourceLineNo">144</span> */<a name="line.144"></a> -<span class="sourceLineNo">145</span> public long getUsage() {<a name="line.145"></a> -<span class="sourceLineNo">146</span> return usage;<a name="line.146"></a> -<span class="sourceLineNo">147</span> }<a name="line.147"></a> -<span class="sourceLineNo">148</span><a name="line.148"></a> -<span class="sourceLineNo">149</span> /**<a name="line.149"></a> -<span class="sourceLineNo">150</span> * Returns the limit, in bytes, of the target (e.g. table, namespace).<a name="line.150"></a> -<span class="sourceLineNo">151</span> */<a name="line.151"></a> -<span class="sourceLineNo">152</span> public long getLimit() {<a name="line.152"></a> -<span class="sourceLineNo">153</span> return limit;<a name="line.153"></a> -<span class="sourceLineNo">154</span> }<a name="line.154"></a> -<span class="sourceLineNo">155</span><a name="line.155"></a> -<span class="sourceLineNo">156</span> @Override<a name="line.156"></a> -<span class="sourceLineNo">157</span> public int hashCode() {<a name="line.157"></a> -<span class="sourceLineNo">158</span> return new HashCodeBuilder()<a name="line.158"></a> -<span class="sourceLineNo">159</span> .append(quotaStatus.hashCode())<a name="line.159"></a> -<span class="sourceLineNo">160</span> .append(usage)<a name="line.160"></a> -<span class="sourceLineNo">161</span> .append(limit)<a name="line.161"></a> -<span class="sourceLineNo">162</span> .toHashCode();<a name="line.162"></a> -<span class="sourceLineNo">163</span> }<a name="line.163"></a> -<span class="sourceLineNo">164</span><a name="line.164"></a> -<span class="sourceLineNo">165</span> @Override<a name="line.165"></a> -<span class="sourceLineNo">166</span> public boolean equals(Object o) {<a name="line.166"></a> -<span class="sourceLineNo">167</span> if (o instanceof SpaceQuotaSnapshot) {<a name="line.167"></a> -<span class="sourceLineNo">168</span> SpaceQuotaSnapshot other = (SpaceQuotaSnapshot) o;<a name="line.168"></a> -<span class="sourceLineNo">169</span> return quotaStatus.equals(other.quotaStatus) && usage == other.usage && limit == other.limit;<a name="line.169"></a> -<span class="sourceLineNo">170</span> }<a name="line.170"></a> -<span class="sourceLineNo">171</span> return false;<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> @Override<a name="line.174"></a> -<span class="sourceLineNo">175</span> public String toString() {<a name="line.175"></a> -<span class="sourceLineNo">176</span> StringBuilder sb = new StringBuilder(32);<a name="line.176"></a> -<span class="sourceLineNo">177</span> sb.append("SpaceQuotaSnapshot[policy=").append(quotaStatus).append(", use=");<a name="line.177"></a> -<span class="sourceLineNo">178</span> sb.append(usage).append("bytes/").append(limit).append("bytes]");<a name="line.178"></a> -<span class="sourceLineNo">179</span> return sb.toString();<a name="line.179"></a> -<span class="sourceLineNo">180</span> }<a name="line.180"></a> -<span class="sourceLineNo">181</span><a name="line.181"></a> -<span class="sourceLineNo">182</span> // ProtobufUtil is in hbase-client, and this doesn't need to be public.<a name="line.182"></a> -<span class="sourceLineNo">183</span> public static SpaceQuotaSnapshot toSpaceQuotaSnapshot(QuotaProtos.SpaceQuotaSnapshot proto) {<a name="line.183"></a> -<span class="sourceLineNo">184</span> return new SpaceQuotaSnapshot(SpaceQuotaStatus.toStatus(proto.getQuotaStatus()),<a name="line.184"></a> -<span class="sourceLineNo">185</span> proto.getQuotaUsage(), proto.getQuotaLimit());<a name="line.185"></a> -<span class="sourceLineNo">186</span> }<a name="line.186"></a> -<span class="sourceLineNo">187</span><a name="line.187"></a> -<span class="sourceLineNo">188</span> public static QuotaProtos.SpaceQuotaSnapshot toProtoSnapshot(SpaceQuotaSnapshot snapshot) {<a name="line.188"></a> -<span class="sourceLineNo">189</span> return QuotaProtos.SpaceQuotaSnapshot.newBuilder()<a name="line.189"></a> -<span class="sourceLineNo">190</span> .setQuotaStatus(SpaceQuotaStatus.toProto(snapshot.getQuotaStatus()))<a name="line.190"></a> -<span class="sourceLineNo">191</span> .setQuotaUsage(snapshot.getUsage()).setQuotaLimit(snapshot.getLimit()).build();<a name="line.191"></a> -<span class="sourceLineNo">192</span> }<a name="line.192"></a> -<span class="sourceLineNo">193</span><a name="line.193"></a> -<span class="sourceLineNo">194</span> /**<a name="line.194"></a> -<span class="sourceLineNo">195</span> * Returns a singleton that corresponds to no snapshot information.<a name="line.195"></a> -<span class="sourceLineNo">196</span> */<a name="line.196"></a> -<span class="sourceLineNo">197</span> public static SpaceQuotaSnapshot getNoSuchSnapshot() {<a name="line.197"></a> -<span class="sourceLineNo">198</span> return NO_SUCH_SNAPSHOT;<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">025</span>import org.apache.hadoop.util.StringUtils;<a name="line.25"></a> +<span class="sourceLineNo">026</span><a name="line.26"></a> +<span class="sourceLineNo">027</span>/**<a name="line.27"></a> +<span class="sourceLineNo">028</span> * A point-in-time view of a space quota on a table.<a name="line.28"></a> +<span class="sourceLineNo">029</span> */<a name="line.29"></a> +<span class="sourceLineNo">030</span>@InterfaceAudience.Private<a name="line.30"></a> +<span class="sourceLineNo">031</span>public class SpaceQuotaSnapshot {<a name="line.31"></a> +<span class="sourceLineNo">032</span> private static final SpaceQuotaSnapshot NO_SUCH_SNAPSHOT = new SpaceQuotaSnapshot(<a name="line.32"></a> +<span class="sourceLineNo">033</span> SpaceQuotaStatus.notInViolation(), 0, Long.MAX_VALUE);<a name="line.33"></a> +<span class="sourceLineNo">034</span> private final SpaceQuotaStatus quotaStatus;<a name="line.34"></a> +<span class="sourceLineNo">035</span> private final long usage;<a name="line.35"></a> +<span class="sourceLineNo">036</span> private final long limit;<a name="line.36"></a> +<span class="sourceLineNo">037</span><a name="line.37"></a> +<span class="sourceLineNo">038</span> /**<a name="line.38"></a> +<span class="sourceLineNo">039</span> * Encapsulates the state of a quota on a table. The quota may or may not be in violation.<a name="line.39"></a> +<span class="sourceLineNo">040</span> * If the quota is not in violation, the violation may be null. If the quota is in violation,<a name="line.40"></a> +<span class="sourceLineNo">041</span> * there is guaranteed to be a non-null violation policy.<a name="line.41"></a> +<span class="sourceLineNo">042</span> */<a name="line.42"></a> +<span class="sourceLineNo">043</span> @InterfaceAudience.Private<a name="line.43"></a> +<span class="sourceLineNo">044</span> public static class SpaceQuotaStatus {<a name="line.44"></a> +<span class="sourceLineNo">045</span> private static final SpaceQuotaStatus NOT_IN_VIOLATION = new SpaceQuotaStatus(null, false);<a name="line.45"></a> +<span class="sourceLineNo">046</span> final SpaceViolationPolicy policy;<a name="line.46"></a> +<span class="sourceLineNo">047</span> final boolean inViolation;<a name="line.47"></a> +<span class="sourceLineNo">048</span><a name="line.48"></a> +<span class="sourceLineNo">049</span> /**<a name="line.49"></a> +<span class="sourceLineNo">050</span> * Constructs a {@code SpaceQuotaSnapshot} which is in violation of the provided {@code policy}.<a name="line.50"></a> +<span class="sourceLineNo">051</span> *<a name="line.51"></a> +<span class="sourceLineNo">052</span> * Use {@link #notInViolation()} to obtain an instance of this class for the cases when the<a name="line.52"></a> +<span class="sourceLineNo">053</span> * quota is not in violation.<a name="line.53"></a> +<span class="sourceLineNo">054</span> *<a name="line.54"></a> +<span class="sourceLineNo">055</span> * @param policy The non-null policy being violated.<a name="line.55"></a> +<span class="sourceLineNo">056</span> */<a name="line.56"></a> +<span class="sourceLineNo">057</span> public SpaceQuotaStatus(SpaceViolationPolicy policy) {<a name="line.57"></a> +<span class="sourceLineNo">058</span> // If the caller is instantiating a status, the policy must be non-null<a name="line.58"></a> +<span class="sourceLineNo">059</span> this (Objects.requireNonNull(policy), true);<a name="line.59"></a> +<span class="sourceLineNo">060</span> }<a name="line.60"></a> +<span class="sourceLineNo">061</span><a name="line.61"></a> +<span class="sourceLineNo">062</span> private SpaceQuotaStatus(SpaceViolationPolicy policy, boolean inViolation) {<a name="line.62"></a> +<span class="sourceLineNo">063</span> this.policy = policy;<a name="line.63"></a> +<span class="sourceLineNo">064</span> this.inViolation = inViolation;<a name="line.64"></a> +<span class="sourceLineNo">065</span> }<a name="line.65"></a> +<span class="sourceLineNo">066</span><a name="line.66"></a> +<span class="sourceLineNo">067</span> /**<a name="line.67"></a> +<span class="sourceLineNo">068</span> * Returns the violation policy, which may be null. It is guaranteed to be non-null if<a name="line.68"></a> +<span class="sourceLineNo">069</span> * {@link #isInViolation()} is {@code true}, but may be null otherwise.<a name="line.69"></a> +<span class="sourceLineNo">070</span> */<a name="line.70"></a> +<span class="sourceLineNo">071</span> public SpaceViolationPolicy getPolicy() {<a name="line.71"></a> +<span class="sourceLineNo">072</span> return policy;<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> * @return {@code true} if the quota is being violated, {@code false} otherwise.<a name="line.76"></a> +<span class="sourceLineNo">077</span> */<a name="line.77"></a> +<span class="sourceLineNo">078</span> public boolean isInViolation() {<a name="line.78"></a> +<span class="sourceLineNo">079</span> return inViolation;<a name="line.79"></a> +<span class="sourceLineNo">080</span> }<a name="line.80"></a> +<span class="sourceLineNo">081</span><a name="line.81"></a> +<span class="sourceLineNo">082</span> /**<a name="line.82"></a> +<span class="sourceLineNo">083</span> * Returns a singleton referring to a quota which is not in violation.<a name="line.83"></a> +<span class="sourceLineNo">084</span> */<a name="line.84"></a> +<span class="sourceLineNo">085</span> public static SpaceQuotaStatus notInViolation() {<a name="line.85"></a> +<span class="sourceLineNo">086</span> return NOT_IN_VIOLATION;<a name="line.86"></a> +<span class="sourceLineNo">087</span> }<a name="line.87"></a> +<span class="sourceLineNo">088</span><a name="line.88"></a> +<span class="sourceLineNo">089</span> @Override<a name="line.89"></a> +<span class="sourceLineNo">090</span> public int hashCode() {<a name="line.90"></a> +<span class="sourceLineNo">091</span> return new HashCodeBuilder().append(policy == null ? 0 : policy.hashCode())<a name="line.91"></a> +<span class="sourceLineNo">092</span> .append(inViolation).toHashCode();<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 equals(Object o) {<a name="line.96"></a> +<span class="sourceLineNo">097</span> if (o instanceof SpaceQuotaStatus) {<a name="line.97"></a> +<span class="sourceLineNo">098</span> SpaceQuotaStatus other = (SpaceQuotaStatus) o;<a name="line.98"></a> +<span class="sourceLineNo">099</span> return Objects.equals(policy, other.policy) && inViolation == other.inViolation;<a name="line.99"></a> +<span class="sourceLineNo">100</span> }<a name="line.100"></a> +<span class="sourceLineNo">101</span> return false;<a name="line.101"></a> +<span class="sourceLineNo">102</span> }<a name="line.102"></a> +<span class="sourceLineNo">103</span><a name="line.103"></a> +<span class="sourceLineNo">104</span> @Override<a name="line.104"></a> +<span class="sourceLineNo">105</span> public String toString() {<a name="line.105"></a> +<span class="sourceLineNo">106</span> StringBuilder sb = new StringBuilder(getClass().getSimpleName());<a name="line.106"></a> +<span class="sourceLineNo">107</span> sb.append("[policy=").append(policy);<a name="line.107"></a> +<span class="sourceLineNo">108</span> sb.append(", inViolation=").append(inViolation).append("]");<a name="line.108"></a> +<span class="sourceLineNo">109</span> return sb.toString();<a name="line.109"></a> +<span class="sourceLineNo">110</span> }<a name="line.110"></a> +<span class="sourceLineNo">111</span><a name="line.111"></a> +<span class="sourceLineNo">112</span> public static QuotaProtos.SpaceQuotaStatus toProto(SpaceQuotaStatus status) {<a name="line.112"></a> +<span class="sourceLineNo">113</span> QuotaProtos.SpaceQuotaStatus.Builder builder = QuotaProtos.SpaceQuotaStatus.newBuilder();<a name="line.113"></a> +<span class="sourceLineNo">114</span> builder.setInViolation(status.inViolation);<a name="line.114"></a> +<span class="sourceLineNo">115</span> if (status.isInViolation()) {<a name="line.115"></a> +<span class="sourceLineNo">116</span> builder.setViolationPolicy(ProtobufUtil.toProtoViolationPolicy(status.getPolicy()));<a name="line.116"></a> +<span class="sourceLineNo">117</span> }<a name="line.117"></a> +<span class="sourceLineNo">118</span> return builder.build();<a name="line.118"></a> +<span class="sourceLineNo">119</span> }<a name="line.119"></a> +<span class="sourceLineNo">120</span><a name="line.120"></a> +<span class="sourceLineNo">121</span> public static SpaceQuotaStatus toStatus(QuotaProtos.SpaceQuotaStatus proto) {<a name="line.121"></a> +<span class="sourceLineNo">122</span> if (proto.getInViolation()) {<a name="line.122"></a> +<span class="sourceLineNo">123</span> return new SpaceQuotaStatus(ProtobufUtil.toViolationPolicy(proto.getViolationPolicy()));<a name="line.123"></a> +<span class="sourceLineNo">124</span> } else {<a name="line.124"></a> +<span class="sourceLineNo">125</span> return NOT_IN_VIOLATION;<a name="line.125"></a> +<span class="sourceLineNo">126</span> }<a name="line.126"></a> +<span class="sourceLineNo">127</span> }<a name="line.127"></a> +<span class="sourceLineNo">128</span> }<a name="line.128"></a> +<span class="sourceLineNo">129</span><a name="line.129"></a> +<span class="sourceLineNo">130</span> public SpaceQuotaSnapshot(SpaceQuotaStatus quotaStatus, long usage, long limit) {<a name="line.130"></a> +<span class="sourceLineNo">131</span> this.quotaStatus = Objects.requireNonNull(quotaStatus);<a name="line.131"></a> +<span class="sourceLineNo">132</span> this.usage = usage;<a name="line.132"></a> +<span class="sourceLineNo">133</span> this.limit = limit;<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> /**<a name="line.136"></a> +<span class="sourceLineNo">137</span> * Returns the status of the quota.<a name="line.137"></a> +<span class="sourceLineNo">138</span> */<a name="line.138"></a> +<span class="sourceLineNo">139</span> public SpaceQuotaStatus getQuotaStatus() {<a name="line.139"></a> +<span class="sourceLineNo">140</span> return quotaStatus;<a name="line.140"></a> +<span class="sourceLineNo">141</span> }<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> * Returns the current usage, in bytes, of the target (e.g. table, namespace).<a name="line.144"></a> +<span class="sourceLineNo">145</span> */<a name="line.145"></a> +<span class="sourceLineNo">146</span> public long getUsage() {<a name="line.146"></a> +<span class="sourceLineNo">147</span> return usage;<a name="line.147"></a> +<span class="sourceLineNo">148</span> }<a name="line.148"></a> +<span class="sourceLineNo">149</span><a name="line.149"></a> +<span class="sourceLineNo">150</span> /**<a name="line.150"></a> +<span class="sourceLineNo">151</span> * Returns the limit, in bytes, of the target (e.g. table, namespace).<a name="line.151"></a> +<span class="sourceLineNo">152</span> */<a name="line.152"></a> +<span class="sourceLineNo">153</span> public long getLimit() {<a name="line.153"></a> +<span class="sourceLineNo">154</span> return limit;<a name="line.154"></a> +<span class="sourceLineNo">155</span> }<a name="line.155"></a> +<span class="sourceLineNo">156</span><a name="line.156"></a> +<span class="sourceLineNo">157</span> @Override<a name="line.157"></a> +<span class="sourceLineNo">158</span> public int hashCode() {<a name="line.158"></a> +<span class="sourceLineNo">159</span> return new HashCodeBuilder()<a name="line.159"></a> +<span class="sourceLineNo">160</span> .append(quotaStatus.hashCode())<a name="line.160"></a> +<span class="sourceLineNo">161</span> .append(usage)<a name="line.161"></a> +<span class="sourceLineNo">162</span> .append(limit)<a name="line.162"></a> +<span class="sourceLineNo">163</span> .toHashCode();<a name="line.163"></a> +<span class="sourceLineNo">164</span> }<a name="line.164"></a> +<span class="sourceLineNo">165</span><a name="line.165"></a> +<span class="sourceLineNo">166</span> @Override<a name="line.166"></a> +<span class="sourceLineNo">167</span> public boolean equals(Object o) {<a name="line.167"></a> +<span class="sourceLineNo">168</span> if (o instanceof SpaceQuotaSnapshot) {<a name="line.168"></a> +<span class="sourceLineNo">169</span> SpaceQuotaSnapshot other = (SpaceQuotaSnapshot) o;<a name="line.169"></a> +<span class="sourceLineNo">170</span> return quotaStatus.equals(other.quotaStatus) && usage == other.usage && limit == other.limit;<a name="line.170"></a> +<span class="sourceLineNo">171</span> }<a name="line.171"></a> +<span class="sourceLineNo">172</span> return false;<a name="line.172"></a> +<span class="sourceLineNo">173</span> }<a name="line.173"></a> +<span class="sourceLineNo">174</span><a name="line.174"></a> +<span class="sourceLineNo">175</span> @Override<a name="line.175"></a> +<span class="sourceLineNo">176</span> public String toString() {<a name="line.176"></a> +<span class="sourceLineNo">177</span> StringBuilder sb = new StringBuilder(32);<a name="line.177"></a> +<span class="sourceLineNo">178</span> sb.append("SpaceQuotaSnapshot[policy=").append(quotaStatus).append(", use=");<a name="line.178"></a> +<span class="sourceLineNo">179</span> sb.append(StringUtils.byteDesc(usage)).append("/");<a name="line.179"></a> +<span class="sourceLineNo">180</span> sb.append(StringUtils.byteDesc(limit)).append("]");<a name="line.180"></a> +<span class="sourceLineNo">181</span> return sb.toString();<a name="line.181"></a> +<span class="sourceLineNo">182</span> }<a name="line.182"></a> +<span class="sourceLineNo">183</span><a name="line.183"></a> +<span class="sourceLineNo">184</span> // ProtobufUtil is in hbase-client, and this doesn't need to be public.<a name="line.184"></a> +<span class="sourceLineNo">185</span> public static SpaceQuotaSnapshot toSpaceQuotaSnapshot(QuotaProtos.SpaceQuotaSnapshot proto) {<a name="line.185"></a> +<span class="sourceLineNo">186</span> return new SpaceQuotaSnapshot(SpaceQuotaStatus.toStatus(proto.getQuotaStatus()),<a name="line.186"></a> +<span class="sourceLineNo">187</span> proto.getQuotaUsage(), proto.getQuotaLimit());<a name="line.187"></a> +<span class="sourceLineNo">188</span> }<a name="line.188"></a> +<span class="sourceLineNo">189</span><a name="line.189"></a> +<span class="sourceLineNo">190</span> public static QuotaProtos.SpaceQuotaSnapshot toProtoSnapshot(SpaceQuotaSnapshot snapshot) {<a name="line.190"></a> +<span class="sourceLineNo">191</span> return QuotaProtos.SpaceQuotaSnapshot.newBuilder()<a name="line.191"></a> +<span class="sourceLineNo">192</span> .setQuotaStatus(SpaceQuotaStatus.toProto(snapshot.getQuotaStatus()))<a name="line.192"></a> +<span class="sourceLineNo">193</span> .setQuotaUsage(snapshot.getUsage()).setQuotaLimit(snapshot.getLimit()).build();<a name="line.193"></a> +<span class="sourceLineNo">194</span> }<a name="line.194"></a> +<span class="sourceLineNo">195</span><a name="line.195"></a> +<span class="sourceLineNo">196</span> /**<a name="line.196"></a> +<span class="sourceLineNo">197</span> * Returns a singleton that corresponds to no snapshot information.<a name="line.197"></a> +<span class="sourceLineNo">198</span> */<a name="line.198"></a> +<span class="sourceLineNo">199</span> public static SpaceQuotaSnapshot getNoSuchSnapshot() {<a name="line.199"></a> +<span class="sourceLineNo">200</span> return NO_SUCH_SNAPSHOT;<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>
