org.apache.hadoop.hbase.io.util

Class HeapMemorySizeUtil

java.lang.Object

org.apache.hadoop.hbase.io.util.HeapMemorySizeUtil

@InterfaceAudience.Private
public class HeapMemorySizeUtil
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static float	DEFAULT_MEMSTORE_SIZE
static float	DEFAULT_MEMSTORE_SIZE_LOWER_LIMIT
static String	MEMSTORE_SIZE_KEY
static String	MEMSTORE_SIZE_LOWER_LIMIT_KEY
static String	MEMSTORE_SIZE_LOWER_LIMIT_OLD_KEY
static String	MEMSTORE_SIZE_OLD_KEY

Constructor Summary

Constructors

Constructor and Description
HeapMemorySizeUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static void	checkForClusterFreeMemoryLimit(org.apache.hadoop.conf.Configuration conf) Checks whether we have enough heap memory left out after portion for Memstore and Block cache.
static float	getBlockCacheHeapPercent(org.apache.hadoop.conf.Configuration conf) Retrieve configured size for on heap block cache as percentage of total heap.
static long	getBucketCacheSize(org.apache.hadoop.conf.Configuration conf)
static float	getGlobalMemStoreLowerMark(org.apache.hadoop.conf.Configuration conf, float globalMemStorePercent) Retrieve configured size for global memstore lower water mark as fraction of global memstore size.
static float	getGlobalMemStorePercent(org.apache.hadoop.conf.Configuration c, boolean logInvalid) Retrieve global memstore configured size as percentage of total heap.
static float	getL2BlockCacheHeapPercent(org.apache.hadoop.conf.Configuration conf)
static long	getLruCacheSize(org.apache.hadoop.conf.Configuration conf)
static MemoryUsage	safeGetHeapMemoryUsage() Return JVM memory statistics while properly handling runtime exceptions from the JVM.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MEMSTORE_SIZE_KEY

public static final String MEMSTORE_SIZE_KEY

See Also:

Constant Field Values

MEMSTORE_SIZE_OLD_KEY

public static final String MEMSTORE_SIZE_OLD_KEY

See Also:

Constant Field Values

MEMSTORE_SIZE_LOWER_LIMIT_KEY

public static final String MEMSTORE_SIZE_LOWER_LIMIT_KEY

See Also:

Constant Field Values

MEMSTORE_SIZE_LOWER_LIMIT_OLD_KEY

public static final String MEMSTORE_SIZE_LOWER_LIMIT_OLD_KEY

See Also:

Constant Field Values

DEFAULT_MEMSTORE_SIZE

public static final float DEFAULT_MEMSTORE_SIZE

See Also:

Constant Field Values

DEFAULT_MEMSTORE_SIZE_LOWER_LIMIT

public static final float DEFAULT_MEMSTORE_SIZE_LOWER_LIMIT

See Also:

Constant Field Values

Constructor Detail

HeapMemorySizeUtil

public HeapMemorySizeUtil()

Method Detail

safeGetHeapMemoryUsage

public static MemoryUsage safeGetHeapMemoryUsage()

Return JVM memory statistics while properly handling runtime exceptions from the JVM.

Returns:

a memory usage object, null if there was a runtime exception. (n.b. you could also get -1 values back from the JVM)

See Also:

MemoryUsage

checkForClusterFreeMemoryLimit

public static void checkForClusterFreeMemoryLimit(org.apache.hadoop.conf.Configuration conf)

Checks whether we have enough heap memory left out after portion for Memstore and Block cache. We need atleast 20% of heap left out for other RS functions.

Parameters:

conf -

getGlobalMemStorePercent

public static float getGlobalMemStorePercent(org.apache.hadoop.conf.Configuration c,
                             boolean logInvalid)

Retrieve global memstore configured size as percentage of total heap.

Parameters:

c -

logInvalid -

getGlobalMemStoreLowerMark

public static float getGlobalMemStoreLowerMark(org.apache.hadoop.conf.Configuration conf,
                               float globalMemStorePercent)

Retrieve configured size for global memstore lower water mark as fraction of global memstore size.

getBlockCacheHeapPercent

public static float getBlockCacheHeapPercent(org.apache.hadoop.conf.Configuration conf)

Retrieve configured size for on heap block cache as percentage of total heap.

Parameters:

conf -

getL2BlockCacheHeapPercent

public static float getL2BlockCacheHeapPercent(org.apache.hadoop.conf.Configuration conf)

Parameters:

conf -

Returns:

The on heap size for L2 block cache.

getLruCacheSize

public static long getLruCacheSize(org.apache.hadoop.conf.Configuration conf)

Parameters:

conf - used to read cache configs

Returns:

the number of bytes to use for LRU, negative if disabled.

Throws:

IllegalArgumentException - if HFILE_BLOCK_CACHE_SIZE_KEY is > 1.0

getBucketCacheSize

public static long getBucketCacheSize(org.apache.hadoop.conf.Configuration conf)

Parameters:

conf - used to read config for bucket cache size. (< 1 is treated as % and > is treated as MiB)

Returns:

the number of bytes to use for bucket cache, negative if disabled.