blob: 413067de3d24955be2e097882ece0282c47c557f [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.nio.ByteBuffer;<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.yetus.audience.InterfaceAudience;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.hbase.thirdparty.com.google.common.annotations.VisibleForTesting;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>/**<a name="line.29"></a>
<span class="sourceLineNo">030</span> * A chunk of memory out of which allocations are sliced.<a name="line.30"></a>
<span class="sourceLineNo">031</span> */<a name="line.31"></a>
<span class="sourceLineNo">032</span>@InterfaceAudience.Private<a name="line.32"></a>
<span class="sourceLineNo">033</span>public abstract class Chunk {<a name="line.33"></a>
<span class="sourceLineNo">034</span> /** Actual underlying data */<a name="line.34"></a>
<span class="sourceLineNo">035</span> protected ByteBuffer data;<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span> protected static final int UNINITIALIZED = -1;<a name="line.37"></a>
<span class="sourceLineNo">038</span> protected static final int OOM = -2;<a name="line.38"></a>
<span class="sourceLineNo">039</span> /**<a name="line.39"></a>
<span class="sourceLineNo">040</span> * Offset for the next allocation, or the sentinel value -1 which implies that the chunk is still<a name="line.40"></a>
<span class="sourceLineNo">041</span> * uninitialized.<a name="line.41"></a>
<span class="sourceLineNo">042</span> */<a name="line.42"></a>
<span class="sourceLineNo">043</span> protected AtomicInteger nextFreeOffset = new AtomicInteger(UNINITIALIZED);<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span> /** Total number of allocations satisfied from this buffer */<a name="line.45"></a>
<span class="sourceLineNo">046</span> protected AtomicInteger allocCount = new AtomicInteger();<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span> /** Size of chunk in bytes */<a name="line.48"></a>
<span class="sourceLineNo">049</span> protected final int size;<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> // The unique id associated with the chunk.<a name="line.51"></a>
<span class="sourceLineNo">052</span> private final int id;<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span> // indicates if the chunk is formed by ChunkCreator#MemstorePool<a name="line.54"></a>
<span class="sourceLineNo">055</span> private final boolean fromPool;<a name="line.55"></a>
<span class="sourceLineNo">056</span><a name="line.56"></a>
<span class="sourceLineNo">057</span> /**<a name="line.57"></a>
<span class="sourceLineNo">058</span> * Create an uninitialized chunk. Note that memory is not allocated yet, so<a name="line.58"></a>
<span class="sourceLineNo">059</span> * this is cheap.<a name="line.59"></a>
<span class="sourceLineNo">060</span> * @param size in bytes<a name="line.60"></a>
<span class="sourceLineNo">061</span> * @param id the chunk id<a name="line.61"></a>
<span class="sourceLineNo">062</span> */<a name="line.62"></a>
<span class="sourceLineNo">063</span> public Chunk(int size, int id) {<a name="line.63"></a>
<span class="sourceLineNo">064</span> this(size, id, false);<a name="line.64"></a>
<span class="sourceLineNo">065</span> }<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> * Create an uninitialized chunk. Note that memory is not allocated yet, so<a name="line.68"></a>
<span class="sourceLineNo">069</span> * this is cheap.<a name="line.69"></a>
<span class="sourceLineNo">070</span> * @param size in bytes<a name="line.70"></a>
<span class="sourceLineNo">071</span> * @param id the chunk id<a name="line.71"></a>
<span class="sourceLineNo">072</span> * @param fromPool if the chunk is formed by pool<a name="line.72"></a>
<span class="sourceLineNo">073</span> */<a name="line.73"></a>
<span class="sourceLineNo">074</span> public Chunk(int size, int id, boolean fromPool) {<a name="line.74"></a>
<span class="sourceLineNo">075</span> this.size = size;<a name="line.75"></a>
<span class="sourceLineNo">076</span> this.id = id;<a name="line.76"></a>
<span class="sourceLineNo">077</span> this.fromPool = fromPool;<a name="line.77"></a>
<span class="sourceLineNo">078</span> }<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span> int getId() {<a name="line.80"></a>
<span class="sourceLineNo">081</span> return this.id;<a name="line.81"></a>
<span class="sourceLineNo">082</span> }<a name="line.82"></a>
<span class="sourceLineNo">083</span><a name="line.83"></a>
<span class="sourceLineNo">084</span> boolean isFromPool() {<a name="line.84"></a>
<span class="sourceLineNo">085</span> return this.fromPool;<a name="line.85"></a>
<span class="sourceLineNo">086</span> }<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span> boolean isJumbo() {<a name="line.88"></a>
<span class="sourceLineNo">089</span> return size &gt; ChunkCreator.getInstance().getChunkSize();<a name="line.89"></a>
<span class="sourceLineNo">090</span> }<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span> boolean isIndexChunk() {<a name="line.92"></a>
<span class="sourceLineNo">093</span> return size == ChunkCreator.getInstance().getChunkSize(ChunkCreator.ChunkType.INDEX_CHUNK);<a name="line.93"></a>
<span class="sourceLineNo">094</span> }<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span> /**<a name="line.96"></a>
<span class="sourceLineNo">097</span> * Actually claim the memory for this chunk. This should only be called from the thread that<a name="line.97"></a>
<span class="sourceLineNo">098</span> * constructed the chunk. It is thread-safe against other threads calling alloc(), who will block<a name="line.98"></a>
<span class="sourceLineNo">099</span> * until the allocation is complete.<a name="line.99"></a>
<span class="sourceLineNo">100</span> */<a name="line.100"></a>
<span class="sourceLineNo">101</span> public void init() {<a name="line.101"></a>
<span class="sourceLineNo">102</span> assert nextFreeOffset.get() == UNINITIALIZED;<a name="line.102"></a>
<span class="sourceLineNo">103</span> try {<a name="line.103"></a>
<span class="sourceLineNo">104</span> allocateDataBuffer();<a name="line.104"></a>
<span class="sourceLineNo">105</span> } catch (OutOfMemoryError e) {<a name="line.105"></a>
<span class="sourceLineNo">106</span> boolean failInit = nextFreeOffset.compareAndSet(UNINITIALIZED, OOM);<a name="line.106"></a>
<span class="sourceLineNo">107</span> assert failInit; // should be true.<a name="line.107"></a>
<span class="sourceLineNo">108</span> throw e;<a name="line.108"></a>
<span class="sourceLineNo">109</span> }<a name="line.109"></a>
<span class="sourceLineNo">110</span> // Mark that it's ready for use<a name="line.110"></a>
<span class="sourceLineNo">111</span> // Move 4 bytes since the first 4 bytes are having the chunkid in it<a name="line.111"></a>
<span class="sourceLineNo">112</span> boolean initted = nextFreeOffset.compareAndSet(UNINITIALIZED, Bytes.SIZEOF_INT);<a name="line.112"></a>
<span class="sourceLineNo">113</span> // We should always succeed the above CAS since only one thread<a name="line.113"></a>
<span class="sourceLineNo">114</span> // calls init()!<a name="line.114"></a>
<span class="sourceLineNo">115</span> Preconditions.checkState(initted, "Multiple threads tried to init same chunk");<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> abstract void allocateDataBuffer();<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span> /**<a name="line.120"></a>
<span class="sourceLineNo">121</span> * Reset the offset to UNINITIALIZED before before reusing an old chunk<a name="line.121"></a>
<span class="sourceLineNo">122</span> */<a name="line.122"></a>
<span class="sourceLineNo">123</span> void reset() {<a name="line.123"></a>
<span class="sourceLineNo">124</span> if (nextFreeOffset.get() != UNINITIALIZED) {<a name="line.124"></a>
<span class="sourceLineNo">125</span> nextFreeOffset.set(UNINITIALIZED);<a name="line.125"></a>
<span class="sourceLineNo">126</span> allocCount.set(0);<a name="line.126"></a>
<span class="sourceLineNo">127</span> }<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> * Try to allocate &lt;code&gt;size&lt;/code&gt; bytes from the chunk.<a name="line.131"></a>
<span class="sourceLineNo">132</span> * If a chunk is tried to get allocated before init() call, the thread doing the allocation<a name="line.132"></a>
<span class="sourceLineNo">133</span> * will be in busy-wait state as it will keep looping till the nextFreeOffset is set.<a name="line.133"></a>
<span class="sourceLineNo">134</span> * @return the offset of the successful allocation, or -1 to indicate not-enough-space<a name="line.134"></a>
<span class="sourceLineNo">135</span> */<a name="line.135"></a>
<span class="sourceLineNo">136</span> public int alloc(int size) {<a name="line.136"></a>
<span class="sourceLineNo">137</span> while (true) {<a name="line.137"></a>
<span class="sourceLineNo">138</span> int oldOffset = nextFreeOffset.get();<a name="line.138"></a>
<span class="sourceLineNo">139</span> if (oldOffset == UNINITIALIZED) {<a name="line.139"></a>
<span class="sourceLineNo">140</span> // The chunk doesn't have its data allocated yet.<a name="line.140"></a>
<span class="sourceLineNo">141</span> // Since we found this in curChunk, we know that whoever<a name="line.141"></a>
<span class="sourceLineNo">142</span> // CAS-ed it there is allocating it right now. So spin-loop<a name="line.142"></a>
<span class="sourceLineNo">143</span> // shouldn't spin long!<a name="line.143"></a>
<span class="sourceLineNo">144</span> Thread.yield();<a name="line.144"></a>
<span class="sourceLineNo">145</span> continue;<a name="line.145"></a>
<span class="sourceLineNo">146</span> }<a name="line.146"></a>
<span class="sourceLineNo">147</span> if (oldOffset == OOM) {<a name="line.147"></a>
<span class="sourceLineNo">148</span> // doh we ran out of ram. return -1 to chuck this away.<a name="line.148"></a>
<span class="sourceLineNo">149</span> return -1;<a name="line.149"></a>
<span class="sourceLineNo">150</span> }<a name="line.150"></a>
<span class="sourceLineNo">151</span><a name="line.151"></a>
<span class="sourceLineNo">152</span> if (oldOffset + size &gt; data.capacity()) {<a name="line.152"></a>
<span class="sourceLineNo">153</span> return -1; // alloc doesn't fit<a name="line.153"></a>
<span class="sourceLineNo">154</span> }<a name="line.154"></a>
<span class="sourceLineNo">155</span> // TODO : If seqID is to be written add 8 bytes here for nextFreeOFfset<a name="line.155"></a>
<span class="sourceLineNo">156</span> // Try to atomically claim this chunk<a name="line.156"></a>
<span class="sourceLineNo">157</span> if (nextFreeOffset.compareAndSet(oldOffset, oldOffset + size)) {<a name="line.157"></a>
<span class="sourceLineNo">158</span> // we got the alloc<a name="line.158"></a>
<span class="sourceLineNo">159</span> allocCount.incrementAndGet();<a name="line.159"></a>
<span class="sourceLineNo">160</span> return oldOffset;<a name="line.160"></a>
<span class="sourceLineNo">161</span> }<a name="line.161"></a>
<span class="sourceLineNo">162</span> // we raced and lost alloc, try again<a name="line.162"></a>
<span class="sourceLineNo">163</span> }<a name="line.163"></a>
<span class="sourceLineNo">164</span> }<a name="line.164"></a>
<span class="sourceLineNo">165</span><a name="line.165"></a>
<span class="sourceLineNo">166</span> /**<a name="line.166"></a>
<span class="sourceLineNo">167</span> * @return This chunk's backing data.<a name="line.167"></a>
<span class="sourceLineNo">168</span> */<a name="line.168"></a>
<span class="sourceLineNo">169</span> ByteBuffer getData() {<a name="line.169"></a>
<span class="sourceLineNo">170</span> return this.data;<a name="line.170"></a>
<span class="sourceLineNo">171</span> }<a name="line.171"></a>
<span class="sourceLineNo">172</span><a name="line.172"></a>
<span class="sourceLineNo">173</span> @Override<a name="line.173"></a>
<span class="sourceLineNo">174</span> public String toString() {<a name="line.174"></a>
<span class="sourceLineNo">175</span> return "Chunk@" + System.identityHashCode(this) + " allocs=" + allocCount.get() + "waste="<a name="line.175"></a>
<span class="sourceLineNo">176</span> + (data.capacity() - nextFreeOffset.get());<a name="line.176"></a>
<span class="sourceLineNo">177</span> }<a name="line.177"></a>
<span class="sourceLineNo">178</span><a name="line.178"></a>
<span class="sourceLineNo">179</span> @VisibleForTesting<a name="line.179"></a>
<span class="sourceLineNo">180</span> int getNextFreeOffset() {<a name="line.180"></a>
<span class="sourceLineNo">181</span> return this.nextFreeOffset.get();<a name="line.181"></a>
<span class="sourceLineNo">182</span> }<a name="line.182"></a>
<span class="sourceLineNo">183</span>}<a name="line.183"></a>
</pre>
</div>
</body>
</html>