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 org.apache.hadoop.hbase.classification.InterfaceAudience;
22 import org.apache.hadoop.hbase.classification.InterfaceStability;
23 import org.apache.hadoop.conf.Configurable;
24 import org.apache.hadoop.hbase.regionserver.HeapMemoryManager.TunerContext;
25 import org.apache.hadoop.hbase.regionserver.HeapMemoryManager.TunerResult;
26
27 /**
28 * Makes the decision regarding proper sizing of the heap memory. Decides what percentage of heap
29 * memory should be allocated for global memstore and BlockCache.
30 */
31 @InterfaceAudience.Private
32 @InterfaceStability.Evolving
33 public interface HeapMemoryTuner extends Configurable {
34
35 /**
36 * Perform the heap memory tuning operation.
37 *
38 * @param context
39 * @return <code>TunerResult</code> including the heap percentage for memstore and block cache
40 */
41 TunerResult tune(TunerContext context);
42 }