blob: b05c48cbf0b6e5af650fe3fc1bae43d63f372310 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MemorySizeUtil (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="MemorySizeUtil (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/MemorySizeUtil.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/hadoop/hbase/io/util/LRUDictionary.BidirectionalLRUMap.Node.html" title="class in org.apache.hadoop.hbase.io.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/hadoop/hbase/io/util/StreamUtils.html" title="class in org.apache.hadoop.hbase.io.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/hadoop/hbase/io/util/MemorySizeUtil.html" target="_top">Frames</a></li>
<li><a href="MemorySizeUtil.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.hadoop.hbase.io.util</div>
<h2 title="Class MemorySizeUtil" class="title">Class MemorySizeUtil</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.hbase.io.util.MemorySizeUtil</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@InterfaceAudience.Private
public class <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#line.36">MemorySizeUtil</a>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Util class to calculate memory size for memstore, block cache(L1, L2) of RS.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#CONVERT_TO_PERCENTAGE">CONVERT_TO_PERCENTAGE</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#DEFAULT_MEMSTORE_SIZE">DEFAULT_MEMSTORE_SIZE</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#DEFAULT_MEMSTORE_SIZE_LOWER_LIMIT">DEFAULT_MEMSTORE_SIZE_LOWER_LIMIT</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#JVM_HEAP_EXCEPTION">JVM_HEAP_EXCEPTION</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static org.slf4j.Logger</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#LOG">LOG</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#MEMSTORE_SIZE_KEY">MEMSTORE_SIZE_KEY</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#MEMSTORE_SIZE_LOWER_LIMIT_KEY">MEMSTORE_SIZE_LOWER_LIMIT_KEY</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#MEMSTORE_SIZE_LOWER_LIMIT_OLD_KEY">MEMSTORE_SIZE_LOWER_LIMIT_OLD_KEY</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#MEMSTORE_SIZE_OLD_KEY">MEMSTORE_SIZE_OLD_KEY</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#OFFHEAP_MEMSTORE_SIZE_KEY">OFFHEAP_MEMSTORE_SIZE_KEY</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#MemorySizeUtil--">MemorySizeUtil</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#checkForClusterFreeHeapMemoryLimit-org.apache.hadoop.conf.Configuration-">checkForClusterFreeHeapMemoryLimit</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf)</code>
<div class="block">Checks whether we have enough heap memory left out after portion for Memstore and Block cache.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#getBlockCacheHeapPercent-org.apache.hadoop.conf.Configuration-">getBlockCacheHeapPercent</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf)</code>
<div class="block">Retrieve configured size for on heap block cache as percentage of total heap.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#getBucketCacheSize-org.apache.hadoop.conf.Configuration-">getBucketCacheSize</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#getGlobalMemStoreHeapLowerMark-org.apache.hadoop.conf.Configuration-boolean-">getGlobalMemStoreHeapLowerMark</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf,
boolean&nbsp;honorOldConfig)</code>
<div class="block">Retrieve configured size for global memstore lower water mark as fraction of global memstore
size.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#getGlobalMemStoreHeapPercent-org.apache.hadoop.conf.Configuration-boolean-">getGlobalMemStoreHeapPercent</a></span>(org.apache.hadoop.conf.Configuration&nbsp;c,
boolean&nbsp;logInvalid)</code>
<div class="block">Retrieve global memstore configured size as percentage of total heap.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/hadoop/hbase/util/Pair.html" title="class in org.apache.hadoop.hbase.util">Pair</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/MemoryType.html?is-external=true" title="class or interface in java.lang.management">MemoryType</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#getGlobalMemStoreSize-org.apache.hadoop.conf.Configuration-">getGlobalMemStoreSize</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#getOnHeapCacheSize-org.apache.hadoop.conf.Configuration-">getOnHeapCacheSize</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf)</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#getOnheapGlobalMemStoreSize-org.apache.hadoop.conf.Configuration-">getOnheapGlobalMemStoreSize</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf)</code>
<div class="block">Returns the onheap global memstore limit based on the config
'hbase.regionserver.global.memstore.size'.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/MemoryUsage.html?is-external=true" title="class or interface in java.lang.management">MemoryUsage</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#safeGetHeapMemoryUsage--">safeGetHeapMemoryUsage</a></span>()</code>
<div class="block">Return JVM memory statistics while properly handling runtime exceptions from the JVM.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="MEMSTORE_SIZE_KEY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MEMSTORE_SIZE_KEY</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#line.38">MEMSTORE_SIZE_KEY</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.util.MemorySizeUtil.MEMSTORE_SIZE_KEY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="MEMSTORE_SIZE_OLD_KEY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MEMSTORE_SIZE_OLD_KEY</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#line.39">MEMSTORE_SIZE_OLD_KEY</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.util.MemorySizeUtil.MEMSTORE_SIZE_OLD_KEY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="MEMSTORE_SIZE_LOWER_LIMIT_KEY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MEMSTORE_SIZE_LOWER_LIMIT_KEY</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#line.41">MEMSTORE_SIZE_LOWER_LIMIT_KEY</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.util.MemorySizeUtil.MEMSTORE_SIZE_LOWER_LIMIT_KEY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="MEMSTORE_SIZE_LOWER_LIMIT_OLD_KEY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MEMSTORE_SIZE_LOWER_LIMIT_OLD_KEY</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#line.43">MEMSTORE_SIZE_LOWER_LIMIT_OLD_KEY</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.util.MemorySizeUtil.MEMSTORE_SIZE_LOWER_LIMIT_OLD_KEY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="OFFHEAP_MEMSTORE_SIZE_KEY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OFFHEAP_MEMSTORE_SIZE_KEY</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#line.47">OFFHEAP_MEMSTORE_SIZE_KEY</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.util.MemorySizeUtil.OFFHEAP_MEMSTORE_SIZE_KEY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_MEMSTORE_SIZE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_MEMSTORE_SIZE</h4>
<pre>public static final&nbsp;float <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#line.50">DEFAULT_MEMSTORE_SIZE</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.util.MemorySizeUtil.DEFAULT_MEMSTORE_SIZE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_MEMSTORE_SIZE_LOWER_LIMIT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_MEMSTORE_SIZE_LOWER_LIMIT</h4>
<pre>public static final&nbsp;float <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#line.52">DEFAULT_MEMSTORE_SIZE_LOWER_LIMIT</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.util.MemorySizeUtil.DEFAULT_MEMSTORE_SIZE_LOWER_LIMIT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="LOG">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LOG</h4>
<pre>private static final&nbsp;org.slf4j.Logger <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#line.54">LOG</a></pre>
</li>
</ul>
<a name="CONVERT_TO_PERCENTAGE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CONVERT_TO_PERCENTAGE</h4>
<pre>private static final&nbsp;int <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#line.56">CONVERT_TO_PERCENTAGE</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.util.MemorySizeUtil.CONVERT_TO_PERCENTAGE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="JVM_HEAP_EXCEPTION">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JVM_HEAP_EXCEPTION</h4>
<pre>private static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#line.58">JVM_HEAP_EXCEPTION</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.util.MemorySizeUtil.JVM_HEAP_EXCEPTION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="MemorySizeUtil--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MemorySizeUtil</h4>
<pre>public&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#line.36">MemorySizeUtil</a>()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="safeGetHeapMemoryUsage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>safeGetHeapMemoryUsage</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/MemoryUsage.html?is-external=true" title="class or interface in java.lang.management">MemoryUsage</a>&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#line.69">safeGetHeapMemoryUsage</a>()</pre>
<div class="block">Return JVM memory statistics while properly handling runtime exceptions from the JVM.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a memory usage object, null if there was a runtime exception. (n.b. you
could also get -1 values back from the JVM)</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/MemoryUsage.html?is-external=true" title="class or interface in java.lang.management"><code>MemoryUsage</code></a></dd>
</dl>
</li>
</ul>
<a name="checkForClusterFreeHeapMemoryLimit-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkForClusterFreeHeapMemoryLimit</h4>
<pre>public static&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#line.84">checkForClusterFreeHeapMemoryLimit</a>(org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
<div class="block">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.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conf</code> - </dd>
</dl>
</li>
</ul>
<a name="getGlobalMemStoreHeapPercent-org.apache.hadoop.conf.Configuration-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGlobalMemStoreHeapPercent</h4>
<pre>public static&nbsp;float&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#line.110">getGlobalMemStoreHeapPercent</a>(org.apache.hadoop.conf.Configuration&nbsp;c,
boolean&nbsp;logInvalid)</pre>
<div class="block">Retrieve global memstore configured size as percentage of total heap.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>c</code> - </dd>
<dd><code>logInvalid</code> - </dd>
</dl>
</li>
</ul>
<a name="getGlobalMemStoreHeapLowerMark-org.apache.hadoop.conf.Configuration-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGlobalMemStoreHeapLowerMark</h4>
<pre>public static&nbsp;float&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#line.128">getGlobalMemStoreHeapLowerMark</a>(org.apache.hadoop.conf.Configuration&nbsp;conf,
boolean&nbsp;honorOldConfig)</pre>
<div class="block">Retrieve configured size for global memstore lower water mark as fraction of global memstore
size.</div>
</li>
</ul>
<a name="getGlobalMemStoreSize-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGlobalMemStoreSize</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/hadoop/hbase/util/Pair.html" title="class in org.apache.hadoop.hbase.util">Pair</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/MemoryType.html?is-external=true" title="class or interface in java.lang.management">MemoryType</a>&gt;&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#line.162">getGlobalMemStoreSize</a>(org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Pair of global memstore size and memory type(ie. on heap or off heap).</dd>
</dl>
</li>
</ul>
<a name="getOnheapGlobalMemStoreSize-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOnheapGlobalMemStoreSize</h4>
<pre>public static&nbsp;long&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#line.190">getOnheapGlobalMemStoreSize</a>(org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
<div class="block">Returns the onheap global memstore limit based on the config
'hbase.regionserver.global.memstore.size'.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conf</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the onheap global memstore limt</dd>
</dl>
</li>
</ul>
<a name="getBlockCacheHeapPercent-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBlockCacheHeapPercent</h4>
<pre>public static&nbsp;float&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#line.204">getBlockCacheHeapPercent</a>(org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
<div class="block">Retrieve configured size for on heap block cache as percentage of total heap.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conf</code> - </dd>
</dl>
</li>
</ul>
<a name="getOnHeapCacheSize-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOnHeapCacheSize</h4>
<pre>public static&nbsp;long&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#line.216">getOnHeapCacheSize</a>(org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conf</code> - used to read cache configs</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of bytes to use for LRU, negative if disabled.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if HFILE_BLOCK_CACHE_SIZE_KEY is > 1.0</dd>
</dl>
</li>
</ul>
<a name="getBucketCacheSize-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getBucketCacheSize</h4>
<pre>public static&nbsp;long&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/util/MemorySizeUtil.html#line.240">getBucketCacheSize</a>(org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conf</code> - used to read config for bucket cache size.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of bytes to use for bucket cache, negative if disabled.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/MemorySizeUtil.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/hadoop/hbase/io/util/LRUDictionary.BidirectionalLRUMap.Node.html" title="class in org.apache.hadoop.hbase.io.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/hadoop/hbase/io/util/StreamUtils.html" title="class in org.apache.hadoop.hbase.io.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/hadoop/hbase/io/util/MemorySizeUtil.html" target="_top">Frames</a></li>
<li><a href="MemorySizeUtil.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>