| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.hadoop.hbase.regionserver.compactions, class: RatioBasedCompactionPolicy"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.regionserver.compactions;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import java.io.IOException;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.util.ArrayList;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.Collection;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.util.List;</span> |
| <span class="source-line-no">024</span><span id="line-24">import java.util.OptionalLong;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.HConstants;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.regionserver.HStore;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.regionserver.HStoreFile;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.regionserver.StoreConfigInformation;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.regionserver.StoreUtils;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.util.DNS;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;</span> |
| <span class="source-line-no">033</span><span id="line-33">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">034</span><span id="line-34">import org.slf4j.Logger;</span> |
| <span class="source-line-no">035</span><span id="line-35">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">036</span><span id="line-36"></span> |
| <span class="source-line-no">037</span><span id="line-37">/**</span> |
| <span class="source-line-no">038</span><span id="line-38"> * The default algorithm for selecting files for compaction. Combines the compaction configuration</span> |
| <span class="source-line-no">039</span><span id="line-39"> * and the provisional file selection that it's given to produce the list of suitable candidates for</span> |
| <span class="source-line-no">040</span><span id="line-40"> * compaction.</span> |
| <span class="source-line-no">041</span><span id="line-41"> */</span> |
| <span class="source-line-no">042</span><span id="line-42">@InterfaceAudience.Private</span> |
| <span class="source-line-no">043</span><span id="line-43">public class RatioBasedCompactionPolicy extends SortedCompactionPolicy {</span> |
| <span class="source-line-no">044</span><span id="line-44"> private static final Logger LOG = LoggerFactory.getLogger(RatioBasedCompactionPolicy.class);</span> |
| <span class="source-line-no">045</span><span id="line-45"></span> |
| <span class="source-line-no">046</span><span id="line-46"> public RatioBasedCompactionPolicy(Configuration conf, StoreConfigInformation storeConfigInfo) {</span> |
| <span class="source-line-no">047</span><span id="line-47"> super(conf, storeConfigInfo);</span> |
| <span class="source-line-no">048</span><span id="line-48"> }</span> |
| <span class="source-line-no">049</span><span id="line-49"></span> |
| <span class="source-line-no">050</span><span id="line-50"> /*</span> |
| <span class="source-line-no">051</span><span id="line-51"> * @param filesToCompact Files to compact. Can be null.</span> |
| <span class="source-line-no">052</span><span id="line-52"> * @return True if we should run a major compaction.</span> |
| <span class="source-line-no">053</span><span id="line-53"> */</span> |
| <span class="source-line-no">054</span><span id="line-54"> @Override</span> |
| <span class="source-line-no">055</span><span id="line-55"> public boolean shouldPerformMajorCompaction(Collection<HStoreFile> filesToCompact)</span> |
| <span class="source-line-no">056</span><span id="line-56"> throws IOException {</span> |
| <span class="source-line-no">057</span><span id="line-57"> boolean result = false;</span> |
| <span class="source-line-no">058</span><span id="line-58"> long mcTime = getNextMajorCompactTime(filesToCompact);</span> |
| <span class="source-line-no">059</span><span id="line-59"> if (filesToCompact == null || filesToCompact.isEmpty() || mcTime == 0) {</span> |
| <span class="source-line-no">060</span><span id="line-60"> return result;</span> |
| <span class="source-line-no">061</span><span id="line-61"> }</span> |
| <span class="source-line-no">062</span><span id="line-62"> // TODO: Use better method for determining stamp of last major (HBASE-2990)</span> |
| <span class="source-line-no">063</span><span id="line-63"> long lowTimestamp = StoreUtils.getLowestTimestamp(filesToCompact);</span> |
| <span class="source-line-no">064</span><span id="line-64"> long now = EnvironmentEdgeManager.currentTime();</span> |
| <span class="source-line-no">065</span><span id="line-65"> if (lowTimestamp > 0L && lowTimestamp < (now - mcTime)) {</span> |
| <span class="source-line-no">066</span><span id="line-66"> String regionInfo;</span> |
| <span class="source-line-no">067</span><span id="line-67"> if (this.storeConfigInfo != null && this.storeConfigInfo instanceof HStore) {</span> |
| <span class="source-line-no">068</span><span id="line-68"> regionInfo = ((HStore) this.storeConfigInfo).getRegionInfo().getRegionNameAsString();</span> |
| <span class="source-line-no">069</span><span id="line-69"> } else {</span> |
| <span class="source-line-no">070</span><span id="line-70"> regionInfo = this.toString();</span> |
| <span class="source-line-no">071</span><span id="line-71"> }</span> |
| <span class="source-line-no">072</span><span id="line-72"> // Major compaction time has elapsed.</span> |
| <span class="source-line-no">073</span><span id="line-73"> long cfTTL = HConstants.FOREVER;</span> |
| <span class="source-line-no">074</span><span id="line-74"> if (this.storeConfigInfo != null) {</span> |
| <span class="source-line-no">075</span><span id="line-75"> cfTTL = this.storeConfigInfo.getStoreFileTtl();</span> |
| <span class="source-line-no">076</span><span id="line-76"> }</span> |
| <span class="source-line-no">077</span><span id="line-77"> if (filesToCompact.size() == 1) {</span> |
| <span class="source-line-no">078</span><span id="line-78"> // Single file</span> |
| <span class="source-line-no">079</span><span id="line-79"> HStoreFile sf = filesToCompact.iterator().next();</span> |
| <span class="source-line-no">080</span><span id="line-80"> OptionalLong minTimestamp = sf.getMinimumTimestamp();</span> |
| <span class="source-line-no">081</span><span id="line-81"> long oldest = minTimestamp.isPresent() ? now - minTimestamp.getAsLong() : Long.MIN_VALUE;</span> |
| <span class="source-line-no">082</span><span id="line-82"> if (sf.isMajorCompactionResult() && (cfTTL == Long.MAX_VALUE || oldest < cfTTL)) {</span> |
| <span class="source-line-no">083</span><span id="line-83"> float blockLocalityIndex = sf.getHDFSBlockDistribution()</span> |
| <span class="source-line-no">084</span><span id="line-84"> .getBlockLocalityIndex(DNS.getHostname(comConf.conf, DNS.ServerType.REGIONSERVER));</span> |
| <span class="source-line-no">085</span><span id="line-85"> if (blockLocalityIndex < comConf.getMinLocalityToForceCompact()) {</span> |
| <span class="source-line-no">086</span><span id="line-86"> LOG.debug("Major compaction triggered on only store " + regionInfo</span> |
| <span class="source-line-no">087</span><span id="line-87"> + "; to make hdfs blocks local, current blockLocalityIndex is " + blockLocalityIndex</span> |
| <span class="source-line-no">088</span><span id="line-88"> + " (min " + comConf.getMinLocalityToForceCompact() + ")");</span> |
| <span class="source-line-no">089</span><span id="line-89"> result = true;</span> |
| <span class="source-line-no">090</span><span id="line-90"> } else {</span> |
| <span class="source-line-no">091</span><span id="line-91"> LOG.debug("Skipping major compaction of " + regionInfo</span> |
| <span class="source-line-no">092</span><span id="line-92"> + " because one (major) compacted file only, oldestTime " + oldest + "ms is < TTL="</span> |
| <span class="source-line-no">093</span><span id="line-93"> + cfTTL + " and blockLocalityIndex is " + blockLocalityIndex + " (min "</span> |
| <span class="source-line-no">094</span><span id="line-94"> + comConf.getMinLocalityToForceCompact() + ")");</span> |
| <span class="source-line-no">095</span><span id="line-95"> }</span> |
| <span class="source-line-no">096</span><span id="line-96"> } else if (cfTTL != HConstants.FOREVER && oldest > cfTTL) {</span> |
| <span class="source-line-no">097</span><span id="line-97"> LOG.debug("Major compaction triggered on store " + regionInfo</span> |
| <span class="source-line-no">098</span><span id="line-98"> + ", because keyvalues outdated; time since last major compaction "</span> |
| <span class="source-line-no">099</span><span id="line-99"> + (now - lowTimestamp) + "ms");</span> |
| <span class="source-line-no">100</span><span id="line-100"> result = true;</span> |
| <span class="source-line-no">101</span><span id="line-101"> }</span> |
| <span class="source-line-no">102</span><span id="line-102"> } else {</span> |
| <span class="source-line-no">103</span><span id="line-103"> LOG.debug("Major compaction triggered on store " + regionInfo</span> |
| <span class="source-line-no">104</span><span id="line-104"> + "; time since last major compaction " + (now - lowTimestamp) + "ms");</span> |
| <span class="source-line-no">105</span><span id="line-105"> result = true;</span> |
| <span class="source-line-no">106</span><span id="line-106"> }</span> |
| <span class="source-line-no">107</span><span id="line-107"> }</span> |
| <span class="source-line-no">108</span><span id="line-108"> return result;</span> |
| <span class="source-line-no">109</span><span id="line-109"> }</span> |
| <span class="source-line-no">110</span><span id="line-110"></span> |
| <span class="source-line-no">111</span><span id="line-111"> @Override</span> |
| <span class="source-line-no">112</span><span id="line-112"> protected CompactionRequestImpl createCompactionRequest(ArrayList<HStoreFile> candidateSelection,</span> |
| <span class="source-line-no">113</span><span id="line-113"> boolean tryingMajor, boolean mayUseOffPeak, boolean mayBeStuck) throws IOException {</span> |
| <span class="source-line-no">114</span><span id="line-114"> if (!tryingMajor) {</span> |
| <span class="source-line-no">115</span><span id="line-115"> filterBulk(candidateSelection);</span> |
| <span class="source-line-no">116</span><span id="line-116"> candidateSelection = applyCompactionPolicy(candidateSelection, mayUseOffPeak, mayBeStuck);</span> |
| <span class="source-line-no">117</span><span id="line-117"> candidateSelection =</span> |
| <span class="source-line-no">118</span><span id="line-118"> checkMinFilesCriteria(candidateSelection, comConf.getMinFilesToCompact());</span> |
| <span class="source-line-no">119</span><span id="line-119"> }</span> |
| <span class="source-line-no">120</span><span id="line-120"> return new CompactionRequestImpl(candidateSelection);</span> |
| <span class="source-line-no">121</span><span id="line-121"> }</span> |
| <span class="source-line-no">122</span><span id="line-122"></span> |
| <span class="source-line-no">123</span><span id="line-123"> /**</span> |
| <span class="source-line-no">124</span><span id="line-124"> * -- Default minor compaction selection algorithm: choose CompactSelection from candidates --</span> |
| <span class="source-line-no">125</span><span id="line-125"> * First exclude bulk-load files if indicated in configuration. Start at the oldest file and stop</span> |
| <span class="source-line-no">126</span><span id="line-126"> * when you find the first file that meets compaction criteria: (1) a recently-flushed, small file</span> |
| <span class="source-line-no">127</span><span id="line-127"> * (i.e. <= minCompactSize) OR (2) within the compactRatio of sum(newer_files) Given normal skew,</span> |
| <span class="source-line-no">128</span><span id="line-128"> * any newer files will also meet this criteria</span> |
| <span class="source-line-no">129</span><span id="line-129"> * <p/></span> |
| <span class="source-line-no">130</span><span id="line-130"> * Additional Note: If fileSizes.size() >> maxFilesToCompact, we will recurse on compact().</span> |
| <span class="source-line-no">131</span><span id="line-131"> * Consider the oldest files first to avoid a situation where we always compact</span> |
| <span class="source-line-no">132</span><span id="line-132"> * [end-threshold,end). Then, the last file becomes an aggregate of the previous compactions.</span> |
| <span class="source-line-no">133</span><span id="line-133"> * normal skew: older ----> newer (increasing seqID) _ | | _ | | | | _ --|-|- |-|-</span> |
| <span class="source-line-no">134</span><span id="line-134"> * |-|---_-------_------- minCompactSize | | | | | | | | _ | | | | | | | | | | | | | | | | | | | |</span> |
| <span class="source-line-no">135</span><span id="line-135"> * | | | | | |</span> |
| <span class="source-line-no">136</span><span id="line-136"> * @param candidates pre-filtrate</span> |
| <span class="source-line-no">137</span><span id="line-137"> * @return filtered subset</span> |
| <span class="source-line-no">138</span><span id="line-138"> */</span> |
| <span class="source-line-no">139</span><span id="line-139"> protected ArrayList<HStoreFile> applyCompactionPolicy(ArrayList<HStoreFile> candidates,</span> |
| <span class="source-line-no">140</span><span id="line-140"> boolean mayUseOffPeak, boolean mayBeStuck) throws IOException {</span> |
| <span class="source-line-no">141</span><span id="line-141"> if (candidates.isEmpty()) {</span> |
| <span class="source-line-no">142</span><span id="line-142"> return candidates;</span> |
| <span class="source-line-no">143</span><span id="line-143"> }</span> |
| <span class="source-line-no">144</span><span id="line-144"></span> |
| <span class="source-line-no">145</span><span id="line-145"> // we're doing a minor compaction, let's see what files are applicable</span> |
| <span class="source-line-no">146</span><span id="line-146"> int start = 0;</span> |
| <span class="source-line-no">147</span><span id="line-147"> double ratio = comConf.getCompactionRatio();</span> |
| <span class="source-line-no">148</span><span id="line-148"> if (mayUseOffPeak) {</span> |
| <span class="source-line-no">149</span><span id="line-149"> ratio = comConf.getCompactionRatioOffPeak();</span> |
| <span class="source-line-no">150</span><span id="line-150"> LOG.info("Running an off-peak compaction, selection ratio = " + ratio);</span> |
| <span class="source-line-no">151</span><span id="line-151"> }</span> |
| <span class="source-line-no">152</span><span id="line-152"></span> |
| <span class="source-line-no">153</span><span id="line-153"> // get store file sizes for incremental compacting selection.</span> |
| <span class="source-line-no">154</span><span id="line-154"> final int countOfFiles = candidates.size();</span> |
| <span class="source-line-no">155</span><span id="line-155"> long[] fileSizes = new long[countOfFiles];</span> |
| <span class="source-line-no">156</span><span id="line-156"> long[] sumSize = new long[countOfFiles];</span> |
| <span class="source-line-no">157</span><span id="line-157"> for (int i = countOfFiles - 1; i >= 0; --i) {</span> |
| <span class="source-line-no">158</span><span id="line-158"> HStoreFile file = candidates.get(i);</span> |
| <span class="source-line-no">159</span><span id="line-159"> fileSizes[i] = file.getReader().length();</span> |
| <span class="source-line-no">160</span><span id="line-160"> // calculate the sum of fileSizes[i,i+maxFilesToCompact-1) for algo</span> |
| <span class="source-line-no">161</span><span id="line-161"> int tooFar = i + comConf.getMaxFilesToCompact() - 1;</span> |
| <span class="source-line-no">162</span><span id="line-162"> sumSize[i] = fileSizes[i] + ((i + 1 < countOfFiles) ? sumSize[i + 1] : 0)</span> |
| <span class="source-line-no">163</span><span id="line-163"> - ((tooFar < countOfFiles) ? fileSizes[tooFar] : 0);</span> |
| <span class="source-line-no">164</span><span id="line-164"> }</span> |
| <span class="source-line-no">165</span><span id="line-165"></span> |
| <span class="source-line-no">166</span><span id="line-166"> while (</span> |
| <span class="source-line-no">167</span><span id="line-167"> countOfFiles - start >= comConf.getMinFilesToCompact() && fileSizes[start]</span> |
| <span class="source-line-no">168</span><span id="line-168"> > Math.max(comConf.getMinCompactSize(), (long) (sumSize[start + 1] * ratio))</span> |
| <span class="source-line-no">169</span><span id="line-169"> ) {</span> |
| <span class="source-line-no">170</span><span id="line-170"> ++start;</span> |
| <span class="source-line-no">171</span><span id="line-171"> }</span> |
| <span class="source-line-no">172</span><span id="line-172"> if (start < countOfFiles) {</span> |
| <span class="source-line-no">173</span><span id="line-173"> LOG.info("Default compaction algorithm has selected " + (countOfFiles - start)</span> |
| <span class="source-line-no">174</span><span id="line-174"> + " files from " + countOfFiles + " candidates");</span> |
| <span class="source-line-no">175</span><span id="line-175"> } else if (mayBeStuck) {</span> |
| <span class="source-line-no">176</span><span id="line-176"> // We may be stuck. Compact the latest files if we can.</span> |
| <span class="source-line-no">177</span><span id="line-177"> int filesToLeave = candidates.size() - comConf.getMinFilesToCompact();</span> |
| <span class="source-line-no">178</span><span id="line-178"> if (filesToLeave >= 0) {</span> |
| <span class="source-line-no">179</span><span id="line-179"> start = filesToLeave;</span> |
| <span class="source-line-no">180</span><span id="line-180"> }</span> |
| <span class="source-line-no">181</span><span id="line-181"> }</span> |
| <span class="source-line-no">182</span><span id="line-182"> candidates.subList(0, start).clear();</span> |
| <span class="source-line-no">183</span><span id="line-183"> return candidates;</span> |
| <span class="source-line-no">184</span><span id="line-184"> }</span> |
| <span class="source-line-no">185</span><span id="line-185"></span> |
| <span class="source-line-no">186</span><span id="line-186"> /**</span> |
| <span class="source-line-no">187</span><span id="line-187"> * A heuristic method to decide whether to schedule a compaction request</span> |
| <span class="source-line-no">188</span><span id="line-188"> * @param storeFiles files in the store.</span> |
| <span class="source-line-no">189</span><span id="line-189"> * @param filesCompacting files being scheduled to compact.</span> |
| <span class="source-line-no">190</span><span id="line-190"> * @return true to schedule a request.</span> |
| <span class="source-line-no">191</span><span id="line-191"> */</span> |
| <span class="source-line-no">192</span><span id="line-192"> @Override</span> |
| <span class="source-line-no">193</span><span id="line-193"> public boolean needsCompaction(Collection<HStoreFile> storeFiles,</span> |
| <span class="source-line-no">194</span><span id="line-194"> List<HStoreFile> filesCompacting) {</span> |
| <span class="source-line-no">195</span><span id="line-195"> int numCandidates = storeFiles.size() - filesCompacting.size();</span> |
| <span class="source-line-no">196</span><span id="line-196"> return numCandidates >= comConf.getMinFilesToCompact();</span> |
| <span class="source-line-no">197</span><span id="line-197"> }</span> |
| <span class="source-line-no">198</span><span id="line-198"></span> |
| <span class="source-line-no">199</span><span id="line-199"> /**</span> |
| <span class="source-line-no">200</span><span id="line-200"> * Overwrite min threshold for compaction</span> |
| <span class="source-line-no">201</span><span id="line-201"> */</span> |
| <span class="source-line-no">202</span><span id="line-202"> public void setMinThreshold(int minThreshold) {</span> |
| <span class="source-line-no">203</span><span id="line-203"> comConf.setMinFilesToCompact(minThreshold);</span> |
| <span class="source-line-no">204</span><span id="line-204"> }</span> |
| <span class="source-line-no">205</span><span id="line-205">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
