| <!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.io;<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.ArrayList;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.List;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.Queue;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.concurrent.ConcurrentLinkedQueue;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.util.concurrent.atomic.AtomicInteger;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.concurrent.atomic.LongAdder;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.hadoop.conf.Configuration;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.HConstants;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.nio.ByteBuff;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.nio.SingleByteBuff;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.util.ReflectionUtils;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.util.UnsafeAccess;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.slf4j.Logger;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.slf4j.LoggerFactory;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span><a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.hbase.thirdparty.com.google.common.collect.Sets;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span><a name="line.38"></a> |
| <span class="sourceLineNo">039</span>/**<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * ByteBuffAllocator is a nio ByteBuffer pool. It returns {@link ByteBuff}s which are wrappers of<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * offheap {@link ByteBuffer} usually. If we are sure that the returned ByteBuffs have reached the<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * end of their life cycle, we must call {@link ByteBuff#release()} to return buffers to the pool<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * otherwise the pool will leak. If the desired memory size is larger than what the ByteBufferPool<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * has available, we'll downgrade to allocate ByteBuffers from the heap. Increase the ByteBufferPool<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * size if detect this case.<br/><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * <br/><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * For better memory/pool utilization, there is a lower bound named<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * <code>minSizeForReservoirUse</code> in this allocator, and if the desired size is less than<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * <code>minSizeForReservoirUse</code>, the allocator will just allocate the ByteBuffer from heap<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * and let the JVM manage memory, because it better to not waste pool slots allocating a single<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * fixed-size ByteBuffer for a small object.<br/><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * <br/><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * This pool can be used anywhere it makes sense managing memory. Currently used at least by RPC.<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> */<a name="line.54"></a> |
| <span class="sourceLineNo">055</span>@InterfaceAudience.Private<a name="line.55"></a> |
| <span class="sourceLineNo">056</span>public class ByteBuffAllocator {<a name="line.56"></a> |
| <span class="sourceLineNo">057</span><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> private static final Logger LOG = LoggerFactory.getLogger(ByteBuffAllocator.class);<a name="line.58"></a> |
| <span class="sourceLineNo">059</span><a name="line.59"></a> |
| <span class="sourceLineNo">060</span> // The on-heap allocator is mostly used for testing but also has some non-test usage such as<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> // for scanning snapshot. This implementation will just allocate ByteBuffers from heap but<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> // wrapped by ByteBuff.<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> public static final ByteBuffAllocator HEAP = ByteBuffAllocator.createOnHeap();<a name="line.63"></a> |
| <span class="sourceLineNo">064</span><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> public static final String ALLOCATOR_POOL_ENABLED_KEY = "hbase.server.allocator.pool.enabled";<a name="line.65"></a> |
| <span class="sourceLineNo">066</span><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> public static final String MAX_BUFFER_COUNT_KEY = "hbase.server.allocator.max.buffer.count";<a name="line.67"></a> |
| <span class="sourceLineNo">068</span><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> public static final String BUFFER_SIZE_KEY = "hbase.server.allocator.buffer.size";<a name="line.69"></a> |
| <span class="sourceLineNo">070</span><a name="line.70"></a> |
| <span class="sourceLineNo">071</span> public static final String MIN_ALLOCATE_SIZE_KEY = "hbase.server.allocator.minimal.allocate.size";<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> * Set an alternate bytebuffallocator by setting this config, e.g. we can config<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * {@link DeallocateRewriteByteBuffAllocator} to find out prematurely release issues<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> */<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> public static final String BYTEBUFF_ALLOCATOR_CLASS = "hbase.bytebuff.allocator.class";<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> * @deprecated since 2.3.0 and will be removed in 4.0.0. Use<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * {@link ByteBuffAllocator#ALLOCATOR_POOL_ENABLED_KEY} instead.<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> */<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> @Deprecated<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> public static final String DEPRECATED_ALLOCATOR_POOL_ENABLED_KEY =<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> "hbase.ipc.server.reservoir.enabled";<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> * @deprecated since 2.3.0 and will be removed in 4.0.0. Use<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * {@link ByteBuffAllocator#MAX_BUFFER_COUNT_KEY} instead.<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> */<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> @Deprecated<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> static final String DEPRECATED_MAX_BUFFER_COUNT_KEY = "hbase.ipc.server.reservoir.initial.max";<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> * @deprecated since 2.3.0 and will be removed in 4.0.0. Use<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * {@link ByteBuffAllocator#BUFFER_SIZE_KEY} instead.<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> */<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> @Deprecated<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> static final String DEPRECATED_BUFFER_SIZE_KEY = "hbase.ipc.server.reservoir.initial.buffer.size";<a name="line.99"></a> |
| <span class="sourceLineNo">100</span><a name="line.100"></a> |
| <span class="sourceLineNo">101</span> /**<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * There're some reasons why better to choose 65KB(rather than 64KB) as the default buffer size:<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * <p><a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * 1. Almost all of the data blocks have the block size: 64KB + delta, whose delta is very small,<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * depends on the size of lastKeyValue. If we set buffer.size=64KB, then each block will be<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * allocated as a MultiByteBuff: one 64KB DirectByteBuffer and delta bytes HeapByteBuffer, the<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * HeapByteBuffer will increase the GC pressure. Ideally, we should let the data block to be<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * allocated as a SingleByteBuff, it has simpler data structure, faster access speed, less heap<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * usage.<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * <p><a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * 2. Since the blocks are MultiByteBuff when using buffer.size=64KB, so we have to calculate the<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * checksum by an temp heap copying (see HBASE-21917), while if it's a SingleByteBuff, we can<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * speed the checksum by calling the hadoop' checksum in native lib, which is more faster.<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * <p><a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * For performance comparison, please see HBASE-22483.<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> */<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> public static final int DEFAULT_BUFFER_SIZE = 65 * 1024;<a name="line.117"></a> |
| <span class="sourceLineNo">118</span><a name="line.118"></a> |
| <span class="sourceLineNo">119</span> public static final Recycler NONE = () -> {<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> };<a name="line.120"></a> |
| <span class="sourceLineNo">121</span><a name="line.121"></a> |
| <span class="sourceLineNo">122</span> public interface Recycler {<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> void free();<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> }<a name="line.124"></a> |
| <span class="sourceLineNo">125</span><a name="line.125"></a> |
| <span class="sourceLineNo">126</span> protected final boolean reservoirEnabled;<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> protected final int bufSize;<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> private final int maxBufCount;<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> private final AtomicInteger usedBufCount = new AtomicInteger(0);<a name="line.129"></a> |
| <span class="sourceLineNo">130</span><a name="line.130"></a> |
| <span class="sourceLineNo">131</span> private boolean maxPoolSizeInfoLevelLogged = false;<a name="line.131"></a> |
| <span class="sourceLineNo">132</span><a name="line.132"></a> |
| <span class="sourceLineNo">133</span> // If the desired size is at least this size, it'll allocated from ByteBufferPool, otherwise it'll<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> // allocated from heap for better utilization. We make this to be 1/6th of the pool buffer size.<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> private final int minSizeForReservoirUse;<a name="line.135"></a> |
| <span class="sourceLineNo">136</span><a name="line.136"></a> |
| <span class="sourceLineNo">137</span> private final Queue<ByteBuffer> buffers = new ConcurrentLinkedQueue<>();<a name="line.137"></a> |
| <span class="sourceLineNo">138</span><a name="line.138"></a> |
| <span class="sourceLineNo">139</span> // Metrics to track the pool allocation bytes and heap allocation bytes. If heap allocation<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> // bytes is increasing so much, then we may need to increase the max.buffer.count .<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> private final LongAdder poolAllocationBytes = new LongAdder();<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> private final LongAdder heapAllocationBytes = new LongAdder();<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> private long lastPoolAllocationBytes = 0;<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> private long lastHeapAllocationBytes = 0;<a name="line.144"></a> |
| <span class="sourceLineNo">145</span><a name="line.145"></a> |
| <span class="sourceLineNo">146</span> /**<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * Initialize an {@link ByteBuffAllocator} which will try to allocate ByteBuffers from off-heap if<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> * reservoir is enabled and the reservoir has enough buffers, otherwise the allocator will just<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> * allocate the insufficient buffers from on-heap to meet the requirement.<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> * @param conf which get the arguments to initialize the allocator.<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> * @param reservoirEnabled indicate whether the reservoir is enabled or disabled. NOTICE: if<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> * reservoir is enabled, then we will use the pool allocator to allocate<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> * off-heap ByteBuffers and use the HEAP allocator to allocate heap<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> * ByteBuffers. Otherwise if reservoir is disabled then all allocations<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * will happen in HEAP instance.<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> * @return ByteBuffAllocator to manage the byte buffers.<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> */<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> public static ByteBuffAllocator create(Configuration conf, boolean reservoirEnabled) {<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> int poolBufSize = conf.getInt(BUFFER_SIZE_KEY, DEFAULT_BUFFER_SIZE);<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> if (reservoirEnabled) {<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> // The max number of buffers to be pooled in the ByteBufferPool. The default value been<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> // selected based on the #handlers configured. When it is read request, 2 MB is the max size<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> // at which we will send back one RPC request. Means max we need 2 MB for creating the<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> // response cell block. (Well it might be much lesser than this because in 2 MB size calc, we<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> // include the heap size overhead of each cells also.) Considering 2 MB, we will need<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> // (2 * 1024 * 1024) / poolBufSize buffers to make the response cell block. Pool buffer size<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> // is by default 64 KB.<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> // In case of read request, at the end of the handler process, we will make the response<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> // cellblock and add the Call to connection's response Q and a single Responder thread takes<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> // connections and responses from that one by one and do the socket write. So there is chances<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> // that by the time a handler originated response is actually done writing to socket and so<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> // released the BBs it used, the handler might have processed one more read req. On an avg 2x<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> // we consider and consider that also for the max buffers to pool<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> if (poolBufSize <= 0) {<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> throw new IllegalArgumentException(BUFFER_SIZE_KEY + " must be positive. Please disable "<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> + "the reservoir rather than setting the size of the buffer to zero or negative.");<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> }<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> int bufsForTwoMB = (2 * 1024 * 1024) / poolBufSize;<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> int maxBuffCount =<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> conf.getInt(MAX_BUFFER_COUNT_KEY, conf.getInt(HConstants.REGION_SERVER_HANDLER_COUNT,<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> HConstants.DEFAULT_REGION_SERVER_HANDLER_COUNT) * bufsForTwoMB * 2);<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> int minSizeForReservoirUse = conf.getInt(MIN_ALLOCATE_SIZE_KEY, poolBufSize / 6);<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> if (minSizeForReservoirUse <= 0) {<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> LOG.warn("The minimal size for reservoir use is less or equal to zero, all allocations "<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> + "will be from the pool. Set a higher " + MIN_ALLOCATE_SIZE_KEY + " to avoid this.");<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> }<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> Class<?> clazz = conf.getClass(BYTEBUFF_ALLOCATOR_CLASS, ByteBuffAllocator.class);<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> return (ByteBuffAllocator) ReflectionUtils.newInstance(clazz, true, maxBuffCount, poolBufSize,<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> minSizeForReservoirUse);<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> } else {<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> return HEAP;<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> }<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> }<a name="line.193"></a> |
| <span class="sourceLineNo">194</span><a name="line.194"></a> |
| <span class="sourceLineNo">195</span> /**<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> * Initialize an {@link ByteBuffAllocator} which only allocate ByteBuffer from on-heap, it's<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> * designed for testing purpose or disabled reservoir case.<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> * @return allocator to allocate on-heap ByteBuffer.<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> */<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> private static ByteBuffAllocator createOnHeap() {<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> return new ByteBuffAllocator(false, 0, DEFAULT_BUFFER_SIZE, Integer.MAX_VALUE);<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> }<a name="line.202"></a> |
| <span class="sourceLineNo">203</span><a name="line.203"></a> |
| <span class="sourceLineNo">204</span> protected ByteBuffAllocator(boolean reservoirEnabled, int maxBufCount, int bufSize,<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> int minSizeForReservoirUse) {<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> this.reservoirEnabled = reservoirEnabled;<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> this.maxBufCount = maxBufCount;<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> this.bufSize = bufSize;<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> this.minSizeForReservoirUse = minSizeForReservoirUse;<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> }<a name="line.210"></a> |
| <span class="sourceLineNo">211</span><a name="line.211"></a> |
| <span class="sourceLineNo">212</span> public boolean isReservoirEnabled() {<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> return reservoirEnabled;<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> }<a name="line.214"></a> |
| <span class="sourceLineNo">215</span><a name="line.215"></a> |
| <span class="sourceLineNo">216</span> public long getHeapAllocationBytes() {<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> return heapAllocationBytes.sum();<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> }<a name="line.218"></a> |
| <span class="sourceLineNo">219</span><a name="line.219"></a> |
| <span class="sourceLineNo">220</span> public long getPoolAllocationBytes() {<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> return poolAllocationBytes.sum();<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> }<a name="line.222"></a> |
| <span class="sourceLineNo">223</span><a name="line.223"></a> |
| <span class="sourceLineNo">224</span> public int getBufferSize() {<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> return this.bufSize;<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> }<a name="line.226"></a> |
| <span class="sourceLineNo">227</span><a name="line.227"></a> |
| <span class="sourceLineNo">228</span> public int getUsedBufferCount() {<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> return this.usedBufCount.intValue();<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> }<a name="line.230"></a> |
| <span class="sourceLineNo">231</span><a name="line.231"></a> |
| <span class="sourceLineNo">232</span> /**<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> * The {@link ConcurrentLinkedQueue#size()} is O(N) complexity and time-consuming, so DO NOT use<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> * the method except in UT.<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> */<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> public int getFreeBufferCount() {<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> return this.buffers.size();<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> }<a name="line.238"></a> |
| <span class="sourceLineNo">239</span><a name="line.239"></a> |
| <span class="sourceLineNo">240</span> public int getTotalBufferCount() {<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> return maxBufCount;<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> }<a name="line.242"></a> |
| <span class="sourceLineNo">243</span><a name="line.243"></a> |
| <span class="sourceLineNo">244</span> public static long getHeapAllocationBytes(ByteBuffAllocator... allocators) {<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> long heapAllocBytes = 0;<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> for (ByteBuffAllocator alloc : Sets.newHashSet(allocators)) {<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> heapAllocBytes += alloc.getHeapAllocationBytes();<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> }<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> return heapAllocBytes;<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> }<a name="line.250"></a> |
| <span class="sourceLineNo">251</span><a name="line.251"></a> |
| <span class="sourceLineNo">252</span> public static double getHeapAllocationRatio(ByteBuffAllocator... allocators) {<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> double heapDelta = 0.0, poolDelta = 0.0;<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> long heapAllocBytes, poolAllocBytes;<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> // If disabled the pool allocator, then we use the global HEAP allocator. otherwise we use<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> // the pool allocator to allocate offheap ByteBuffers and use the HEAP to allocate heap<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> // ByteBuffers. So here we use a HashSet to remove the duplicated allocator object in disable<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> // case.<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> for (ByteBuffAllocator alloc : Sets.newHashSet(allocators)) {<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> heapAllocBytes = alloc.heapAllocationBytes.sum();<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> poolAllocBytes = alloc.poolAllocationBytes.sum();<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> heapDelta += (heapAllocBytes - alloc.lastHeapAllocationBytes);<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> poolDelta += (poolAllocBytes - alloc.lastPoolAllocationBytes);<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> alloc.lastHeapAllocationBytes = heapAllocBytes;<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> alloc.lastPoolAllocationBytes = poolAllocBytes;<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> }<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> // Calculate the heap allocation ratio.<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> if (Math.abs(heapDelta + poolDelta) < 1e-3) {<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> return 0.0;<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> }<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> return heapDelta / (heapDelta + poolDelta);<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> }<a name="line.272"></a> |
| <span class="sourceLineNo">273</span><a name="line.273"></a> |
| <span class="sourceLineNo">274</span> /**<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> * Allocate an buffer with buffer size from ByteBuffAllocator, Note to call the<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> * {@link ByteBuff#release()} if no need any more, otherwise the memory leak happen in NIO<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> * ByteBuffer pool.<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> * @return an ByteBuff with the buffer size.<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> */<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> public SingleByteBuff allocateOneBuffer() {<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> if (isReservoirEnabled()) {<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> ByteBuffer bb = getBuffer();<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> if (bb != null) {<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> return new SingleByteBuff(() -> putbackBuffer(bb), bb);<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> }<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> }<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> // Allocated from heap, let the JVM free its memory.<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> return (SingleByteBuff) ByteBuff.wrap(allocateOnHeap(bufSize));<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> }<a name="line.289"></a> |
| <span class="sourceLineNo">290</span><a name="line.290"></a> |
| <span class="sourceLineNo">291</span> private ByteBuffer allocateOnHeap(int size) {<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> heapAllocationBytes.add(size);<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> return ByteBuffer.allocate(size);<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> }<a name="line.294"></a> |
| <span class="sourceLineNo">295</span><a name="line.295"></a> |
| <span class="sourceLineNo">296</span> /**<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> * Allocate size bytes from the ByteBufAllocator, Note to call the {@link ByteBuff#release()} if<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> * no need any more, otherwise the memory leak happen in NIO ByteBuffer pool.<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> * @param size to allocate<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> * @return an ByteBuff with the desired size.<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> */<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> public ByteBuff allocate(int size) {<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> if (size < 0) {<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> throw new IllegalArgumentException("size to allocate should >=0");<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> }<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> // If disabled the reservoir, just allocate it from on-heap.<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> if (!isReservoirEnabled() || size == 0) {<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> return ByteBuff.wrap(allocateOnHeap(size));<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> }<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> int reminder = size % bufSize;<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> int len = size / bufSize + (reminder > 0 ? 1 : 0);<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> List<ByteBuffer> bbs = new ArrayList<>(len);<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> // Allocate from ByteBufferPool until the remaining is less than minSizeForReservoirUse or<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> // reservoir is exhausted.<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> int remain = size;<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> while (remain >= minSizeForReservoirUse) {<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> ByteBuffer bb = this.getBuffer();<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> if (bb == null) {<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> break;<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> }<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> bbs.add(bb);<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> remain -= bufSize;<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> }<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> int lenFromReservoir = bbs.size();<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> if (remain > 0) {<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> // If the last ByteBuffer is too small or the reservoir can not provide more ByteBuffers, we<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> // just allocate the ByteBuffer from on-heap.<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> bbs.add(allocateOnHeap(remain));<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> }<a name="line.329"></a> |
| <span class="sourceLineNo">330</span><a name="line.330"></a> |
| <span class="sourceLineNo">331</span> ByteBuff bb;<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> // we only need a recycler if we successfully pulled from the pool<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> // this matters for determining whether to add leak detection in RefCnt<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> if (lenFromReservoir == 0) {<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> bb = ByteBuff.wrap(bbs);<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> } else {<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> bb = ByteBuff.wrap(bbs, () -> {<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> for (int i = 0; i < lenFromReservoir; i++) {<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> this.putbackBuffer(bbs.get(i));<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> }<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> });<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> }<a name="line.342"></a> |
| <span class="sourceLineNo">343</span><a name="line.343"></a> |
| <span class="sourceLineNo">344</span> bb.limit(size);<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> return bb;<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> }<a name="line.346"></a> |
| <span class="sourceLineNo">347</span><a name="line.347"></a> |
| <span class="sourceLineNo">348</span> /**<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> * Free all direct buffers if allocated, mainly used for testing.<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> */<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> public void clean() {<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> while (!buffers.isEmpty()) {<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> ByteBuffer b = buffers.poll();<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> if (b.isDirect()) {<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> UnsafeAccess.freeDirectBuffer(b);<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> }<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> }<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> this.usedBufCount.set(0);<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> this.maxPoolSizeInfoLevelLogged = false;<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> this.poolAllocationBytes.reset();<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> this.heapAllocationBytes.reset();<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> this.lastPoolAllocationBytes = 0;<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> this.lastHeapAllocationBytes = 0;<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> }<a name="line.364"></a> |
| <span class="sourceLineNo">365</span><a name="line.365"></a> |
| <span class="sourceLineNo">366</span> /**<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> * @return One free DirectByteBuffer from the pool. If no free ByteBuffer and we have not reached<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> * the maximum pool size, it will create a new one and return. In case of max pool size<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> * also reached, will return null. When pool returned a ByteBuffer, make sure to return it<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> * back to pool after use.<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> */<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> private ByteBuffer getBuffer() {<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> ByteBuffer bb = buffers.poll();<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> if (bb != null) {<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> // To reset the limit to capacity and position to 0, must clear here.<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> bb.clear();<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> poolAllocationBytes.add(bufSize);<a name="line.377"></a> |
| <span class="sourceLineNo">378</span> return bb;<a name="line.378"></a> |
| <span class="sourceLineNo">379</span> }<a name="line.379"></a> |
| <span class="sourceLineNo">380</span> while (true) {<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> int c = this.usedBufCount.intValue();<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> if (c >= this.maxBufCount) {<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> if (!maxPoolSizeInfoLevelLogged) {<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> LOG.info("Pool already reached its max capacity : {} and no free buffers now. Consider "<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> + "increasing the value for '{}' ?", maxBufCount, MAX_BUFFER_COUNT_KEY);<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> maxPoolSizeInfoLevelLogged = true;<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> }<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> return null;<a name="line.388"></a> |
| <span class="sourceLineNo">389</span> }<a name="line.389"></a> |
| <span class="sourceLineNo">390</span> if (!this.usedBufCount.compareAndSet(c, c + 1)) {<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> continue;<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> }<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> poolAllocationBytes.add(bufSize);<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> return ByteBuffer.allocateDirect(bufSize);<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> }<a name="line.395"></a> |
| <span class="sourceLineNo">396</span> }<a name="line.396"></a> |
| <span class="sourceLineNo">397</span><a name="line.397"></a> |
| <span class="sourceLineNo">398</span> /**<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> * Return back a ByteBuffer after its use. Don't read/write the ByteBuffer after the returning.<a name="line.399"></a> |
| <span class="sourceLineNo">400</span> * @param buf ByteBuffer to return.<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> */<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> protected void putbackBuffer(ByteBuffer buf) {<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> if (buf.capacity() != bufSize || (reservoirEnabled ^ buf.isDirect())) {<a name="line.403"></a> |
| <span class="sourceLineNo">404</span> LOG.warn("Trying to put a buffer, not created by this pool! Will be just ignored");<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> return;<a name="line.405"></a> |
| <span class="sourceLineNo">406</span> }<a name="line.406"></a> |
| <span class="sourceLineNo">407</span> buffers.offer(buf);<a name="line.407"></a> |
| <span class="sourceLineNo">408</span> }<a name="line.408"></a> |
| <span class="sourceLineNo">409</span>}<a name="line.409"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
