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