blob: bfa2deadf8c9ac306c2eb5e069c89bbcb8ad8af2 [file] [log] [blame]
<!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<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>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a>
<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a>
<span class="sourceLineNo">017</span> */<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>package org.apache.hadoop.hbase.regionserver;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.hadoop.conf.Configuration;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.hadoop.hbase.CellComparator;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.client.ColumnFamilyDescriptor;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.HConstants;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.KeepDeletedCells;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.util.ClassSize;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span>/**<a name="line.30"></a>
<span class="sourceLineNo">031</span> * Immutable information for scans over a store.<a name="line.31"></a>
<span class="sourceLineNo">032</span> */<a name="line.32"></a>
<span class="sourceLineNo">033</span>// Has to be public for PartitionedMobCompactor to access; ditto on tests making use of a few of<a name="line.33"></a>
<span class="sourceLineNo">034</span>// the accessors below. Shutdown access. TODO<a name="line.34"></a>
<span class="sourceLineNo">035</span>@InterfaceAudience.Private<a name="line.35"></a>
<span class="sourceLineNo">036</span>public class ScanInfo {<a name="line.36"></a>
<span class="sourceLineNo">037</span> private byte[] family;<a name="line.37"></a>
<span class="sourceLineNo">038</span> private int minVersions;<a name="line.38"></a>
<span class="sourceLineNo">039</span> private int maxVersions;<a name="line.39"></a>
<span class="sourceLineNo">040</span> private long ttl;<a name="line.40"></a>
<span class="sourceLineNo">041</span> private KeepDeletedCells keepDeletedCells;<a name="line.41"></a>
<span class="sourceLineNo">042</span> private long timeToPurgeDeletes;<a name="line.42"></a>
<span class="sourceLineNo">043</span> private CellComparator comparator;<a name="line.43"></a>
<span class="sourceLineNo">044</span> private long tableMaxRowSize;<a name="line.44"></a>
<span class="sourceLineNo">045</span> private boolean usePread;<a name="line.45"></a>
<span class="sourceLineNo">046</span> private long cellsPerTimeoutCheck;<a name="line.46"></a>
<span class="sourceLineNo">047</span> private boolean parallelSeekEnabled;<a name="line.47"></a>
<span class="sourceLineNo">048</span> private final long preadMaxBytes;<a name="line.48"></a>
<span class="sourceLineNo">049</span> private final boolean newVersionBehavior;<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> public static final long FIXED_OVERHEAD = ClassSize.align(ClassSize.OBJECT<a name="line.51"></a>
<span class="sourceLineNo">052</span> + (2 * ClassSize.REFERENCE) + (2 * Bytes.SIZEOF_INT)<a name="line.52"></a>
<span class="sourceLineNo">053</span> + (4 * Bytes.SIZEOF_LONG) + (4 * Bytes.SIZEOF_BOOLEAN));<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> /**<a name="line.55"></a>
<span class="sourceLineNo">056</span> * @param conf<a name="line.56"></a>
<span class="sourceLineNo">057</span> * @param family {@link ColumnFamilyDescriptor} describing the column family<a name="line.57"></a>
<span class="sourceLineNo">058</span> * @param ttl Store's TTL (in ms)<a name="line.58"></a>
<span class="sourceLineNo">059</span> * @param timeToPurgeDeletes duration in ms after which a delete marker can be purged during a<a name="line.59"></a>
<span class="sourceLineNo">060</span> * major compaction.<a name="line.60"></a>
<span class="sourceLineNo">061</span> * @param comparator The store's comparator<a name="line.61"></a>
<span class="sourceLineNo">062</span> */<a name="line.62"></a>
<span class="sourceLineNo">063</span> public ScanInfo(Configuration conf, ColumnFamilyDescriptor family, long ttl,<a name="line.63"></a>
<span class="sourceLineNo">064</span> long timeToPurgeDeletes, CellComparator comparator) {<a name="line.64"></a>
<span class="sourceLineNo">065</span> this(conf, family.getName(), family.getMinVersions(), family.getMaxVersions(), ttl,<a name="line.65"></a>
<span class="sourceLineNo">066</span> family.getKeepDeletedCells(), family.getBlocksize(), timeToPurgeDeletes, comparator,<a name="line.66"></a>
<span class="sourceLineNo">067</span> family.isNewVersionBehavior());<a name="line.67"></a>
<span class="sourceLineNo">068</span> }<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span> private static long getCellsPerTimeoutCheck(Configuration conf) {<a name="line.70"></a>
<span class="sourceLineNo">071</span> long perHeartbeat = conf.getLong(StoreScanner.HBASE_CELLS_SCANNED_PER_HEARTBEAT_CHECK,<a name="line.71"></a>
<span class="sourceLineNo">072</span> StoreScanner.DEFAULT_HBASE_CELLS_SCANNED_PER_HEARTBEAT_CHECK);<a name="line.72"></a>
<span class="sourceLineNo">073</span> return perHeartbeat &gt; 0 ? perHeartbeat<a name="line.73"></a>
<span class="sourceLineNo">074</span> : StoreScanner.DEFAULT_HBASE_CELLS_SCANNED_PER_HEARTBEAT_CHECK;<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> * @param conf<a name="line.78"></a>
<span class="sourceLineNo">079</span> * @param family Name of this store's column family<a name="line.79"></a>
<span class="sourceLineNo">080</span> * @param minVersions Store's MIN_VERSIONS setting<a name="line.80"></a>
<span class="sourceLineNo">081</span> * @param maxVersions Store's VERSIONS setting<a name="line.81"></a>
<span class="sourceLineNo">082</span> * @param ttl Store's TTL (in ms)<a name="line.82"></a>
<span class="sourceLineNo">083</span> * @param blockSize Store's block size<a name="line.83"></a>
<span class="sourceLineNo">084</span> * @param timeToPurgeDeletes duration in ms after which a delete marker can<a name="line.84"></a>
<span class="sourceLineNo">085</span> * be purged during a major compaction.<a name="line.85"></a>
<span class="sourceLineNo">086</span> * @param keepDeletedCells Store's keepDeletedCells setting<a name="line.86"></a>
<span class="sourceLineNo">087</span> * @param comparator The store's comparator<a name="line.87"></a>
<span class="sourceLineNo">088</span> */<a name="line.88"></a>
<span class="sourceLineNo">089</span> public ScanInfo(Configuration conf, byte[] family, int minVersions, int maxVersions, long ttl,<a name="line.89"></a>
<span class="sourceLineNo">090</span> KeepDeletedCells keepDeletedCells, long blockSize, long timeToPurgeDeletes,<a name="line.90"></a>
<span class="sourceLineNo">091</span> CellComparator comparator, boolean newVersionBehavior) {<a name="line.91"></a>
<span class="sourceLineNo">092</span> this(family, minVersions, maxVersions, ttl, keepDeletedCells, timeToPurgeDeletes, comparator,<a name="line.92"></a>
<span class="sourceLineNo">093</span> conf.getLong(HConstants.TABLE_MAX_ROWSIZE_KEY, HConstants.TABLE_MAX_ROWSIZE_DEFAULT),<a name="line.93"></a>
<span class="sourceLineNo">094</span> conf.getBoolean("hbase.storescanner.use.pread", false), getCellsPerTimeoutCheck(conf),<a name="line.94"></a>
<span class="sourceLineNo">095</span> conf.getBoolean(StoreScanner.STORESCANNER_PARALLEL_SEEK_ENABLE, false),<a name="line.95"></a>
<span class="sourceLineNo">096</span> conf.getLong(StoreScanner.STORESCANNER_PREAD_MAX_BYTES, 4 * blockSize), newVersionBehavior);<a name="line.96"></a>
<span class="sourceLineNo">097</span> }<a name="line.97"></a>
<span class="sourceLineNo">098</span><a name="line.98"></a>
<span class="sourceLineNo">099</span> private ScanInfo(byte[] family, int minVersions, int maxVersions, long ttl,<a name="line.99"></a>
<span class="sourceLineNo">100</span> KeepDeletedCells keepDeletedCells, long timeToPurgeDeletes, CellComparator comparator,<a name="line.100"></a>
<span class="sourceLineNo">101</span> long tableMaxRowSize, boolean usePread, long cellsPerTimeoutCheck,<a name="line.101"></a>
<span class="sourceLineNo">102</span> boolean parallelSeekEnabled, long preadMaxBytes, boolean newVersionBehavior) {<a name="line.102"></a>
<span class="sourceLineNo">103</span> this.family = family;<a name="line.103"></a>
<span class="sourceLineNo">104</span> this.minVersions = minVersions;<a name="line.104"></a>
<span class="sourceLineNo">105</span> this.maxVersions = maxVersions;<a name="line.105"></a>
<span class="sourceLineNo">106</span> this.ttl = ttl;<a name="line.106"></a>
<span class="sourceLineNo">107</span> this.keepDeletedCells = keepDeletedCells;<a name="line.107"></a>
<span class="sourceLineNo">108</span> this.timeToPurgeDeletes = timeToPurgeDeletes;<a name="line.108"></a>
<span class="sourceLineNo">109</span> this.comparator = comparator;<a name="line.109"></a>
<span class="sourceLineNo">110</span> this.tableMaxRowSize = tableMaxRowSize;<a name="line.110"></a>
<span class="sourceLineNo">111</span> this.usePread = usePread;<a name="line.111"></a>
<span class="sourceLineNo">112</span> this.cellsPerTimeoutCheck = cellsPerTimeoutCheck;<a name="line.112"></a>
<span class="sourceLineNo">113</span> this.parallelSeekEnabled = parallelSeekEnabled;<a name="line.113"></a>
<span class="sourceLineNo">114</span> this.preadMaxBytes = preadMaxBytes;<a name="line.114"></a>
<span class="sourceLineNo">115</span> this.newVersionBehavior = newVersionBehavior;<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span> long getTableMaxRowSize() {<a name="line.118"></a>
<span class="sourceLineNo">119</span> return this.tableMaxRowSize;<a name="line.119"></a>
<span class="sourceLineNo">120</span> }<a name="line.120"></a>
<span class="sourceLineNo">121</span><a name="line.121"></a>
<span class="sourceLineNo">122</span> boolean isUsePread() {<a name="line.122"></a>
<span class="sourceLineNo">123</span> return this.usePread;<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> long getCellsPerTimeoutCheck() {<a name="line.126"></a>
<span class="sourceLineNo">127</span> return this.cellsPerTimeoutCheck;<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> boolean isParallelSeekEnabled() {<a name="line.130"></a>
<span class="sourceLineNo">131</span> return this.parallelSeekEnabled;<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> public byte[] getFamily() {<a name="line.134"></a>
<span class="sourceLineNo">135</span> return family;<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> public int getMinVersions() {<a name="line.138"></a>
<span class="sourceLineNo">139</span> return minVersions;<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> public int getMaxVersions() {<a name="line.142"></a>
<span class="sourceLineNo">143</span> return maxVersions;<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> public long getTtl() {<a name="line.146"></a>
<span class="sourceLineNo">147</span> return ttl;<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> public KeepDeletedCells getKeepDeletedCells() {<a name="line.150"></a>
<span class="sourceLineNo">151</span> return keepDeletedCells;<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> public long getTimeToPurgeDeletes() {<a name="line.154"></a>
<span class="sourceLineNo">155</span> return timeToPurgeDeletes;<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> public CellComparator getComparator() {<a name="line.158"></a>
<span class="sourceLineNo">159</span> return comparator;<a name="line.159"></a>
<span class="sourceLineNo">160</span> }<a name="line.160"></a>
<span class="sourceLineNo">161</span><a name="line.161"></a>
<span class="sourceLineNo">162</span> long getPreadMaxBytes() {<a name="line.162"></a>
<span class="sourceLineNo">163</span> return preadMaxBytes;<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> public boolean isNewVersionBehavior() {<a name="line.166"></a>
<span class="sourceLineNo">167</span> return newVersionBehavior;<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> /**<a name="line.170"></a>
<span class="sourceLineNo">171</span> * Used by CP users for customizing max versions, ttl and keepDeletedCells.<a name="line.171"></a>
<span class="sourceLineNo">172</span> */<a name="line.172"></a>
<span class="sourceLineNo">173</span> ScanInfo customize(int maxVersions, long ttl, KeepDeletedCells keepDeletedCells) {<a name="line.173"></a>
<span class="sourceLineNo">174</span> return customize(maxVersions, ttl, keepDeletedCells, minVersions, timeToPurgeDeletes);<a name="line.174"></a>
<span class="sourceLineNo">175</span> }<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> * Used by CP users for customizing max versions, ttl, keepDeletedCells, min versions,<a name="line.178"></a>
<span class="sourceLineNo">179</span> * and time to purge deletes.<a name="line.179"></a>
<span class="sourceLineNo">180</span> */<a name="line.180"></a>
<span class="sourceLineNo">181</span> ScanInfo customize(int maxVersions, long ttl, KeepDeletedCells keepDeletedCells,<a name="line.181"></a>
<span class="sourceLineNo">182</span> int minVersions, long timeToPurgeDeletes) {<a name="line.182"></a>
<span class="sourceLineNo">183</span> return new ScanInfo(family, minVersions, maxVersions, ttl, keepDeletedCells, timeToPurgeDeletes,<a name="line.183"></a>
<span class="sourceLineNo">184</span> comparator, tableMaxRowSize, usePread, cellsPerTimeoutCheck, parallelSeekEnabled,<a name="line.184"></a>
<span class="sourceLineNo">185</span> preadMaxBytes, newVersionBehavior);<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>
</pre>
</div>
</body>
</html>