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