blob: 0ea817dc6781795826078234646d7a1ce3ba0e1f [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> *<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.3"></a>
<span class="sourceLineNo">004</span> * or more contributor license agreements. See the NOTICE file<a name="line.4"></a>
<span class="sourceLineNo">005</span> * distributed with this work for additional information<a name="line.5"></a>
<span class="sourceLineNo">006</span> * regarding copyright ownership. The ASF licenses this file<a name="line.6"></a>
<span class="sourceLineNo">007</span> * to you under the Apache License, Version 2.0 (the<a name="line.7"></a>
<span class="sourceLineNo">008</span> * "License"); you may not use this file except in compliance<a name="line.8"></a>
<span class="sourceLineNo">009</span> * with the License. You may obtain a copy of the License at<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.11"></a>
<span class="sourceLineNo">012</span> *<a name="line.12"></a>
<span class="sourceLineNo">013</span> * Unless required by applicable law or agreed to in writing, software<a name="line.13"></a>
<span class="sourceLineNo">014</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.14"></a>
<span class="sourceLineNo">015</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.15"></a>
<span class="sourceLineNo">016</span> * See the License for the specific language governing permissions and<a name="line.16"></a>
<span class="sourceLineNo">017</span> * limitations under the License.<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.yetus.audience.InterfaceAudience;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.slf4j.Logger;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.slf4j.LoggerFactory;<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> * MemStoreCompactionStrategy is the root of a class hierarchy which defines the strategy for<a name="line.27"></a>
<span class="sourceLineNo">028</span> * choosing the next action to apply in an (in-memory) memstore compaction.<a name="line.28"></a>
<span class="sourceLineNo">029</span> * Possible action are:<a name="line.29"></a>
<span class="sourceLineNo">030</span> * - No-op - do nothing<a name="line.30"></a>
<span class="sourceLineNo">031</span> * - Flatten - to change the segment's index from CSLM to a flat representation<a name="line.31"></a>
<span class="sourceLineNo">032</span> * - Merge - to merge the indices of the segments in the pipeline<a name="line.32"></a>
<span class="sourceLineNo">033</span> * - Compact - to merge the indices while removing data redundancies<a name="line.33"></a>
<span class="sourceLineNo">034</span> *<a name="line.34"></a>
<span class="sourceLineNo">035</span> * In addition while applying flat/merge actions it is possible to count the number of unique<a name="line.35"></a>
<span class="sourceLineNo">036</span> * keys in the result segment.<a name="line.36"></a>
<span class="sourceLineNo">037</span> */<a name="line.37"></a>
<span class="sourceLineNo">038</span>@InterfaceAudience.Private<a name="line.38"></a>
<span class="sourceLineNo">039</span>public abstract class MemStoreCompactionStrategy {<a name="line.39"></a>
<span class="sourceLineNo">040</span><a name="line.40"></a>
<span class="sourceLineNo">041</span> protected static final Logger LOG = LoggerFactory.getLogger(MemStoreCompactionStrategy.class);<a name="line.41"></a>
<span class="sourceLineNo">042</span> // The upper bound for the number of segments we store in the pipeline prior to merging.<a name="line.42"></a>
<span class="sourceLineNo">043</span> public static final String COMPACTING_MEMSTORE_THRESHOLD_KEY =<a name="line.43"></a>
<span class="sourceLineNo">044</span> "hbase.hregion.compacting.pipeline.segments.limit";<a name="line.44"></a>
<span class="sourceLineNo">045</span> public static final int COMPACTING_MEMSTORE_THRESHOLD_DEFAULT = 2;<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span> /**<a name="line.47"></a>
<span class="sourceLineNo">048</span> * Types of actions to be done on the pipeline upon MemStoreCompaction invocation.<a name="line.48"></a>
<span class="sourceLineNo">049</span> * Note that every value covers the previous ones, i.e. if MERGE is the action it implies<a name="line.49"></a>
<span class="sourceLineNo">050</span> * that the youngest segment is going to be flatten anyway.<a name="line.50"></a>
<span class="sourceLineNo">051</span> */<a name="line.51"></a>
<span class="sourceLineNo">052</span> public enum Action {<a name="line.52"></a>
<span class="sourceLineNo">053</span> NOOP,<a name="line.53"></a>
<span class="sourceLineNo">054</span> FLATTEN, // flatten a segment in the pipeline<a name="line.54"></a>
<span class="sourceLineNo">055</span> FLATTEN_COUNT_UNIQUE_KEYS, // flatten a segment in the pipeline and count its unique keys<a name="line.55"></a>
<span class="sourceLineNo">056</span> MERGE, // merge all the segments in the pipeline into one<a name="line.56"></a>
<span class="sourceLineNo">057</span> MERGE_COUNT_UNIQUE_KEYS, // merge all pipeline segments into one and count its unique keys<a name="line.57"></a>
<span class="sourceLineNo">058</span> COMPACT // compact the data of all pipeline segments<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> protected final String cfName;<a name="line.61"></a>
<span class="sourceLineNo">062</span> // The limit on the number of the segments in the pipeline<a name="line.62"></a>
<span class="sourceLineNo">063</span> protected final int pipelineThreshold;<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> public MemStoreCompactionStrategy(Configuration conf, String cfName) {<a name="line.66"></a>
<span class="sourceLineNo">067</span> this.cfName = cfName;<a name="line.67"></a>
<span class="sourceLineNo">068</span> if(conf == null) {<a name="line.68"></a>
<span class="sourceLineNo">069</span> pipelineThreshold = COMPACTING_MEMSTORE_THRESHOLD_DEFAULT;<a name="line.69"></a>
<span class="sourceLineNo">070</span> } else {<a name="line.70"></a>
<span class="sourceLineNo">071</span> pipelineThreshold = // get the limit on the number of the segments in the pipeline<a name="line.71"></a>
<span class="sourceLineNo">072</span> conf.getInt(COMPACTING_MEMSTORE_THRESHOLD_KEY, COMPACTING_MEMSTORE_THRESHOLD_DEFAULT);<a name="line.72"></a>
<span class="sourceLineNo">073</span> }<a name="line.73"></a>
<span class="sourceLineNo">074</span> }<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span> @Override<a name="line.76"></a>
<span class="sourceLineNo">077</span> public String toString() {<a name="line.77"></a>
<span class="sourceLineNo">078</span> return getName() + ", pipelineThreshold=" + this.pipelineThreshold;<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> protected abstract String getName();<a name="line.81"></a>
<span class="sourceLineNo">082</span><a name="line.82"></a>
<span class="sourceLineNo">083</span> // get next compaction action to apply on compaction pipeline<a name="line.83"></a>
<span class="sourceLineNo">084</span> public abstract Action getAction(VersionedSegmentsList versionedList);<a name="line.84"></a>
<span class="sourceLineNo">085</span> // update policy stats based on the segment that replaced previous versioned list (in<a name="line.85"></a>
<span class="sourceLineNo">086</span> // compaction pipeline)<a name="line.86"></a>
<span class="sourceLineNo">087</span> public void updateStats(Segment replacement) {}<a name="line.87"></a>
<span class="sourceLineNo">088</span> // resets policy stats<a name="line.88"></a>
<span class="sourceLineNo">089</span> public void resetStats() {}<a name="line.89"></a>
<span class="sourceLineNo">090</span><a name="line.90"></a>
<span class="sourceLineNo">091</span> protected Action simpleMergeOrFlatten(VersionedSegmentsList versionedList, String strategy) {<a name="line.91"></a>
<span class="sourceLineNo">092</span> int numOfSegments = versionedList.getNumOfSegments();<a name="line.92"></a>
<span class="sourceLineNo">093</span> if (numOfSegments &gt; pipelineThreshold) {<a name="line.93"></a>
<span class="sourceLineNo">094</span> // to avoid too many segments, merge now<a name="line.94"></a>
<span class="sourceLineNo">095</span> LOG.trace("Strategy={}, store={}; merging {} segments", strategy, cfName, numOfSegments);<a name="line.95"></a>
<span class="sourceLineNo">096</span> return getMergingAction();<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> // just flatten a segment<a name="line.99"></a>
<span class="sourceLineNo">100</span> LOG.trace("Strategy={}, store={}; flattening a segment", strategy, cfName);<a name="line.100"></a>
<span class="sourceLineNo">101</span> return getFlattenAction();<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> protected Action getMergingAction() {<a name="line.104"></a>
<span class="sourceLineNo">105</span> return Action.MERGE;<a name="line.105"></a>
<span class="sourceLineNo">106</span> }<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span> protected Action getFlattenAction() {<a name="line.108"></a>
<span class="sourceLineNo">109</span> return Action.FLATTEN;<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> protected Action compact(VersionedSegmentsList versionedList, String strategyInfo) {<a name="line.112"></a>
<span class="sourceLineNo">113</span> int numOfSegments = versionedList.getNumOfSegments();<a name="line.113"></a>
<span class="sourceLineNo">114</span> LOG.trace("{} in-memory compaction for store={} compacting {} segments", strategyInfo,<a name="line.114"></a>
<span class="sourceLineNo">115</span> cfName, numOfSegments);<a name="line.115"></a>
<span class="sourceLineNo">116</span> return Action.COMPACT;<a name="line.116"></a>
<span class="sourceLineNo">117</span> }<a name="line.117"></a>
<span class="sourceLineNo">118</span>}<a name="line.118"></a>
</pre>
</div>
</body>
</html>