| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.hadoop.hbase.regionserver, interface: MemStoreSizing"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.regionserver;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">021</span><span id="line-21"></span> |
| <span class="source-line-no">022</span><span id="line-22">/**</span> |
| <span class="source-line-no">023</span><span id="line-23"> * Accounting of current heap and data sizes. Tracks 3 sizes:</span> |
| <span class="source-line-no">024</span><span id="line-24"> * <ol></span> |
| <span class="source-line-no">025</span><span id="line-25"> * <li></li>data size: the aggregated size of all key-value not including meta data such as index,</span> |
| <span class="source-line-no">026</span><span id="line-26"> * time range etc.</li></span> |
| <span class="source-line-no">027</span><span id="line-27"> * <li>heap size: the aggregated size of all data that is allocated on-heap including all key-values</span> |
| <span class="source-line-no">028</span><span id="line-28"> * that reside on-heap and the metadata that resides on-heap</li></span> |
| <span class="source-line-no">029</span><span id="line-29"> * <li></li>off-heap size: the aggregated size of all data that is allocated off-heap including all</span> |
| <span class="source-line-no">030</span><span id="line-30"> * key-values that reside off-heap and the metadata that resides off-heap</li></span> |
| <span class="source-line-no">031</span><span id="line-31"> * </ol></span> |
| <span class="source-line-no">032</span><span id="line-32"> * 3 examples to illustrate their usage:</span> |
| <span class="source-line-no">033</span><span id="line-33"> * <p></span> |
| <span class="source-line-no">034</span><span id="line-34"> * Consider a store with 100MB of key-values allocated on-heap and 20MB of metadata allocated</span> |
| <span class="source-line-no">035</span><span id="line-35"> * on-heap. The counters are <100MB, 120MB, 0>, respectively.</span> |
| <span class="source-line-no">036</span><span id="line-36"> * </p></span> |
| <span class="source-line-no">037</span><span id="line-37"> * <p></span> |
| <span class="source-line-no">038</span><span id="line-38"> * Consider a store with 100MB of key-values allocated off-heap and 20MB of metadata allocated</span> |
| <span class="source-line-no">039</span><span id="line-39"> * on-heap (e.g, CAM index). The counters are <100MB, 20MB, 100MB>, respectively.</span> |
| <span class="source-line-no">040</span><span id="line-40"> * </p></span> |
| <span class="source-line-no">041</span><span id="line-41"> * <p></span> |
| <span class="source-line-no">042</span><span id="line-42"> * Consider a store with 100MB of key-values from which 95MB are allocated off-heap and 5MB are</span> |
| <span class="source-line-no">043</span><span id="line-43"> * allocated on-heap (e.g., due to upserts) and 20MB of metadata from which 15MB allocated off-heap</span> |
| <span class="source-line-no">044</span><span id="line-44"> * (e.g, CCM index) and 5MB allocated on-heap (e.g, CSLM index in active). The counters are <100MB,</span> |
| <span class="source-line-no">045</span><span id="line-45"> * 10MB, 110MB>, respectively.</span> |
| <span class="source-line-no">046</span><span id="line-46"> * </p></span> |
| <span class="source-line-no">047</span><span id="line-47"> * Like {@link TimeRangeTracker}, it has thread-safe and non-thread-safe implementations.</span> |
| <span class="source-line-no">048</span><span id="line-48"> */</span> |
| <span class="source-line-no">049</span><span id="line-49">@InterfaceAudience.Private</span> |
| <span class="source-line-no">050</span><span id="line-50">public interface MemStoreSizing {</span> |
| <span class="source-line-no">051</span><span id="line-51"> MemStoreSizing DUD = new MemStoreSizing() {</span> |
| <span class="source-line-no">052</span><span id="line-52"> private final MemStoreSize mss = new MemStoreSize();</span> |
| <span class="source-line-no">053</span><span id="line-53"></span> |
| <span class="source-line-no">054</span><span id="line-54"> @Override</span> |
| <span class="source-line-no">055</span><span id="line-55"> public MemStoreSize getMemStoreSize() {</span> |
| <span class="source-line-no">056</span><span id="line-56"> return this.mss;</span> |
| <span class="source-line-no">057</span><span id="line-57"> }</span> |
| <span class="source-line-no">058</span><span id="line-58"></span> |
| <span class="source-line-no">059</span><span id="line-59"> @Override</span> |
| <span class="source-line-no">060</span><span id="line-60"> public long getDataSize() {</span> |
| <span class="source-line-no">061</span><span id="line-61"> return this.mss.getDataSize();</span> |
| <span class="source-line-no">062</span><span id="line-62"> }</span> |
| <span class="source-line-no">063</span><span id="line-63"></span> |
| <span class="source-line-no">064</span><span id="line-64"> @Override</span> |
| <span class="source-line-no">065</span><span id="line-65"> public long getHeapSize() {</span> |
| <span class="source-line-no">066</span><span id="line-66"> return this.mss.getHeapSize();</span> |
| <span class="source-line-no">067</span><span id="line-67"> }</span> |
| <span class="source-line-no">068</span><span id="line-68"></span> |
| <span class="source-line-no">069</span><span id="line-69"> @Override</span> |
| <span class="source-line-no">070</span><span id="line-70"> public long getOffHeapSize() {</span> |
| <span class="source-line-no">071</span><span id="line-71"> return this.mss.getOffHeapSize();</span> |
| <span class="source-line-no">072</span><span id="line-72"> }</span> |
| <span class="source-line-no">073</span><span id="line-73"></span> |
| <span class="source-line-no">074</span><span id="line-74"> @Override</span> |
| <span class="source-line-no">075</span><span id="line-75"> public int getCellsCount() {</span> |
| <span class="source-line-no">076</span><span id="line-76"> return this.mss.getCellsCount();</span> |
| <span class="source-line-no">077</span><span id="line-77"> }</span> |
| <span class="source-line-no">078</span><span id="line-78"></span> |
| <span class="source-line-no">079</span><span id="line-79"> @Override</span> |
| <span class="source-line-no">080</span><span id="line-80"> public long incMemStoreSize(long dataSizeDelta, long heapSizeDelta, long offHeapSizeDelta,</span> |
| <span class="source-line-no">081</span><span id="line-81"> int cellsCountDelta) {</span> |
| <span class="source-line-no">082</span><span id="line-82"> throw new RuntimeException("I'm a DUD, you can't use me!");</span> |
| <span class="source-line-no">083</span><span id="line-83"> }</span> |
| <span class="source-line-no">084</span><span id="line-84"></span> |
| <span class="source-line-no">085</span><span id="line-85"> @Override</span> |
| <span class="source-line-no">086</span><span id="line-86"> public boolean compareAndSetDataSize(long expected, long updated) {</span> |
| <span class="source-line-no">087</span><span id="line-87"> throw new RuntimeException("I'm a DUD, you can't use me!");</span> |
| <span class="source-line-no">088</span><span id="line-88"> }</span> |
| <span class="source-line-no">089</span><span id="line-89"> };</span> |
| <span class="source-line-no">090</span><span id="line-90"></span> |
| <span class="source-line-no">091</span><span id="line-91"> /** Returns The new dataSize ONLY as a convenience */</span> |
| <span class="source-line-no">092</span><span id="line-92"> long incMemStoreSize(long dataSizeDelta, long heapSizeDelta, long offHeapSizeDelta,</span> |
| <span class="source-line-no">093</span><span id="line-93"> int cellsCountDelta);</span> |
| <span class="source-line-no">094</span><span id="line-94"></span> |
| <span class="source-line-no">095</span><span id="line-95"> default long incMemStoreSize(MemStoreSize delta) {</span> |
| <span class="source-line-no">096</span><span id="line-96"> return incMemStoreSize(delta.getDataSize(), delta.getHeapSize(), delta.getOffHeapSize(),</span> |
| <span class="source-line-no">097</span><span id="line-97"> delta.getCellsCount());</span> |
| <span class="source-line-no">098</span><span id="line-98"> }</span> |
| <span class="source-line-no">099</span><span id="line-99"></span> |
| <span class="source-line-no">100</span><span id="line-100"> /** Returns The new dataSize ONLY as a convenience */</span> |
| <span class="source-line-no">101</span><span id="line-101"> default long decMemStoreSize(long dataSizeDelta, long heapSizeDelta, long offHeapSizeDelta,</span> |
| <span class="source-line-no">102</span><span id="line-102"> int cellsCountDelta) {</span> |
| <span class="source-line-no">103</span><span id="line-103"> return incMemStoreSize(-dataSizeDelta, -heapSizeDelta, -offHeapSizeDelta, -cellsCountDelta);</span> |
| <span class="source-line-no">104</span><span id="line-104"> }</span> |
| <span class="source-line-no">105</span><span id="line-105"></span> |
| <span class="source-line-no">106</span><span id="line-106"> default long decMemStoreSize(MemStoreSize delta) {</span> |
| <span class="source-line-no">107</span><span id="line-107"> return incMemStoreSize(-delta.getDataSize(), -delta.getHeapSize(), -delta.getOffHeapSize(),</span> |
| <span class="source-line-no">108</span><span id="line-108"> -delta.getCellsCount());</span> |
| <span class="source-line-no">109</span><span id="line-109"> }</span> |
| <span class="source-line-no">110</span><span id="line-110"></span> |
| <span class="source-line-no">111</span><span id="line-111"> boolean compareAndSetDataSize(long expected, long updated);</span> |
| <span class="source-line-no">112</span><span id="line-112"></span> |
| <span class="source-line-no">113</span><span id="line-113"> long getDataSize();</span> |
| <span class="source-line-no">114</span><span id="line-114"></span> |
| <span class="source-line-no">115</span><span id="line-115"> long getHeapSize();</span> |
| <span class="source-line-no">116</span><span id="line-116"></span> |
| <span class="source-line-no">117</span><span id="line-117"> long getOffHeapSize();</span> |
| <span class="source-line-no">118</span><span id="line-118"></span> |
| <span class="source-line-no">119</span><span id="line-119"> int getCellsCount();</span> |
| <span class="source-line-no">120</span><span id="line-120"></span> |
| <span class="source-line-no">121</span><span id="line-121"> /**</span> |
| <span class="source-line-no">122</span><span id="line-122"> * @return Use this datastructure to return all three settings, {@link #getDataSize()},</span> |
| <span class="source-line-no">123</span><span id="line-123"> * {@link #getHeapSize()}, and {@link #getOffHeapSize()}, in the one go.</span> |
| <span class="source-line-no">124</span><span id="line-124"> */</span> |
| <span class="source-line-no">125</span><span id="line-125"> MemStoreSize getMemStoreSize();</span> |
| <span class="source-line-no">126</span><span id="line-126">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
