001/**
002 *
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *     http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing, software
014 * distributed under the License is distributed on an "AS IS" BASIS,
015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016 * See the License for the specific language governing permissions and
017 * limitations under the License.
018 */
019package org.apache.hadoop.hbase.regionserver;
020
021import org.apache.yetus.audience.InterfaceAudience;
022import org.apache.yetus.audience.InterfaceStability;
023import org.apache.hadoop.conf.Configurable;
024import org.apache.hadoop.hbase.regionserver.HeapMemoryManager.TunerContext;
025import org.apache.hadoop.hbase.regionserver.HeapMemoryManager.TunerResult;
026
027/**
028 * Makes the decision regarding proper sizing of the heap memory. Decides what percentage of heap
029 * memory should be allocated for global memstore and BlockCache.
030 */
031@InterfaceAudience.Private
032@InterfaceStability.Evolving
033public interface HeapMemoryTuner extends Configurable {
034
035  /**
036   * Perform the heap memory tuning operation.
037   *
038   * @param context
039   * @return <code>TunerResult</code> including the heap percentage for memstore and block cache
040   */
041  TunerResult tune(TunerContext context);
042}