View Javadoc

1   /**
2    *
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *     http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing, software
14   * distributed under the License is distributed on an "AS IS" BASIS,
15   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   * See the License for the specific language governing permissions and
17   * limitations under the License.
18   */
19  package org.apache.hadoop.hbase.regionserver;
20  
21  import java.io.IOException;
22  import java.util.List;
23  
24  import org.apache.hadoop.conf.Configuration;
25  import org.apache.hadoop.fs.Path;
26  import org.apache.hadoop.hbase.CellComparator;
27  import org.apache.hadoop.hbase.HBaseInterfaceAudience;
28  import org.apache.hadoop.hbase.classification.InterfaceAudience;
29  import org.apache.hadoop.hbase.regionserver.compactions.CompactionContext;
30  import org.apache.hadoop.hbase.regionserver.compactions.DefaultCompactor;
31  import org.apache.hadoop.hbase.regionserver.compactions.ExploringCompactionPolicy;
32  import org.apache.hadoop.hbase.regionserver.compactions.RatioBasedCompactionPolicy;
33  import org.apache.hadoop.hbase.regionserver.throttle.ThroughputController;
34  import org.apache.hadoop.hbase.security.User;
35  import org.apache.hadoop.hbase.util.ReflectionUtils;
36  
37  /**
38   * Default StoreEngine creates the default compactor, policy, and store file manager, or
39   * their derivatives.
40   */
41  @InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.CONFIG)
42  public class DefaultStoreEngine extends StoreEngine<
43    DefaultStoreFlusher, RatioBasedCompactionPolicy, DefaultCompactor, DefaultStoreFileManager> {
44  
45    public static final String DEFAULT_STORE_FLUSHER_CLASS_KEY =
46        "hbase.hstore.defaultengine.storeflusher.class";
47    public static final String DEFAULT_COMPACTOR_CLASS_KEY =
48        "hbase.hstore.defaultengine.compactor.class";
49    public static final String DEFAULT_COMPACTION_POLICY_CLASS_KEY =
50        "hbase.hstore.defaultengine.compactionpolicy.class";
51  
52    private static final Class<? extends DefaultStoreFlusher>
53      DEFAULT_STORE_FLUSHER_CLASS = DefaultStoreFlusher.class;
54    private static final Class<? extends DefaultCompactor>
55      DEFAULT_COMPACTOR_CLASS = DefaultCompactor.class;
56    private static final Class<? extends RatioBasedCompactionPolicy>
57      DEFAULT_COMPACTION_POLICY_CLASS = ExploringCompactionPolicy.class;
58  
59    @Override
60    public boolean needsCompaction(List<StoreFile> filesCompacting) {
61      return compactionPolicy.needsCompaction(
62          this.storeFileManager.getStorefiles(), filesCompacting);
63    }
64  
65    @Override
66    protected void createComponents(
67        Configuration conf, Store store, CellComparator kvComparator) throws IOException {
68      createCompactor(conf, store);
69      createCompactionPolicy(conf, store);
70      createStoreFlusher(conf, store);
71      storeFileManager = new DefaultStoreFileManager(kvComparator, conf, compactionPolicy.getConf());
72  
73    }
74  
75    protected void createCompactor(Configuration conf, Store store) throws IOException {
76      String className = conf.get(DEFAULT_COMPACTOR_CLASS_KEY, DEFAULT_COMPACTOR_CLASS.getName());
77      try {
78        compactor = ReflectionUtils.instantiateWithCustomCtor(className,
79            new Class[] { Configuration.class, Store.class }, new Object[] { conf, store });
80      } catch (Exception e) {
81        throw new IOException("Unable to load configured compactor '" + className + "'", e);
82      }
83    }
84  
85    protected void createCompactionPolicy(Configuration conf, Store store) throws IOException {
86      String className = conf.get(
87          DEFAULT_COMPACTION_POLICY_CLASS_KEY, DEFAULT_COMPACTION_POLICY_CLASS.getName());
88      try {
89        compactionPolicy = ReflectionUtils.instantiateWithCustomCtor(className,
90            new Class[] { Configuration.class, StoreConfigInformation.class },
91            new Object[] { conf, store });
92      } catch (Exception e) {
93        throw new IOException("Unable to load configured compaction policy '" + className + "'", e);
94      }
95    }
96  
97    protected void createStoreFlusher(Configuration conf, Store store) throws IOException {
98      String className = conf.get(
99          DEFAULT_STORE_FLUSHER_CLASS_KEY, DEFAULT_STORE_FLUSHER_CLASS.getName());
100     try {
101       storeFlusher = ReflectionUtils.instantiateWithCustomCtor(className,
102           new Class[] { Configuration.class, Store.class }, new Object[] { conf, store });
103     } catch (Exception e) {
104       throw new IOException("Unable to load configured store flusher '" + className + "'", e);
105     }
106   }
107 
108   @Override
109   public CompactionContext createCompaction() {
110     return new DefaultCompactionContext();
111   }
112 
113   private class DefaultCompactionContext extends CompactionContext {
114     @Override
115     public boolean select(List<StoreFile> filesCompacting, boolean isUserCompaction,
116         boolean mayUseOffPeak, boolean forceMajor) throws IOException {
117       request = compactionPolicy.selectCompaction(storeFileManager.getStorefiles(),
118           filesCompacting, isUserCompaction, mayUseOffPeak, forceMajor);
119       return request != null;
120     }
121 
122     @Override
123     public List<Path> compact(ThroughputController throughputController)
124         throws IOException {
125       return compact(throughputController, null);
126     }
127 
128     @Override
129     public List<Path> compact(ThroughputController throughputController, User user)
130         throws IOException {
131       return compactor.compact(request, throughputController, user);
132     }
133 
134     @Override
135     public List<StoreFile> preSelect(List<StoreFile> filesCompacting) {
136       return compactionPolicy.preSelectCompactionForCoprocessor(
137           storeFileManager.getStorefiles(), filesCompacting);
138     }
139   }
140 
141 }