| <!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.Set;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.fs.FileStatus;</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.Abortable;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.HBaseInterfaceAudience;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.TableName;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.backup.impl.BackupSystemTable;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.backup.impl.BulkLoad;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.client.Connection;</span> |
| <span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.client.ConnectionFactory;</span> |
| <span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.master.cleaner.BaseHFileCleanerDelegate;</span> |
| <span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;</span> |
| <span class="source-line-no">036</span><span id="line-36">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">037</span><span id="line-37">import org.slf4j.Logger;</span> |
| <span class="source-line-no">038</span><span id="line-38">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">039</span><span id="line-39"></span> |
| <span class="source-line-no">040</span><span id="line-40">import org.apache.hbase.thirdparty.com.google.common.collect.Iterables;</span> |
| <span class="source-line-no">041</span><span id="line-41"></span> |
| <span class="source-line-no">042</span><span id="line-42">/**</span> |
| <span class="source-line-no">043</span><span id="line-43"> * File cleaner that prevents deletion of HFiles that are still required by future incremental</span> |
| <span class="source-line-no">044</span><span id="line-44"> * backups.</span> |
| <span class="source-line-no">045</span><span id="line-45"> * <p></span> |
| <span class="source-line-no">046</span><span id="line-46"> * Bulk loaded HFiles that are needed by future updates are stored in the backup system table.</span> |
| <span class="source-line-no">047</span><span id="line-47"> */</span> |
| <span class="source-line-no">048</span><span id="line-48">@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.CONFIG)</span> |
| <span class="source-line-no">049</span><span id="line-49">public class BackupHFileCleaner extends BaseHFileCleanerDelegate implements Abortable {</span> |
| <span class="source-line-no">050</span><span id="line-50"> private static final Logger LOG = LoggerFactory.getLogger(BackupHFileCleaner.class);</span> |
| <span class="source-line-no">051</span><span id="line-51"></span> |
| <span class="source-line-no">052</span><span id="line-52"> private boolean stopped = false;</span> |
| <span class="source-line-no">053</span><span id="line-53"> private boolean aborted = false;</span> |
| <span class="source-line-no">054</span><span id="line-54"> private Connection connection;</span> |
| <span class="source-line-no">055</span><span id="line-55"> // timestamp of most recent read from backup system table</span> |
| <span class="source-line-no">056</span><span id="line-56"> private long prevReadFromBackupTbl = 0;</span> |
| <span class="source-line-no">057</span><span id="line-57"> // timestamp of 2nd most recent read from backup system table</span> |
| <span class="source-line-no">058</span><span id="line-58"> private long secondPrevReadFromBackupTbl = 0;</span> |
| <span class="source-line-no">059</span><span id="line-59"></span> |
| <span class="source-line-no">060</span><span id="line-60"> @Override</span> |
| <span class="source-line-no">061</span><span id="line-61"> public Iterable<FileStatus> getDeletableFiles(Iterable<FileStatus> files) {</span> |
| <span class="source-line-no">062</span><span id="line-62"> if (stopped) {</span> |
| <span class="source-line-no">063</span><span id="line-63"> return Collections.emptyList();</span> |
| <span class="source-line-no">064</span><span id="line-64"> }</span> |
| <span class="source-line-no">065</span><span id="line-65"></span> |
| <span class="source-line-no">066</span><span id="line-66"> // We use filenames because the HFile will have been moved to the archive since it</span> |
| <span class="source-line-no">067</span><span id="line-67"> // was registered.</span> |
| <span class="source-line-no">068</span><span id="line-68"> final Set<String> hfileFilenames = new HashSet<>();</span> |
| <span class="source-line-no">069</span><span id="line-69"> try (BackupSystemTable tbl = new BackupSystemTable(connection)) {</span> |
| <span class="source-line-no">070</span><span id="line-70"> Set<TableName> tablesIncludedInBackups = fetchFullyBackedUpTables(tbl);</span> |
| <span class="source-line-no">071</span><span id="line-71"> for (BulkLoad bulkLoad : tbl.readBulkloadRows(tablesIncludedInBackups)) {</span> |
| <span class="source-line-no">072</span><span id="line-72"> hfileFilenames.add(new Path(bulkLoad.getHfilePath()).getName());</span> |
| <span class="source-line-no">073</span><span id="line-73"> }</span> |
| <span class="source-line-no">074</span><span id="line-74"> LOG.debug("Found {} unique HFile filenames registered as bulk loads.", hfileFilenames.size());</span> |
| <span class="source-line-no">075</span><span id="line-75"> } catch (IOException ioe) {</span> |
| <span class="source-line-no">076</span><span id="line-76"> LOG.error(</span> |
| <span class="source-line-no">077</span><span id="line-77"> "Failed to read registered bulk load references from backup system table, marking all files as non-deletable.",</span> |
| <span class="source-line-no">078</span><span id="line-78"> ioe);</span> |
| <span class="source-line-no">079</span><span id="line-79"> return Collections.emptyList();</span> |
| <span class="source-line-no">080</span><span id="line-80"> }</span> |
| <span class="source-line-no">081</span><span id="line-81"></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"></span> |
| <span class="source-line-no">085</span><span id="line-85"> return Iterables.filter(files, file -> {</span> |
| <span class="source-line-no">086</span><span id="line-86"> // If the file is recent, be conservative and wait for one more scan of the bulk loads</span> |
| <span class="source-line-no">087</span><span id="line-87"> if (file.getModificationTime() > secondPrevReadFromBackupTbl) {</span> |
| <span class="source-line-no">088</span><span id="line-88"> LOG.debug("Preventing deletion due to timestamp: {}", file.getPath().toString());</span> |
| <span class="source-line-no">089</span><span id="line-89"> return false;</span> |
| <span class="source-line-no">090</span><span id="line-90"> }</span> |
| <span class="source-line-no">091</span><span id="line-91"> // A file can be deleted if it is not registered as a backup bulk load.</span> |
| <span class="source-line-no">092</span><span id="line-92"> String hfile = file.getPath().getName();</span> |
| <span class="source-line-no">093</span><span id="line-93"> if (hfileFilenames.contains(hfile)) {</span> |
| <span class="source-line-no">094</span><span id="line-94"> LOG.debug("Preventing deletion due to bulk load registration in backup system table: {}",</span> |
| <span class="source-line-no">095</span><span id="line-95"> file.getPath().toString());</span> |
| <span class="source-line-no">096</span><span id="line-96"> return false;</span> |
| <span class="source-line-no">097</span><span id="line-97"> } else {</span> |
| <span class="source-line-no">098</span><span id="line-98"> LOG.debug("OK to delete: {}", file.getPath().toString());</span> |
| <span class="source-line-no">099</span><span id="line-99"> return true;</span> |
| <span class="source-line-no">100</span><span id="line-100"> }</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"></span> |
| <span class="source-line-no">104</span><span id="line-104"> protected Set<TableName> fetchFullyBackedUpTables(BackupSystemTable tbl) throws IOException {</span> |
| <span class="source-line-no">105</span><span id="line-105"> return tbl.getTablesIncludedInBackups();</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"> @Override</span> |
| <span class="source-line-no">109</span><span id="line-109"> public boolean isFileDeletable(FileStatus fStat) {</span> |
| <span class="source-line-no">110</span><span id="line-110"> throw new IllegalStateException("This method should not be called");</span> |
| <span class="source-line-no">111</span><span id="line-111"> }</span> |
| <span class="source-line-no">112</span><span id="line-112"></span> |
| <span class="source-line-no">113</span><span id="line-113"> @Override</span> |
| <span class="source-line-no">114</span><span id="line-114"> public void setConf(Configuration config) {</span> |
| <span class="source-line-no">115</span><span id="line-115"> this.connection = null;</span> |
| <span class="source-line-no">116</span><span id="line-116"> try {</span> |
| <span class="source-line-no">117</span><span id="line-117"> this.connection = ConnectionFactory.createConnection(config);</span> |
| <span class="source-line-no">118</span><span id="line-118"> } catch (IOException ioe) {</span> |
| <span class="source-line-no">119</span><span id="line-119"> LOG.error("Couldn't establish connection", ioe);</span> |
| <span class="source-line-no">120</span><span id="line-120"> }</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 void stop(String why) {</span> |
| <span class="source-line-no">125</span><span id="line-125"> if (this.stopped) {</span> |
| <span class="source-line-no">126</span><span id="line-126"> return;</span> |
| <span class="source-line-no">127</span><span id="line-127"> }</span> |
| <span class="source-line-no">128</span><span id="line-128"> if (this.connection != null) {</span> |
| <span class="source-line-no">129</span><span id="line-129"> try {</span> |
| <span class="source-line-no">130</span><span id="line-130"> this.connection.close();</span> |
| <span class="source-line-no">131</span><span id="line-131"> } catch (IOException ioe) {</span> |
| <span class="source-line-no">132</span><span id="line-132"> LOG.debug("Got IOException when closing connection", ioe);</span> |
| <span class="source-line-no">133</span><span id="line-133"> }</span> |
| <span class="source-line-no">134</span><span id="line-134"> }</span> |
| <span class="source-line-no">135</span><span id="line-135"> this.stopped = 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 boolean isStopped() {</span> |
| <span class="source-line-no">140</span><span id="line-140"> return this.stopped;</span> |
| <span class="source-line-no">141</span><span id="line-141"> }</span> |
| <span class="source-line-no">142</span><span id="line-142"></span> |
| <span class="source-line-no">143</span><span id="line-143"> @Override</span> |
| <span class="source-line-no">144</span><span id="line-144"> public void abort(String why, Throwable e) {</span> |
| <span class="source-line-no">145</span><span id="line-145"> LOG.warn("Aborting ReplicationHFileCleaner because {}", why, e);</span> |
| <span class="source-line-no">146</span><span id="line-146"> this.aborted = true;</span> |
| <span class="source-line-no">147</span><span id="line-147"> stop(why);</span> |
| <span class="source-line-no">148</span><span id="line-148"> }</span> |
| <span class="source-line-no">149</span><span id="line-149"></span> |
| <span class="source-line-no">150</span><span id="line-150"> @Override</span> |
| <span class="source-line-no">151</span><span id="line-151"> public boolean isAborted() {</span> |
| <span class="source-line-no">152</span><span id="line-152"> return this.aborted;</span> |
| <span class="source-line-no">153</span><span id="line-153"> }</span> |
| <span class="source-line-no">154</span><span id="line-154">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
