Google Git
Sign in
apache / hbase-site / 5a6938ba8875b19a3d96e84a37f1016c53778aec / . / devapidocs / src-html / org / apache / hadoop / hbase / regionserver / compactions / CompactionRequestImpl.html
blob: 0dd16650c26d911063ce9106f6e3ed379a836291 [file] [log] [blame]
<!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: CompactionRequestImpl">
<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 static org.apache.hadoop.hbase.regionserver.Store.NO_PRIORITY;</span>
<span class="source-line-no">021</span><span id="line-21"></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.Collections;</span>
<span class="source-line-no">024</span><span id="line-24">import java.util.function.Consumer;</span>
<span class="source-line-no">025</span><span id="line-25">import java.util.stream.Collectors;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.fs.Path;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.regionserver.HStoreFile;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.util.StringUtils.TraditionalBinaryPrefix;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">031</span><span id="line-31"></span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;</span>
<span class="source-line-no">033</span><span id="line-33"></span>
<span class="source-line-no">034</span><span id="line-34">/**</span>
<span class="source-line-no">035</span><span id="line-35"> * This class holds all logical details necessary to run a compaction.</span>
<span class="source-line-no">036</span><span id="line-36"> */</span>
<span class="source-line-no">037</span><span id="line-37">@InterfaceAudience.Private</span>
<span class="source-line-no">038</span><span id="line-38">public class CompactionRequestImpl implements CompactionRequest {</span>
<span class="source-line-no">039</span><span id="line-39"></span>
<span class="source-line-no">040</span><span id="line-40"> // was this compaction promoted to an off-peak</span>
<span class="source-line-no">041</span><span id="line-41"> private boolean isOffPeak = false;</span>
<span class="source-line-no">042</span><span id="line-42"></span>
<span class="source-line-no">043</span><span id="line-43"> private enum DisplayCompactionType {</span>
<span class="source-line-no">044</span><span id="line-44"> MINOR,</span>
<span class="source-line-no">045</span><span id="line-45"> ALL_FILES,</span>
<span class="source-line-no">046</span><span id="line-46"> MAJOR</span>
<span class="source-line-no">047</span><span id="line-47"> }</span>
<span class="source-line-no">048</span><span id="line-48"></span>
<span class="source-line-no">049</span><span id="line-49"> private DisplayCompactionType isMajor = DisplayCompactionType.MINOR;</span>
<span class="source-line-no">050</span><span id="line-50"> private int priority = NO_PRIORITY;</span>
<span class="source-line-no">051</span><span id="line-51"> private Collection&lt;HStoreFile&gt; filesToCompact;</span>
<span class="source-line-no">052</span><span id="line-52"> private boolean isAfterSplit = false;</span>
<span class="source-line-no">053</span><span id="line-53"></span>
<span class="source-line-no">054</span><span id="line-54"> // CompactRequest object creation time.</span>
<span class="source-line-no">055</span><span id="line-55"> private long selectionTime;</span>
<span class="source-line-no">056</span><span id="line-56"> private String regionName = "";</span>
<span class="source-line-no">057</span><span id="line-57"> private String storeName = "";</span>
<span class="source-line-no">058</span><span id="line-58"> private long totalSize = -1L;</span>
<span class="source-line-no">059</span><span id="line-59"> private CompactionLifeCycleTracker tracker = CompactionLifeCycleTracker.DUMMY;</span>
<span class="source-line-no">060</span><span id="line-60"> private Consumer&lt;Path&gt; writerCreationTracker;</span>
<span class="source-line-no">061</span><span id="line-61"></span>
<span class="source-line-no">062</span><span id="line-62"> public CompactionRequestImpl(Collection&lt;HStoreFile&gt; files) {</span>
<span class="source-line-no">063</span><span id="line-63"> this.selectionTime = EnvironmentEdgeManager.currentTime();</span>
<span class="source-line-no">064</span><span id="line-64"> this.filesToCompact = Preconditions.checkNotNull(files, "files for compaction can not null");</span>
<span class="source-line-no">065</span><span id="line-65"> recalculateSize();</span>
<span class="source-line-no">066</span><span id="line-66"> }</span>
<span class="source-line-no">067</span><span id="line-67"></span>
<span class="source-line-no">068</span><span id="line-68"> public void updateFiles(Collection&lt;HStoreFile&gt; files) {</span>
<span class="source-line-no">069</span><span id="line-69"> this.filesToCompact = Preconditions.checkNotNull(files, "files for compaction can not null");</span>
<span class="source-line-no">070</span><span id="line-70"> recalculateSize();</span>
<span class="source-line-no">071</span><span id="line-71"> }</span>
<span class="source-line-no">072</span><span id="line-72"></span>
<span class="source-line-no">073</span><span id="line-73"> @Override</span>
<span class="source-line-no">074</span><span id="line-74"> public Collection&lt;HStoreFile&gt; getFiles() {</span>
<span class="source-line-no">075</span><span id="line-75"> return Collections.unmodifiableCollection(this.filesToCompact);</span>
<span class="source-line-no">076</span><span id="line-76"> }</span>
<span class="source-line-no">077</span><span id="line-77"></span>
<span class="source-line-no">078</span><span id="line-78"> /**</span>
<span class="source-line-no">079</span><span id="line-79"> * Sets the region/store name, for logging.</span>
<span class="source-line-no">080</span><span id="line-80"> */</span>
<span class="source-line-no">081</span><span id="line-81"> public void setDescription(String regionName, String storeName) {</span>
<span class="source-line-no">082</span><span id="line-82"> this.regionName = regionName;</span>
<span class="source-line-no">083</span><span id="line-83"> this.storeName = storeName;</span>
<span class="source-line-no">084</span><span id="line-84"> }</span>
<span class="source-line-no">085</span><span id="line-85"></span>
<span class="source-line-no">086</span><span id="line-86"> /** Gets the total size of all StoreFiles in compaction */</span>
<span class="source-line-no">087</span><span id="line-87"> @Override</span>
<span class="source-line-no">088</span><span id="line-88"> public long getSize() {</span>
<span class="source-line-no">089</span><span id="line-89"> return totalSize;</span>
<span class="source-line-no">090</span><span id="line-90"> }</span>
<span class="source-line-no">091</span><span id="line-91"></span>
<span class="source-line-no">092</span><span id="line-92"> @Override</span>
<span class="source-line-no">093</span><span id="line-93"> public boolean isAllFiles() {</span>
<span class="source-line-no">094</span><span id="line-94"> return this.isMajor == DisplayCompactionType.MAJOR</span>
<span class="source-line-no">095</span><span id="line-95"> || this.isMajor == DisplayCompactionType.ALL_FILES;</span>
<span class="source-line-no">096</span><span id="line-96"> }</span>
<span class="source-line-no">097</span><span id="line-97"></span>
<span class="source-line-no">098</span><span id="line-98"> @Override</span>
<span class="source-line-no">099</span><span id="line-99"> public boolean isMajor() {</span>
<span class="source-line-no">100</span><span id="line-100"> return this.isMajor == DisplayCompactionType.MAJOR;</span>
<span class="source-line-no">101</span><span id="line-101"> }</span>
<span class="source-line-no">102</span><span id="line-102"></span>
<span class="source-line-no">103</span><span id="line-103"> /** Gets the priority for the request */</span>
<span class="source-line-no">104</span><span id="line-104"> @Override</span>
<span class="source-line-no">105</span><span id="line-105"> public int getPriority() {</span>
<span class="source-line-no">106</span><span id="line-106"> return priority;</span>
<span class="source-line-no">107</span><span id="line-107"> }</span>
<span class="source-line-no">108</span><span id="line-108"></span>
<span class="source-line-no">109</span><span id="line-109"> /** Sets the priority for the request */</span>
<span class="source-line-no">110</span><span id="line-110"> public void setPriority(int p) {</span>
<span class="source-line-no">111</span><span id="line-111"> this.priority = p;</span>
<span class="source-line-no">112</span><span id="line-112"> }</span>
<span class="source-line-no">113</span><span id="line-113"></span>
<span class="source-line-no">114</span><span id="line-114"> @Override</span>
<span class="source-line-no">115</span><span id="line-115"> public boolean isOffPeak() {</span>
<span class="source-line-no">116</span><span id="line-116"> return this.isOffPeak;</span>
<span class="source-line-no">117</span><span id="line-117"> }</span>
<span class="source-line-no">118</span><span id="line-118"></span>
<span class="source-line-no">119</span><span id="line-119"> public void setOffPeak(boolean value) {</span>
<span class="source-line-no">120</span><span id="line-120"> this.isOffPeak = value;</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"> @Override</span>
<span class="source-line-no">124</span><span id="line-124"> public long getSelectionTime() {</span>
<span class="source-line-no">125</span><span id="line-125"> return this.selectionTime;</span>
<span class="source-line-no">126</span><span id="line-126"> }</span>
<span class="source-line-no">127</span><span id="line-127"></span>
<span class="source-line-no">128</span><span id="line-128"> /**</span>
<span class="source-line-no">129</span><span id="line-129"> * Specify if this compaction should be a major compaction based on the state of the store</span>
<span class="source-line-no">130</span><span id="line-130"> * @param isMajor &lt;tt&gt;true&lt;/tt&gt; if the system determines that this compaction should be a major</span>
<span class="source-line-no">131</span><span id="line-131"> * compaction</span>
<span class="source-line-no">132</span><span id="line-132"> */</span>
<span class="source-line-no">133</span><span id="line-133"> public void setIsMajor(boolean isMajor, boolean isAllFiles) {</span>
<span class="source-line-no">134</span><span id="line-134"> assert isAllFiles || !isMajor;</span>
<span class="source-line-no">135</span><span id="line-135"> this.isMajor = !isAllFiles</span>
<span class="source-line-no">136</span><span id="line-136"> ? DisplayCompactionType.MINOR</span>
<span class="source-line-no">137</span><span id="line-137"> : (isMajor ? DisplayCompactionType.MAJOR : DisplayCompactionType.ALL_FILES);</span>
<span class="source-line-no">138</span><span id="line-138"> }</span>
<span class="source-line-no">139</span><span id="line-139"></span>
<span class="source-line-no">140</span><span id="line-140"> public void setTracker(CompactionLifeCycleTracker tracker) {</span>
<span class="source-line-no">141</span><span id="line-141"> this.tracker = tracker;</span>
<span class="source-line-no">142</span><span id="line-142"> }</span>
<span class="source-line-no">143</span><span id="line-143"></span>
<span class="source-line-no">144</span><span id="line-144"> public CompactionLifeCycleTracker getTracker() {</span>
<span class="source-line-no">145</span><span id="line-145"> return tracker;</span>
<span class="source-line-no">146</span><span id="line-146"> }</span>
<span class="source-line-no">147</span><span id="line-147"></span>
<span class="source-line-no">148</span><span id="line-148"> public Consumer&lt;Path&gt; getWriterCreationTracker() {</span>
<span class="source-line-no">149</span><span id="line-149"> return writerCreationTracker;</span>
<span class="source-line-no">150</span><span id="line-150"> }</span>
<span class="source-line-no">151</span><span id="line-151"></span>
<span class="source-line-no">152</span><span id="line-152"> public void setWriterCreationTracker(Consumer&lt;Path&gt; writerCreationTracker) {</span>
<span class="source-line-no">153</span><span id="line-153"> this.writerCreationTracker = writerCreationTracker;</span>
<span class="source-line-no">154</span><span id="line-154"> }</span>
<span class="source-line-no">155</span><span id="line-155"></span>
<span class="source-line-no">156</span><span id="line-156"> public boolean isAfterSplit() {</span>
<span class="source-line-no">157</span><span id="line-157"> return isAfterSplit;</span>
<span class="source-line-no">158</span><span id="line-158"> }</span>
<span class="source-line-no">159</span><span id="line-159"></span>
<span class="source-line-no">160</span><span id="line-160"> public void setAfterSplit(boolean afterSplit) {</span>
<span class="source-line-no">161</span><span id="line-161"> isAfterSplit = afterSplit;</span>
<span class="source-line-no">162</span><span id="line-162"> }</span>
<span class="source-line-no">163</span><span id="line-163"></span>
<span class="source-line-no">164</span><span id="line-164"> @Override</span>
<span class="source-line-no">165</span><span id="line-165"> public int hashCode() {</span>
<span class="source-line-no">166</span><span id="line-166"> final int prime = 31;</span>
<span class="source-line-no">167</span><span id="line-167"> int result = 1;</span>
<span class="source-line-no">168</span><span id="line-168"> result = prime * result + ((filesToCompact == null) ? 0 : filesToCompact.hashCode());</span>
<span class="source-line-no">169</span><span id="line-169"> result = prime * result + ((isMajor == null) ? 0 : isMajor.hashCode());</span>
<span class="source-line-no">170</span><span id="line-170"> result = prime * result + (isOffPeak ? 1231 : 1237);</span>
<span class="source-line-no">171</span><span id="line-171"> result = prime * result + priority;</span>
<span class="source-line-no">172</span><span id="line-172"> result = prime * result + ((regionName == null) ? 0 : regionName.hashCode());</span>
<span class="source-line-no">173</span><span id="line-173"> result = prime * result + (int) (selectionTime ^ (selectionTime &gt;&gt;&gt; 32));</span>
<span class="source-line-no">174</span><span id="line-174"> result = prime * result + ((storeName == null) ? 0 : storeName.hashCode());</span>
<span class="source-line-no">175</span><span id="line-175"> result = prime * result + (int) (totalSize ^ (totalSize &gt;&gt;&gt; 32));</span>
<span class="source-line-no">176</span><span id="line-176"> result = prime * result + ((tracker == null) ? 0 : tracker.hashCode());</span>
<span class="source-line-no">177</span><span id="line-177"> result = prime * result + (isAfterSplit ? 1231 : 1237);</span>
<span class="source-line-no">178</span><span id="line-178"> return result;</span>
<span class="source-line-no">179</span><span id="line-179"> }</span>
<span class="source-line-no">180</span><span id="line-180"></span>
<span class="source-line-no">181</span><span id="line-181"> @Override</span>
<span class="source-line-no">182</span><span id="line-182"> public boolean equals(Object obj) {</span>
<span class="source-line-no">183</span><span id="line-183"> if (this == obj) {</span>
<span class="source-line-no">184</span><span id="line-184"> return true;</span>
<span class="source-line-no">185</span><span id="line-185"> }</span>
<span class="source-line-no">186</span><span id="line-186"> if (obj == null) {</span>
<span class="source-line-no">187</span><span id="line-187"> return false;</span>
<span class="source-line-no">188</span><span id="line-188"> }</span>
<span class="source-line-no">189</span><span id="line-189"> if (getClass() != obj.getClass()) {</span>
<span class="source-line-no">190</span><span id="line-190"> return false;</span>
<span class="source-line-no">191</span><span id="line-191"> }</span>
<span class="source-line-no">192</span><span id="line-192"> CompactionRequestImpl other = (CompactionRequestImpl) obj;</span>
<span class="source-line-no">193</span><span id="line-193"> if (filesToCompact == null) {</span>
<span class="source-line-no">194</span><span id="line-194"> if (other.filesToCompact != null) {</span>
<span class="source-line-no">195</span><span id="line-195"> return false;</span>
<span class="source-line-no">196</span><span id="line-196"> }</span>
<span class="source-line-no">197</span><span id="line-197"> } else if (!filesToCompact.equals(other.filesToCompact)) {</span>
<span class="source-line-no">198</span><span id="line-198"> return false;</span>
<span class="source-line-no">199</span><span id="line-199"> }</span>
<span class="source-line-no">200</span><span id="line-200"> if (isMajor != other.isMajor) {</span>
<span class="source-line-no">201</span><span id="line-201"> return false;</span>
<span class="source-line-no">202</span><span id="line-202"> }</span>
<span class="source-line-no">203</span><span id="line-203"> if (isOffPeak != other.isOffPeak) {</span>
<span class="source-line-no">204</span><span id="line-204"> return false;</span>
<span class="source-line-no">205</span><span id="line-205"> }</span>
<span class="source-line-no">206</span><span id="line-206"> if (priority != other.priority) {</span>
<span class="source-line-no">207</span><span id="line-207"> return false;</span>
<span class="source-line-no">208</span><span id="line-208"> }</span>
<span class="source-line-no">209</span><span id="line-209"> if (regionName == null) {</span>
<span class="source-line-no">210</span><span id="line-210"> if (other.regionName != null) {</span>
<span class="source-line-no">211</span><span id="line-211"> return false;</span>
<span class="source-line-no">212</span><span id="line-212"> }</span>
<span class="source-line-no">213</span><span id="line-213"> } else if (!regionName.equals(other.regionName)) {</span>
<span class="source-line-no">214</span><span id="line-214"> return false;</span>
<span class="source-line-no">215</span><span id="line-215"> }</span>
<span class="source-line-no">216</span><span id="line-216"> if (selectionTime != other.selectionTime) {</span>
<span class="source-line-no">217</span><span id="line-217"> return false;</span>
<span class="source-line-no">218</span><span id="line-218"> }</span>
<span class="source-line-no">219</span><span id="line-219"> if (storeName == null) {</span>
<span class="source-line-no">220</span><span id="line-220"> if (other.storeName != null) {</span>
<span class="source-line-no">221</span><span id="line-221"> return false;</span>
<span class="source-line-no">222</span><span id="line-222"> }</span>
<span class="source-line-no">223</span><span id="line-223"> } else if (!storeName.equals(other.storeName)) {</span>
<span class="source-line-no">224</span><span id="line-224"> return false;</span>
<span class="source-line-no">225</span><span id="line-225"> }</span>
<span class="source-line-no">226</span><span id="line-226"> if (totalSize != other.totalSize) {</span>
<span class="source-line-no">227</span><span id="line-227"> return false;</span>
<span class="source-line-no">228</span><span id="line-228"> }</span>
<span class="source-line-no">229</span><span id="line-229"> if (isAfterSplit != other.isAfterSplit) {</span>
<span class="source-line-no">230</span><span id="line-230"> return false;</span>
<span class="source-line-no">231</span><span id="line-231"> }</span>
<span class="source-line-no">232</span><span id="line-232"> if (tracker == null) {</span>
<span class="source-line-no">233</span><span id="line-233"> if (other.tracker != null) {</span>
<span class="source-line-no">234</span><span id="line-234"> return false;</span>
<span class="source-line-no">235</span><span id="line-235"> }</span>
<span class="source-line-no">236</span><span id="line-236"> } else if (!tracker.equals(other.tracker)) {</span>
<span class="source-line-no">237</span><span id="line-237"> return false;</span>
<span class="source-line-no">238</span><span id="line-238"> }</span>
<span class="source-line-no">239</span><span id="line-239"> return true;</span>
<span class="source-line-no">240</span><span id="line-240"> }</span>
<span class="source-line-no">241</span><span id="line-241"></span>
<span class="source-line-no">242</span><span id="line-242"> @Override</span>
<span class="source-line-no">243</span><span id="line-243"> public String toString() {</span>
<span class="source-line-no">244</span><span id="line-244"> String fsList = filesToCompact.stream().filter(f -&gt; f.getReader() != null)</span>
<span class="source-line-no">245</span><span id="line-245"> .map(f -&gt; TraditionalBinaryPrefix.long2String(f.getReader().length(), "", 1))</span>
<span class="source-line-no">246</span><span id="line-246"> .collect(Collectors.joining(", "));</span>
<span class="source-line-no">247</span><span id="line-247"></span>
<span class="source-line-no">248</span><span id="line-248"> return "regionName=" + regionName + ", storeName=" + storeName + ", fileCount="</span>
<span class="source-line-no">249</span><span id="line-249"> + this.getFiles().size() + ", fileSize="</span>
<span class="source-line-no">250</span><span id="line-250"> + TraditionalBinaryPrefix.long2String(totalSize, "", 1)</span>
<span class="source-line-no">251</span><span id="line-251"> + ((fsList.isEmpty()) ? "" : " (" + fsList + ")") + ", priority=" + priority + ", time="</span>
<span class="source-line-no">252</span><span id="line-252"> + selectionTime;</span>
<span class="source-line-no">253</span><span id="line-253"> }</span>
<span class="source-line-no">254</span><span id="line-254"></span>
<span class="source-line-no">255</span><span id="line-255"> /**</span>
<span class="source-line-no">256</span><span id="line-256"> * Recalculate the size of the compaction based on current files.</span>
<span class="source-line-no">257</span><span id="line-257"> */</span>
<span class="source-line-no">258</span><span id="line-258"> private void recalculateSize() {</span>
<span class="source-line-no">259</span><span id="line-259"> this.totalSize = filesToCompact.stream().map(HStoreFile::getReader)</span>
<span class="source-line-no">260</span><span id="line-260"> .mapToLong(r -&gt; r != null ? r.length() : 0L).sum();</span>
<span class="source-line-no">261</span><span id="line-261"> }</span>
<span class="source-line-no">262</span><span id="line-262">}</span>
</pre>
</div>
</main>
</body>
</html>