blob: cf717562dec0cdf0557c65e500ce1e44dc293ee5 [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.backup, class: BackupHFileCleaner">
<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.backup;</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.Collections;</span>
<span class="source-line-no">022</span><span id="line-22">import java.util.HashSet;</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.Map;</span>
<span class="source-line-no">025</span><span id="line-25">import java.util.Set;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.fs.FileStatus;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.fs.Path;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.Abortable;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.HBaseInterfaceAudience;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.TableName;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.backup.impl.BackupSystemTable;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.client.Connection;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.client.ConnectionFactory;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.master.cleaner.BaseHFileCleanerDelegate;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">038</span><span id="line-38">import org.slf4j.Logger;</span>
<span class="source-line-no">039</span><span id="line-39">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">040</span><span id="line-40"></span>
<span class="source-line-no">041</span><span id="line-41">import org.apache.hbase.thirdparty.com.google.common.collect.Iterables;</span>
<span class="source-line-no">042</span><span id="line-42"></span>
<span class="source-line-no">043</span><span id="line-43">/**</span>
<span class="source-line-no">044</span><span id="line-44"> * Implementation of a file cleaner that checks if an hfile is still referenced by backup before</span>
<span class="source-line-no">045</span><span id="line-45"> * deleting it from hfile archive directory.</span>
<span class="source-line-no">046</span><span id="line-46"> */</span>
<span class="source-line-no">047</span><span id="line-47">@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.CONFIG)</span>
<span class="source-line-no">048</span><span id="line-48">public class BackupHFileCleaner extends BaseHFileCleanerDelegate implements Abortable {</span>
<span class="source-line-no">049</span><span id="line-49"> private static final Logger LOG = LoggerFactory.getLogger(BackupHFileCleaner.class);</span>
<span class="source-line-no">050</span><span id="line-50"> private boolean stopped = false;</span>
<span class="source-line-no">051</span><span id="line-51"> private boolean aborted;</span>
<span class="source-line-no">052</span><span id="line-52"> private Configuration conf;</span>
<span class="source-line-no">053</span><span id="line-53"> private Connection connection;</span>
<span class="source-line-no">054</span><span id="line-54"> private long prevReadFromBackupTbl = 0, // timestamp of most recent read from backup:system table</span>
<span class="source-line-no">055</span><span id="line-55"> secondPrevReadFromBackupTbl = 0; // timestamp of 2nd most recent read from backup:system table</span>
<span class="source-line-no">056</span><span id="line-56"> // used by unit test to skip reading backup:system</span>
<span class="source-line-no">057</span><span id="line-57"> private boolean checkForFullyBackedUpTables = true;</span>
<span class="source-line-no">058</span><span id="line-58"> private List&lt;TableName&gt; fullyBackedUpTables = null;</span>
<span class="source-line-no">059</span><span id="line-59"></span>
<span class="source-line-no">060</span><span id="line-60"> private Set&lt;String&gt; getFilenameFromBulkLoad(Map&lt;byte[], List&lt;Path&gt;&gt;[] maps) {</span>
<span class="source-line-no">061</span><span id="line-61"> Set&lt;String&gt; filenames = new HashSet&lt;&gt;();</span>
<span class="source-line-no">062</span><span id="line-62"> for (Map&lt;byte[], List&lt;Path&gt;&gt; map : maps) {</span>
<span class="source-line-no">063</span><span id="line-63"> if (map == null) {</span>
<span class="source-line-no">064</span><span id="line-64"> continue;</span>
<span class="source-line-no">065</span><span id="line-65"> }</span>
<span class="source-line-no">066</span><span id="line-66"></span>
<span class="source-line-no">067</span><span id="line-67"> for (List&lt;Path&gt; paths : map.values()) {</span>
<span class="source-line-no">068</span><span id="line-68"> for (Path p : paths) {</span>
<span class="source-line-no">069</span><span id="line-69"> filenames.add(p.getName());</span>
<span class="source-line-no">070</span><span id="line-70"> }</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"> return filenames;</span>
<span class="source-line-no">074</span><span id="line-74"> }</span>
<span class="source-line-no">075</span><span id="line-75"></span>
<span class="source-line-no">076</span><span id="line-76"> private Set&lt;String&gt; loadHFileRefs(List&lt;TableName&gt; tableList) throws IOException {</span>
<span class="source-line-no">077</span><span id="line-77"> if (connection == null) {</span>
<span class="source-line-no">078</span><span id="line-78"> connection = ConnectionFactory.createConnection(conf);</span>
<span class="source-line-no">079</span><span id="line-79"> }</span>
<span class="source-line-no">080</span><span id="line-80"> try (BackupSystemTable tbl = new BackupSystemTable(connection)) {</span>
<span class="source-line-no">081</span><span id="line-81"> Map&lt;byte[], List&lt;Path&gt;&gt;[] res = tbl.readBulkLoadedFiles(null, tableList);</span>
<span class="source-line-no">082</span><span id="line-82"> secondPrevReadFromBackupTbl = prevReadFromBackupTbl;</span>
<span class="source-line-no">083</span><span id="line-83"> prevReadFromBackupTbl = EnvironmentEdgeManager.currentTime();</span>
<span class="source-line-no">084</span><span id="line-84"> return getFilenameFromBulkLoad(res);</span>
<span class="source-line-no">085</span><span id="line-85"> }</span>
<span class="source-line-no">086</span><span id="line-86"> }</span>
<span class="source-line-no">087</span><span id="line-87"></span>
<span class="source-line-no">088</span><span id="line-88"> @InterfaceAudience.Private</span>
<span class="source-line-no">089</span><span id="line-89"> void setCheckForFullyBackedUpTables(boolean b) {</span>
<span class="source-line-no">090</span><span id="line-90"> checkForFullyBackedUpTables = b;</span>
<span class="source-line-no">091</span><span id="line-91"> }</span>
<span class="source-line-no">092</span><span id="line-92"></span>
<span class="source-line-no">093</span><span id="line-93"> @Override</span>
<span class="source-line-no">094</span><span id="line-94"> public Iterable&lt;FileStatus&gt; getDeletableFiles(Iterable&lt;FileStatus&gt; files) {</span>
<span class="source-line-no">095</span><span id="line-95"> if (conf == null) {</span>
<span class="source-line-no">096</span><span id="line-96"> return files;</span>
<span class="source-line-no">097</span><span id="line-97"> }</span>
<span class="source-line-no">098</span><span id="line-98"> // obtain the Set of TableName's which have been fully backed up</span>
<span class="source-line-no">099</span><span id="line-99"> // so that we filter BulkLoad to be returned from server</span>
<span class="source-line-no">100</span><span id="line-100"> if (checkForFullyBackedUpTables) {</span>
<span class="source-line-no">101</span><span id="line-101"> if (connection == null) {</span>
<span class="source-line-no">102</span><span id="line-102"> return files;</span>
<span class="source-line-no">103</span><span id="line-103"> }</span>
<span class="source-line-no">104</span><span id="line-104"></span>
<span class="source-line-no">105</span><span id="line-105"> try (BackupSystemTable tbl = new BackupSystemTable(connection)) {</span>
<span class="source-line-no">106</span><span id="line-106"> fullyBackedUpTables = tbl.getTablesForBackupType(BackupType.FULL);</span>
<span class="source-line-no">107</span><span id="line-107"> } catch (IOException ioe) {</span>
<span class="source-line-no">108</span><span id="line-108"> LOG.error("Failed to get tables which have been fully backed up, skipping checking", ioe);</span>
<span class="source-line-no">109</span><span id="line-109"> return Collections.emptyList();</span>
<span class="source-line-no">110</span><span id="line-110"> }</span>
<span class="source-line-no">111</span><span id="line-111"> Collections.sort(fullyBackedUpTables);</span>
<span class="source-line-no">112</span><span id="line-112"> }</span>
<span class="source-line-no">113</span><span id="line-113"> final Set&lt;String&gt; hfileRefs;</span>
<span class="source-line-no">114</span><span id="line-114"> try {</span>
<span class="source-line-no">115</span><span id="line-115"> hfileRefs = loadHFileRefs(fullyBackedUpTables);</span>
<span class="source-line-no">116</span><span id="line-116"> } catch (IOException ioe) {</span>
<span class="source-line-no">117</span><span id="line-117"> LOG.error("Failed to read hfile references, skipping checking deletable files", ioe);</span>
<span class="source-line-no">118</span><span id="line-118"> return Collections.emptyList();</span>
<span class="source-line-no">119</span><span id="line-119"> }</span>
<span class="source-line-no">120</span><span id="line-120"> Iterable&lt;FileStatus&gt; deletables = Iterables.filter(files, file -&gt; {</span>
<span class="source-line-no">121</span><span id="line-121"> // If the file is recent, be conservative and wait for one more scan of backup:system table</span>
<span class="source-line-no">122</span><span id="line-122"> if (file.getModificationTime() &gt; secondPrevReadFromBackupTbl) {</span>
<span class="source-line-no">123</span><span id="line-123"> return false;</span>
<span class="source-line-no">124</span><span id="line-124"> }</span>
<span class="source-line-no">125</span><span id="line-125"> String hfile = file.getPath().getName();</span>
<span class="source-line-no">126</span><span id="line-126"> boolean foundHFileRef = hfileRefs.contains(hfile);</span>
<span class="source-line-no">127</span><span id="line-127"> return !foundHFileRef;</span>
<span class="source-line-no">128</span><span id="line-128"> });</span>
<span class="source-line-no">129</span><span id="line-129"> return deletables;</span>
<span class="source-line-no">130</span><span id="line-130"> }</span>
<span class="source-line-no">131</span><span id="line-131"></span>
<span class="source-line-no">132</span><span id="line-132"> @Override</span>
<span class="source-line-no">133</span><span id="line-133"> public boolean isFileDeletable(FileStatus fStat) {</span>
<span class="source-line-no">134</span><span id="line-134"> // work is done in getDeletableFiles()</span>
<span class="source-line-no">135</span><span id="line-135"> return true;</span>
<span class="source-line-no">136</span><span id="line-136"> }</span>
<span class="source-line-no">137</span><span id="line-137"></span>
<span class="source-line-no">138</span><span id="line-138"> @Override</span>
<span class="source-line-no">139</span><span id="line-139"> public void setConf(Configuration config) {</span>
<span class="source-line-no">140</span><span id="line-140"> this.conf = config;</span>
<span class="source-line-no">141</span><span id="line-141"> this.connection = null;</span>
<span class="source-line-no">142</span><span id="line-142"> try {</span>
<span class="source-line-no">143</span><span id="line-143"> this.connection = ConnectionFactory.createConnection(conf);</span>
<span class="source-line-no">144</span><span id="line-144"> } catch (IOException ioe) {</span>
<span class="source-line-no">145</span><span id="line-145"> LOG.error("Couldn't establish connection", ioe);</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"></span>
<span class="source-line-no">149</span><span id="line-149"> @Override</span>
<span class="source-line-no">150</span><span id="line-150"> public void stop(String why) {</span>
<span class="source-line-no">151</span><span id="line-151"> if (this.stopped) {</span>
<span class="source-line-no">152</span><span id="line-152"> return;</span>
<span class="source-line-no">153</span><span id="line-153"> }</span>
<span class="source-line-no">154</span><span id="line-154"> if (this.connection != null) {</span>
<span class="source-line-no">155</span><span id="line-155"> try {</span>
<span class="source-line-no">156</span><span id="line-156"> this.connection.close();</span>
<span class="source-line-no">157</span><span id="line-157"> } catch (IOException ioe) {</span>
<span class="source-line-no">158</span><span id="line-158"> LOG.debug("Got " + ioe + " when closing connection");</span>
<span class="source-line-no">159</span><span id="line-159"> }</span>
<span class="source-line-no">160</span><span id="line-160"> }</span>
<span class="source-line-no">161</span><span id="line-161"> this.stopped = true;</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 boolean isStopped() {</span>
<span class="source-line-no">166</span><span id="line-166"> return this.stopped;</span>
<span class="source-line-no">167</span><span id="line-167"> }</span>
<span class="source-line-no">168</span><span id="line-168"></span>
<span class="source-line-no">169</span><span id="line-169"> @Override</span>
<span class="source-line-no">170</span><span id="line-170"> public void abort(String why, Throwable e) {</span>
<span class="source-line-no">171</span><span id="line-171"> LOG.warn("Aborting ReplicationHFileCleaner because " + why, e);</span>
<span class="source-line-no">172</span><span id="line-172"> this.aborted = true;</span>
<span class="source-line-no">173</span><span id="line-173"> stop(why);</span>
<span class="source-line-no">174</span><span id="line-174"> }</span>
<span class="source-line-no">175</span><span id="line-175"></span>
<span class="source-line-no">176</span><span id="line-176"> @Override</span>
<span class="source-line-no">177</span><span id="line-177"> public boolean isAborted() {</span>
<span class="source-line-no">178</span><span id="line-178"> return this.aborted;</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>
</pre>
</div>
</main>
</body>
</html>