View Javadoc

1   /**
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  package org.apache.hadoop.hbase.master.cleaner;
19  
20  import java.io.IOException;
21  
22  import org.apache.commons.logging.Log;
23  import org.apache.commons.logging.LogFactory;
24  import org.apache.hadoop.hbase.classification.InterfaceAudience;
25  import org.apache.hadoop.conf.Configuration;
26  import org.apache.hadoop.fs.FileStatus;
27  import org.apache.hadoop.fs.FileSystem;
28  import org.apache.hadoop.fs.Path;
29  import org.apache.hadoop.hbase.HBaseInterfaceAudience;
30  import org.apache.hadoop.hbase.io.HFileLink;
31  import org.apache.hadoop.hbase.util.FSUtils;
32  
33  /**
34   * HFileLink cleaner that determines if a hfile should be deleted.
35   * HFiles can be deleted only if there're no links to them.
36   *
37   * When a HFileLink is created a back reference file is created in:
38   *      /hbase/archive/table/region/cf/.links-hfile/ref-region.ref-table
39   * To check if the hfile can be deleted the back references folder must be empty.
40   */
41  @InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.CONFIG)
42  public class HFileLinkCleaner extends BaseHFileCleanerDelegate {
43    private static final Log LOG = LogFactory.getLog(HFileLinkCleaner.class);
44  
45    private FileSystem fs = null;
46  
47    @Override
48    public synchronized boolean isFileDeletable(FileStatus fStat) {
49      if (this.fs == null) return false;
50      Path filePath = fStat.getPath();
51      // HFile Link is always deletable
52      if (HFileLink.isHFileLink(filePath)) return true;
53  
54      // If the file is inside a link references directory, means that it is a back ref link.
55      // The back ref can be deleted only if the referenced file doesn't exists.
56      Path parentDir = filePath.getParent();
57      if (HFileLink.isBackReferencesDir(parentDir)) {
58        Path hfilePath = null;
59        try {
60          hfilePath = HFileLink.getHFileFromBackReference(getConf(), filePath);
61          return !fs.exists(hfilePath);
62        } catch (IOException e) {
63          if (LOG.isDebugEnabled()) {
64            LOG.debug("Couldn't verify if the referenced file still exists, keep it just in case: "
65                + hfilePath);
66          }
67          return false;
68        }
69      }
70  
71      // HFile is deletable only if has no links
72      Path backRefDir = null;
73      try {
74        backRefDir = HFileLink.getBackReferencesDir(parentDir, filePath.getName());
75        return FSUtils.listStatus(fs, backRefDir) == null;
76      } catch (IOException e) {
77        if (LOG.isDebugEnabled()) {
78          LOG.debug("Couldn't get the references, not deleting file, just in case. filePath="
79              + filePath + ", backRefDir=" + backRefDir);
80        }
81        return false;
82      }
83    }
84  
85    @Override
86    public void setConf(Configuration conf) {
87      super.setConf(conf);
88  
89      // setup filesystem
90      try {
91        this.fs = FileSystem.get(this.getConf());
92      } catch (IOException e) {
93        if (LOG.isDebugEnabled()) {
94          LOG.debug("Couldn't instantiate the file system, not deleting file, just in case. "
95              + FileSystem.FS_DEFAULT_NAME_KEY + "="
96              + getConf().get(FileSystem.FS_DEFAULT_NAME_KEY, FileSystem.DEFAULT_FS));
97        }
98      }
99    }
100 }