hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/HeapMemoryTuner.java

/**
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.hadoop.hbase.regionserver;

import org.apache.yetus.audience.InterfaceAudience;
import org.apache.yetus.audience.InterfaceStability;
import org.apache.hadoop.conf.Configurable;
import org.apache.hadoop.hbase.regionserver.HeapMemoryManager.TunerContext;
import org.apache.hadoop.hbase.regionserver.HeapMemoryManager.TunerResult;

/**
 * Makes the decision regarding proper sizing of the heap memory. Decides what percentage of heap
 * memory should be allocated for global memstore and BlockCache.
 */
@InterfaceAudience.Private
@InterfaceStability.Evolving
public interface HeapMemoryTuner extends Configurable {

  /**
   * Perform the heap memory tuning operation.
   *
   * @param context
   * @return <code>TunerResult</code> including the heap percentage for memstore and block cache
   */
  TunerResult tune(TunerContext context);
}