| <!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>package org.apache.hadoop.hbase.regionserver;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.IOException;<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.List;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.concurrent.atomic.AtomicBoolean;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.concurrent.atomic.AtomicLong;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.hadoop.conf.Configuration;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.hadoop.fs.FileStatus;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.hadoop.fs.Path;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.ScheduledChore;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.Stoppable;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.io.HFileLink;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.hadoop.ipc.RemoteException;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.slf4j.Logger;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.slf4j.LoggerFactory;<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> * This Chore, every time it runs, will clear the unsused HFiles in the data folder.<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> */<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>@InterfaceAudience.Private<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>public class BrokenStoreFileCleaner extends ScheduledChore {<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> private static final Logger LOG = LoggerFactory.getLogger(BrokenStoreFileCleaner.class);<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> public static final String BROKEN_STOREFILE_CLEANER_ENABLED =<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> "hbase.region.broken.storefilecleaner.enabled";<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> public static final boolean DEFAULT_BROKEN_STOREFILE_CLEANER_ENABLED = false;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> public static final String BROKEN_STOREFILE_CLEANER_TTL =<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> "hbase.region.broken.storefilecleaner.ttl";<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> public static final long DEFAULT_BROKEN_STOREFILE_CLEANER_TTL = 1000 * 60 * 60 * 12; // 12h<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> public static final String BROKEN_STOREFILE_CLEANER_DELAY =<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> "hbase.region.broken.storefilecleaner.delay";<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> public static final int DEFAULT_BROKEN_STOREFILE_CLEANER_DELAY = 1000 * 60 * 60 * 2; // 2h<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> public static final String BROKEN_STOREFILE_CLEANER_DELAY_JITTER =<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> "hbase.region.broken.storefilecleaner.delay.jitter";<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> public static final double DEFAULT_BROKEN_STOREFILE_CLEANER_DELAY_JITTER = 0.25D;<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> public static final String BROKEN_STOREFILE_CLEANER_PERIOD =<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> "hbase.region.broken.storefilecleaner.period";<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> public static final int DEFAULT_BROKEN_STOREFILE_CLEANER_PERIOD = 1000 * 60 * 60 * 6; // 6h<a name="line.57"></a> |
| <span class="sourceLineNo">058</span><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> private HRegionServer regionServer;<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> private final AtomicBoolean enabled = new AtomicBoolean(true);<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> private long fileTtl;<a name="line.61"></a> |
| <span class="sourceLineNo">062</span><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> public BrokenStoreFileCleaner(final int delay, final int period, final Stoppable stopper,<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> Configuration conf, HRegionServer regionServer) {<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> super("BrokenStoreFileCleaner", stopper, period, delay);<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> this.regionServer = regionServer;<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> setEnabled(<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> conf.getBoolean(BROKEN_STOREFILE_CLEANER_ENABLED, DEFAULT_BROKEN_STOREFILE_CLEANER_ENABLED));<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> fileTtl = conf.getLong(BROKEN_STOREFILE_CLEANER_TTL, DEFAULT_BROKEN_STOREFILE_CLEANER_TTL);<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> }<a name="line.70"></a> |
| <span class="sourceLineNo">071</span><a name="line.71"></a> |
| <span class="sourceLineNo">072</span> public boolean setEnabled(final boolean enabled) {<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> return this.enabled.getAndSet(enabled);<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> public boolean getEnabled() {<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> return this.enabled.get();<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> }<a name="line.78"></a> |
| <span class="sourceLineNo">079</span><a name="line.79"></a> |
| <span class="sourceLineNo">080</span> @Override<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> public void chore() {<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> if (getEnabled()) {<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> long start = EnvironmentEdgeManager.currentTime();<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> AtomicLong deletedFiles = new AtomicLong(0);<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> AtomicLong failedDeletes = new AtomicLong(0);<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> for (HRegion region : regionServer.getRegions()) {<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> for (HStore store : region.getStores()) {<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> // only do cleanup in stores not using tmp directories<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> if (store.getStoreEngine().requireWritingToTmpDirFirst()) {<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> continue;<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> }<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> Path storePath =<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> new Path(region.getRegionFileSystem().getRegionDir(), store.getColumnFamilyName());<a name="line.93"></a> |
| <span class="sourceLineNo">094</span><a name="line.94"></a> |
| <span class="sourceLineNo">095</span> try {<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> List<FileStatus> fsStoreFiles =<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> Arrays.asList(region.getRegionFileSystem().fs.listStatus(storePath));<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> fsStoreFiles<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> .forEach(file -> cleanFileIfNeeded(file, store, deletedFiles, failedDeletes));<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> } catch (IOException e) {<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> LOG.warn("Failed to list files in {}, cleanup is skipped there", storePath);<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> continue;<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> }<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> LOG.debug(<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> "BrokenStoreFileCleaner on {} run for: {}ms. It deleted {} files and tried but failed "<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> + "to delete {}",<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> regionServer.getServerName().getServerName(), EnvironmentEdgeManager.currentTime() - start,<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> deletedFiles.get(), failedDeletes.get());<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> } else {<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> LOG.trace("Broken storefile Cleaner chore disabled! Not cleaning.");<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> }<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> }<a name="line.114"></a> |
| <span class="sourceLineNo">115</span><a name="line.115"></a> |
| <span class="sourceLineNo">116</span> private void cleanFileIfNeeded(FileStatus file, HStore store, AtomicLong deletedFiles,<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> AtomicLong failedDeletes) {<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> if (file.isDirectory()) {<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> LOG.trace("This is a Directory {}, skip cleanup", file.getPath());<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> return;<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> }<a name="line.121"></a> |
| <span class="sourceLineNo">122</span><a name="line.122"></a> |
| <span class="sourceLineNo">123</span> if (!validate(file.getPath())) {<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> LOG.trace("Invalid file {}, skip cleanup", file.getPath());<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> return;<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> if (!isOldEnough(file)) {<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> LOG.trace("Fresh file {}, skip cleanup", file.getPath());<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> return;<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> }<a name="line.131"></a> |
| <span class="sourceLineNo">132</span><a name="line.132"></a> |
| <span class="sourceLineNo">133</span> if (isActiveStorefile(file, store)) {<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> LOG.trace("Actively used storefile file {}, skip cleanup", file.getPath());<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> return;<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> // Compacted files can still have readers and are cleaned by a separate chore, so they have to<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> // be skipped here<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> if (isCompactedFile(file, store)) {<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> LOG.trace("Cleanup is done by a different chore for file {}, skip cleanup", file.getPath());<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> return;<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> }<a name="line.143"></a> |
| <span class="sourceLineNo">144</span><a name="line.144"></a> |
| <span class="sourceLineNo">145</span> if (isCompactionResultFile(file, store)) {<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> LOG.trace("The file is the result of an ongoing compaction {}, skip cleanup", file.getPath());<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> return;<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> deleteFile(file, store, deletedFiles, failedDeletes);<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> }<a name="line.151"></a> |
| <span class="sourceLineNo">152</span><a name="line.152"></a> |
| <span class="sourceLineNo">153</span> private boolean isCompactionResultFile(FileStatus file, HStore store) {<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> return store.getStoreFilesBeingWritten().contains(file.getPath());<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> // Compacted files can still have readers and are cleaned by a separate chore, so they have to<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> // be skipped here<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> private boolean isCompactedFile(FileStatus file, HStore store) {<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> return store.getStoreEngine().getStoreFileManager().getCompactedfiles().stream()<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> .anyMatch(sf -> sf.getPath().equals(file.getPath()));<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> private boolean isActiveStorefile(FileStatus file, HStore store) {<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> return store.getStoreEngine().getStoreFileManager().getStoreFiles().stream()<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> .anyMatch(sf -> sf.getPath().equals(file.getPath()));<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> boolean validate(Path file) {<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> if (HFileLink.isBackReferencesDir(file) || HFileLink.isBackReferencesDir(file.getParent())) {<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> return true;<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> }<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> return StoreFileInfo.validateStoreFileName(file.getName());<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> }<a name="line.174"></a> |
| <span class="sourceLineNo">175</span><a name="line.175"></a> |
| <span class="sourceLineNo">176</span> boolean isOldEnough(FileStatus file) {<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> return file.getModificationTime() + fileTtl < EnvironmentEdgeManager.currentTime();<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> }<a name="line.178"></a> |
| <span class="sourceLineNo">179</span><a name="line.179"></a> |
| <span class="sourceLineNo">180</span> private void deleteFile(FileStatus file, HStore store, AtomicLong deletedFiles,<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> AtomicLong failedDeletes) {<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> Path filePath = file.getPath();<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> LOG.debug("Removing {} from store", filePath);<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> try {<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> boolean success = store.getFileSystem().delete(filePath, false);<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> if (!success) {<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> failedDeletes.incrementAndGet();<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> LOG.warn(<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> "Attempted to delete:" + filePath + ", but couldn't. Attempt to delete on next pass.");<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> } else {<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> deletedFiles.incrementAndGet();<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> }<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> } catch (IOException e) {<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> e = e instanceof RemoteException ? ((RemoteException) e).unwrapRemoteException() : e;<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> LOG.warn("Error while deleting: " + filePath, e);<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> }<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> }<a name="line.197"></a> |
| <span class="sourceLineNo">198</span><a name="line.198"></a> |
| <span class="sourceLineNo">199</span>}<a name="line.199"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
