blob: 48d6adda17e0534bd5413f15cf5ad6f8cfadd3be [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a>
<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a>
<span class="sourceLineNo">017</span> */<a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.regionserver;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import org.apache.hadoop.conf.Configuration;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.hadoop.hbase.Cell;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.util.ReflectionUtils;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>/**<a name="line.25"></a>
<span class="sourceLineNo">026</span> * A memstore-local allocation buffer.<a name="line.26"></a>
<span class="sourceLineNo">027</span> * &lt;p&gt;<a name="line.27"></a>
<span class="sourceLineNo">028</span> * The MemStoreLAB is basically a bump-the-pointer allocator that allocates big (2MB) chunks from<a name="line.28"></a>
<span class="sourceLineNo">029</span> * and then doles it out to threads that request slices into the array. These chunks can get pooled<a name="line.29"></a>
<span class="sourceLineNo">030</span> * as well. See {@link ChunkCreator}.<a name="line.30"></a>
<span class="sourceLineNo">031</span> * &lt;p&gt;<a name="line.31"></a>
<span class="sourceLineNo">032</span> * The purpose of this is to combat heap fragmentation in the regionserver. By ensuring that all<a name="line.32"></a>
<span class="sourceLineNo">033</span> * Cells in a given memstore refer only to large chunks of contiguous memory, we ensure that<a name="line.33"></a>
<span class="sourceLineNo">034</span> * large blocks get freed up when the memstore is flushed.<a name="line.34"></a>
<span class="sourceLineNo">035</span> * &lt;p&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> * Without the MSLAB, the byte array allocated during insertion end up interleaved throughout the<a name="line.36"></a>
<span class="sourceLineNo">037</span> * heap, and the old generation gets progressively more fragmented until a stop-the-world compacting<a name="line.37"></a>
<span class="sourceLineNo">038</span> * collection occurs.<a name="line.38"></a>
<span class="sourceLineNo">039</span> * &lt;p&gt;<a name="line.39"></a>
<span class="sourceLineNo">040</span> * This manages the large sized chunks. When Cells are to be added to Memstore, MemStoreLAB's<a name="line.40"></a>
<span class="sourceLineNo">041</span> * {@link #copyCellInto(Cell)} gets called. This allocates enough size in the chunk to hold this<a name="line.41"></a>
<span class="sourceLineNo">042</span> * cell's data and copies into this area and then recreate a Cell over this copied data.<a name="line.42"></a>
<span class="sourceLineNo">043</span> * &lt;p&gt;<a name="line.43"></a>
<span class="sourceLineNo">044</span> * @see ChunkCreator<a name="line.44"></a>
<span class="sourceLineNo">045</span> */<a name="line.45"></a>
<span class="sourceLineNo">046</span>@InterfaceAudience.Private<a name="line.46"></a>
<span class="sourceLineNo">047</span>public interface MemStoreLAB {<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span> String USEMSLAB_KEY = "hbase.hregion.memstore.mslab.enabled";<a name="line.49"></a>
<span class="sourceLineNo">050</span> boolean USEMSLAB_DEFAULT = true;<a name="line.50"></a>
<span class="sourceLineNo">051</span> String MSLAB_CLASS_NAME = "hbase.regionserver.mslab.class";<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span> String CHUNK_SIZE_KEY = "hbase.hregion.memstore.mslab.chunksize";<a name="line.53"></a>
<span class="sourceLineNo">054</span> int CHUNK_SIZE_DEFAULT = 2048 * 1024;<a name="line.54"></a>
<span class="sourceLineNo">055</span> String INDEX_CHUNK_SIZE_PERCENTAGE_KEY = "hbase.hregion.memstore.mslab.indexchunksize.percent";<a name="line.55"></a>
<span class="sourceLineNo">056</span> float INDEX_CHUNK_SIZE_PERCENTAGE_DEFAULT = 0.1f;<a name="line.56"></a>
<span class="sourceLineNo">057</span> String MAX_ALLOC_KEY = "hbase.hregion.memstore.mslab.max.allocation";<a name="line.57"></a>
<span class="sourceLineNo">058</span> int MAX_ALLOC_DEFAULT = 256 * 1024; // allocs bigger than this don't go through<a name="line.58"></a>
<span class="sourceLineNo">059</span> // allocator<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> // MSLAB pool related configs<a name="line.61"></a>
<span class="sourceLineNo">062</span> String CHUNK_POOL_MAXSIZE_KEY = "hbase.hregion.memstore.chunkpool.maxsize";<a name="line.62"></a>
<span class="sourceLineNo">063</span> String CHUNK_POOL_INITIALSIZE_KEY = "hbase.hregion.memstore.chunkpool.initialsize";<a name="line.63"></a>
<span class="sourceLineNo">064</span> float POOL_MAX_SIZE_DEFAULT = 1.0f;<a name="line.64"></a>
<span class="sourceLineNo">065</span> float POOL_INITIAL_SIZE_DEFAULT = 0.0f;<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span> /**<a name="line.67"></a>
<span class="sourceLineNo">068</span> * Allocates slice in this LAB and copy the passed Cell into this area. Returns new Cell instance<a name="line.68"></a>
<span class="sourceLineNo">069</span> * over the copied the data. When this MemStoreLAB can not copy this Cell, it returns null.<a name="line.69"></a>
<span class="sourceLineNo">070</span> */<a name="line.70"></a>
<span class="sourceLineNo">071</span> Cell copyCellInto(Cell cell);<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> /**<a name="line.73"></a>
<span class="sourceLineNo">074</span> * Allocates slice in this LAB and copy the passed Cell into this area. Returns new Cell instance<a name="line.74"></a>
<span class="sourceLineNo">075</span> * over the copied the data. When this MemStoreLAB can not copy this Cell, it returns null.<a name="line.75"></a>
<span class="sourceLineNo">076</span> *<a name="line.76"></a>
<span class="sourceLineNo">077</span> * Since the process of flattening to CellChunkMap assumes all cells are allocated on MSLAB,<a name="line.77"></a>
<span class="sourceLineNo">078</span> * and since copyCellInto does not copy big cells (for whom size &gt; maxAlloc) into MSLAB,<a name="line.78"></a>
<span class="sourceLineNo">079</span> * this method is called while the process of flattening to CellChunkMap is running,<a name="line.79"></a>
<span class="sourceLineNo">080</span> * for forcing the allocation of big cells on this MSLAB.<a name="line.80"></a>
<span class="sourceLineNo">081</span> */<a name="line.81"></a>
<span class="sourceLineNo">082</span> Cell forceCopyOfBigCellInto(Cell cell);<a name="line.82"></a>
<span class="sourceLineNo">083</span><a name="line.83"></a>
<span class="sourceLineNo">084</span> /**<a name="line.84"></a>
<span class="sourceLineNo">085</span> * Close instance since it won't be used any more, try to put the chunks back to pool<a name="line.85"></a>
<span class="sourceLineNo">086</span> */<a name="line.86"></a>
<span class="sourceLineNo">087</span> void close();<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span> /**<a name="line.89"></a>
<span class="sourceLineNo">090</span> * Called when opening a scanner on the data of this MemStoreLAB<a name="line.90"></a>
<span class="sourceLineNo">091</span> */<a name="line.91"></a>
<span class="sourceLineNo">092</span> void incScannerCount();<a name="line.92"></a>
<span class="sourceLineNo">093</span><a name="line.93"></a>
<span class="sourceLineNo">094</span> /**<a name="line.94"></a>
<span class="sourceLineNo">095</span> * Called when closing a scanner on the data of this MemStoreLAB<a name="line.95"></a>
<span class="sourceLineNo">096</span> */<a name="line.96"></a>
<span class="sourceLineNo">097</span> void decScannerCount();<a name="line.97"></a>
<span class="sourceLineNo">098</span><a name="line.98"></a>
<span class="sourceLineNo">099</span> /* Returning a new pool chunk, without replacing current chunk,<a name="line.99"></a>
<span class="sourceLineNo">100</span> ** meaning MSLABImpl does not make the returned chunk as CurChunk.<a name="line.100"></a>
<span class="sourceLineNo">101</span> ** The space on this chunk will be allocated externally.<a name="line.101"></a>
<span class="sourceLineNo">102</span> ** The interface is only for external callers.<a name="line.102"></a>
<span class="sourceLineNo">103</span> */<a name="line.103"></a>
<span class="sourceLineNo">104</span> Chunk getNewExternalChunk(ChunkCreator.ChunkType chunkType);<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span> /* Returning a new chunk, without replacing current chunk,<a name="line.106"></a>
<span class="sourceLineNo">107</span> ** meaning MSLABImpl does not make the returned chunk as CurChunk.<a name="line.107"></a>
<span class="sourceLineNo">108</span> ** The space on this chunk will be allocated externally.<a name="line.108"></a>
<span class="sourceLineNo">109</span> ** The interface is only for external callers.<a name="line.109"></a>
<span class="sourceLineNo">110</span> */<a name="line.110"></a>
<span class="sourceLineNo">111</span> Chunk getNewExternalChunk(int size);<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span> static MemStoreLAB newInstance(Configuration conf) {<a name="line.113"></a>
<span class="sourceLineNo">114</span> MemStoreLAB memStoreLAB = null;<a name="line.114"></a>
<span class="sourceLineNo">115</span> if (isEnabled(conf)) {<a name="line.115"></a>
<span class="sourceLineNo">116</span> String className = conf.get(MSLAB_CLASS_NAME, MemStoreLABImpl.class.getName());<a name="line.116"></a>
<span class="sourceLineNo">117</span> memStoreLAB = ReflectionUtils.instantiateWithCustomCtor(className,<a name="line.117"></a>
<span class="sourceLineNo">118</span> new Class[] { Configuration.class }, new Object[] { conf });<a name="line.118"></a>
<span class="sourceLineNo">119</span> }<a name="line.119"></a>
<span class="sourceLineNo">120</span> return memStoreLAB;<a name="line.120"></a>
<span class="sourceLineNo">121</span> }<a name="line.121"></a>
<span class="sourceLineNo">122</span><a name="line.122"></a>
<span class="sourceLineNo">123</span> static boolean isEnabled(Configuration conf) {<a name="line.123"></a>
<span class="sourceLineNo">124</span> return conf.getBoolean(USEMSLAB_KEY, USEMSLAB_DEFAULT);<a name="line.124"></a>
<span class="sourceLineNo">125</span> }<a name="line.125"></a>
<span class="sourceLineNo">126</span><a name="line.126"></a>
<span class="sourceLineNo">127</span> boolean isOnHeap();<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span> boolean isOffHeap();<a name="line.129"></a>
<span class="sourceLineNo">130</span>}<a name="line.130"></a>
</pre>
</div>
</body>
</html>