blob: dbd28363eb56f471385045e0b2c8c5a0e5a1f941 [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 java.util.List;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.concurrent.atomic.AtomicInteger;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.Cell;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>/**<a name="line.26"></a>
<span class="sourceLineNo">027</span> * A MemStoreLAB implementation which wraps N MemStoreLABs. Its main duty is in proper managing the<a name="line.27"></a>
<span class="sourceLineNo">028</span> * close of the individual MemStoreLAB. This is treated as an immutable one and so do not allow to<a name="line.28"></a>
<span class="sourceLineNo">029</span> * add any more Cells into it. {@link #copyCellInto(Cell)} throws Exception<a name="line.29"></a>
<span class="sourceLineNo">030</span> */<a name="line.30"></a>
<span class="sourceLineNo">031</span>@InterfaceAudience.Private<a name="line.31"></a>
<span class="sourceLineNo">032</span>public class ImmutableMemStoreLAB implements MemStoreLAB {<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span> private final AtomicInteger openScannerCount = new AtomicInteger();<a name="line.34"></a>
<span class="sourceLineNo">035</span> private volatile boolean closed = false;<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span> private final List&lt;MemStoreLAB&gt; mslabs;<a name="line.37"></a>
<span class="sourceLineNo">038</span><a name="line.38"></a>
<span class="sourceLineNo">039</span> public ImmutableMemStoreLAB(List&lt;MemStoreLAB&gt; mslabs) {<a name="line.39"></a>
<span class="sourceLineNo">040</span> this.mslabs = mslabs;<a name="line.40"></a>
<span class="sourceLineNo">041</span> }<a name="line.41"></a>
<span class="sourceLineNo">042</span><a name="line.42"></a>
<span class="sourceLineNo">043</span> @Override<a name="line.43"></a>
<span class="sourceLineNo">044</span> public Cell copyCellInto(Cell cell) {<a name="line.44"></a>
<span class="sourceLineNo">045</span> throw new IllegalStateException("This is an Immutable MemStoreLAB.");<a name="line.45"></a>
<span class="sourceLineNo">046</span> }<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span> /**<a name="line.48"></a>
<span class="sourceLineNo">049</span> * The process of merging assumes all cells are allocated on mslab.<a name="line.49"></a>
<span class="sourceLineNo">050</span> * There is a rare case in which the first immutable segment,<a name="line.50"></a>
<span class="sourceLineNo">051</span> * participating in a merge, is a CSLM.<a name="line.51"></a>
<span class="sourceLineNo">052</span> * Since the CSLM hasn't been flattened yet, and there is no point in flattening it (since it is<a name="line.52"></a>
<span class="sourceLineNo">053</span> * going to be merged), its big cells (for whom size &gt; maxAlloc) must be copied into mslab.<a name="line.53"></a>
<span class="sourceLineNo">054</span> * This method copies the passed cell into the first mslab in the mslabs list,<a name="line.54"></a>
<span class="sourceLineNo">055</span> * returning either a new cell instance over the copied data,<a name="line.55"></a>
<span class="sourceLineNo">056</span> * or null when this cell cannt be copied.<a name="line.56"></a>
<span class="sourceLineNo">057</span> */<a name="line.57"></a>
<span class="sourceLineNo">058</span> @Override<a name="line.58"></a>
<span class="sourceLineNo">059</span> public Cell forceCopyOfBigCellInto(Cell cell) {<a name="line.59"></a>
<span class="sourceLineNo">060</span> MemStoreLAB mslab = this.mslabs.get(0);<a name="line.60"></a>
<span class="sourceLineNo">061</span> return mslab.forceCopyOfBigCellInto(cell);<a name="line.61"></a>
<span class="sourceLineNo">062</span> }<a name="line.62"></a>
<span class="sourceLineNo">063</span><a name="line.63"></a>
<span class="sourceLineNo">064</span> /* Returning a new pool chunk, without replacing current chunk,<a name="line.64"></a>
<span class="sourceLineNo">065</span> ** meaning MSLABImpl does not make the returned chunk as CurChunk.<a name="line.65"></a>
<span class="sourceLineNo">066</span> ** The space on this chunk will be allocated externally.<a name="line.66"></a>
<span class="sourceLineNo">067</span> ** The interface is only for external callers.<a name="line.67"></a>
<span class="sourceLineNo">068</span> */<a name="line.68"></a>
<span class="sourceLineNo">069</span> @Override<a name="line.69"></a>
<span class="sourceLineNo">070</span> public Chunk getNewExternalChunk(ChunkCreator.ChunkType chunkType) {<a name="line.70"></a>
<span class="sourceLineNo">071</span> MemStoreLAB mslab = this.mslabs.get(0);<a name="line.71"></a>
<span class="sourceLineNo">072</span> return mslab.getNewExternalChunk(chunkType);<a name="line.72"></a>
<span class="sourceLineNo">073</span> }<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span> /* Returning a new chunk, without replacing current chunk,<a name="line.75"></a>
<span class="sourceLineNo">076</span> ** meaning MSLABImpl does not make the returned chunk as CurChunk.<a name="line.76"></a>
<span class="sourceLineNo">077</span> ** The space on this chunk will be allocated externally.<a name="line.77"></a>
<span class="sourceLineNo">078</span> ** The interface is only for external callers.<a name="line.78"></a>
<span class="sourceLineNo">079</span> */<a name="line.79"></a>
<span class="sourceLineNo">080</span> @Override<a name="line.80"></a>
<span class="sourceLineNo">081</span> public Chunk getNewExternalChunk(int size) {<a name="line.81"></a>
<span class="sourceLineNo">082</span> MemStoreLAB mslab = this.mslabs.get(0);<a name="line.82"></a>
<span class="sourceLineNo">083</span> return mslab.getNewExternalChunk(size);<a name="line.83"></a>
<span class="sourceLineNo">084</span> }<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>
<span class="sourceLineNo">086</span> @Override<a name="line.86"></a>
<span class="sourceLineNo">087</span> public void close() {<a name="line.87"></a>
<span class="sourceLineNo">088</span> // 'openScannerCount' here tracks the scanners opened on segments which directly refer to this<a name="line.88"></a>
<span class="sourceLineNo">089</span> // MSLAB. The individual MSLABs this refers also having its own 'openScannerCount'. The usage of<a name="line.89"></a>
<span class="sourceLineNo">090</span> // the variable in close() and decScannerCount() is as as that in HeapMemstoreLAB. Here the<a name="line.90"></a>
<span class="sourceLineNo">091</span> // close just delegates the call to the individual MSLABs. The actual return of the chunks to<a name="line.91"></a>
<span class="sourceLineNo">092</span> // MSLABPool will happen within individual MSLABs only (which is at the leaf level).<a name="line.92"></a>
<span class="sourceLineNo">093</span> // Say an ImmutableMemStoreLAB is created over 2 HeapMemStoreLABs at some point and at that time<a name="line.93"></a>
<span class="sourceLineNo">094</span> // both of them were referred by ongoing scanners. So they have &gt; 0 'openScannerCount'. Now over<a name="line.94"></a>
<span class="sourceLineNo">095</span> // the new Segment some scanners come in and this MSLABs 'openScannerCount' also goes up and<a name="line.95"></a>
<span class="sourceLineNo">096</span> // then come down on finish of scanners. Now a close() call comes to this Immutable MSLAB. As<a name="line.96"></a>
<span class="sourceLineNo">097</span> // it's 'openScannerCount' is zero it will call close() on both of the Heap MSLABs. Say by that<a name="line.97"></a>
<span class="sourceLineNo">098</span> // time the old scanners on one of the MSLAB got over where as on the other, still an old<a name="line.98"></a>
<span class="sourceLineNo">099</span> // scanner is going on. The call close() on that MSLAB will not close it immediately but will<a name="line.99"></a>
<span class="sourceLineNo">100</span> // just mark it for closure as it's 'openScannerCount' still &gt; 0. Later once the old scan is<a name="line.100"></a>
<span class="sourceLineNo">101</span> // over, the decScannerCount() call will do the actual close and return of the chunks.<a name="line.101"></a>
<span class="sourceLineNo">102</span> this.closed = true;<a name="line.102"></a>
<span class="sourceLineNo">103</span> // When there are still on going scanners over this MSLAB, we will defer the close until all<a name="line.103"></a>
<span class="sourceLineNo">104</span> // scanners finish. We will just mark it for closure. See #decScannerCount(). This will be<a name="line.104"></a>
<span class="sourceLineNo">105</span> // called at end of every scan. When it is marked for closure and scanner count reached 0, we<a name="line.105"></a>
<span class="sourceLineNo">106</span> // will do the actual close then.<a name="line.106"></a>
<span class="sourceLineNo">107</span> checkAndCloseMSLABs(openScannerCount.get());<a name="line.107"></a>
<span class="sourceLineNo">108</span> }<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span> private void checkAndCloseMSLABs(int openScanners) {<a name="line.110"></a>
<span class="sourceLineNo">111</span> if (openScanners == 0) {<a name="line.111"></a>
<span class="sourceLineNo">112</span> for (MemStoreLAB mslab : this.mslabs) {<a name="line.112"></a>
<span class="sourceLineNo">113</span> mslab.close();<a name="line.113"></a>
<span class="sourceLineNo">114</span> }<a name="line.114"></a>
<span class="sourceLineNo">115</span> }<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span> @Override<a name="line.118"></a>
<span class="sourceLineNo">119</span> public void incScannerCount() {<a name="line.119"></a>
<span class="sourceLineNo">120</span> this.openScannerCount.incrementAndGet();<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> @Override<a name="line.123"></a>
<span class="sourceLineNo">124</span> public void decScannerCount() {<a name="line.124"></a>
<span class="sourceLineNo">125</span> int count = this.openScannerCount.decrementAndGet();<a name="line.125"></a>
<span class="sourceLineNo">126</span> if (this.closed) {<a name="line.126"></a>
<span class="sourceLineNo">127</span> checkAndCloseMSLABs(count);<a name="line.127"></a>
<span class="sourceLineNo">128</span> }<a name="line.128"></a>
<span class="sourceLineNo">129</span> }<a name="line.129"></a>
<span class="sourceLineNo">130</span><a name="line.130"></a>
<span class="sourceLineNo">131</span> @Override<a name="line.131"></a>
<span class="sourceLineNo">132</span> public boolean isOnHeap() {<a name="line.132"></a>
<span class="sourceLineNo">133</span> return !isOffHeap();<a name="line.133"></a>
<span class="sourceLineNo">134</span> }<a name="line.134"></a>
<span class="sourceLineNo">135</span><a name="line.135"></a>
<span class="sourceLineNo">136</span> @Override<a name="line.136"></a>
<span class="sourceLineNo">137</span> public boolean isOffHeap() {<a name="line.137"></a>
<span class="sourceLineNo">138</span> return ChunkCreator.getInstance().isOffheap();<a name="line.138"></a>
<span class="sourceLineNo">139</span> }<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span><a name="line.141"></a>
<span class="sourceLineNo">142</span>}<a name="line.142"></a>
</pre>
</div>
</body>
</html>