| <!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.nio, class: RefCnt"> |
| <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.nio;</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 com.google.errorprone.annotations.RestrictedApi;</span> |
| <span class="source-line-no">021</span><span id="line-21">import org.apache.hadoop.hbase.io.ByteBuffAllocator;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.hbase.io.ByteBuffAllocator.Recycler;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">024</span><span id="line-24"></span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hbase.thirdparty.io.netty.util.AbstractReferenceCounted;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hbase.thirdparty.io.netty.util.ReferenceCounted;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hbase.thirdparty.io.netty.util.ResourceLeakDetector;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hbase.thirdparty.io.netty.util.ResourceLeakDetectorFactory;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hbase.thirdparty.io.netty.util.ResourceLeakTracker;</span> |
| <span class="source-line-no">030</span><span id="line-30"></span> |
| <span class="source-line-no">031</span><span id="line-31">/**</span> |
| <span class="source-line-no">032</span><span id="line-32"> * Maintain an reference count integer inside to track life cycle of {@link ByteBuff}, if the</span> |
| <span class="source-line-no">033</span><span id="line-33"> * reference count become 0, it'll call {@link Recycler#free()} exactly once.</span> |
| <span class="source-line-no">034</span><span id="line-34"> */</span> |
| <span class="source-line-no">035</span><span id="line-35">@InterfaceAudience.Private</span> |
| <span class="source-line-no">036</span><span id="line-36">public class RefCnt extends AbstractReferenceCounted {</span> |
| <span class="source-line-no">037</span><span id="line-37"></span> |
| <span class="source-line-no">038</span><span id="line-38"> private static final ResourceLeakDetector<RefCnt> detector =</span> |
| <span class="source-line-no">039</span><span id="line-39"> ResourceLeakDetectorFactory.instance().newResourceLeakDetector(RefCnt.class);</span> |
| <span class="source-line-no">040</span><span id="line-40"> private final Recycler recycler;</span> |
| <span class="source-line-no">041</span><span id="line-41"> private final ResourceLeakTracker<RefCnt> leak;</span> |
| <span class="source-line-no">042</span><span id="line-42"></span> |
| <span class="source-line-no">043</span><span id="line-43"> /**</span> |
| <span class="source-line-no">044</span><span id="line-44"> * Create an {@link RefCnt} with an initial reference count = 1. If the reference count become</span> |
| <span class="source-line-no">045</span><span id="line-45"> * zero, the recycler will do nothing. Usually, an Heap {@link ByteBuff} will use this kind of</span> |
| <span class="source-line-no">046</span><span id="line-46"> * refCnt to track its life cycle, it help to abstract the code path although it's not really</span> |
| <span class="source-line-no">047</span><span id="line-47"> * needed to track on heap ByteBuff.</span> |
| <span class="source-line-no">048</span><span id="line-48"> */</span> |
| <span class="source-line-no">049</span><span id="line-49"> public static RefCnt create() {</span> |
| <span class="source-line-no">050</span><span id="line-50"> return new RefCnt(ByteBuffAllocator.NONE);</span> |
| <span class="source-line-no">051</span><span id="line-51"> }</span> |
| <span class="source-line-no">052</span><span id="line-52"></span> |
| <span class="source-line-no">053</span><span id="line-53"> public static RefCnt create(Recycler recycler) {</span> |
| <span class="source-line-no">054</span><span id="line-54"> return new RefCnt(recycler);</span> |
| <span class="source-line-no">055</span><span id="line-55"> }</span> |
| <span class="source-line-no">056</span><span id="line-56"></span> |
| <span class="source-line-no">057</span><span id="line-57"> public RefCnt(Recycler recycler) {</span> |
| <span class="source-line-no">058</span><span id="line-58"> this.recycler = recycler;</span> |
| <span class="source-line-no">059</span><span id="line-59"> this.leak = recycler == ByteBuffAllocator.NONE ? null : detector.track(this);</span> |
| <span class="source-line-no">060</span><span id="line-60"> }</span> |
| <span class="source-line-no">061</span><span id="line-61"></span> |
| <span class="source-line-no">062</span><span id="line-62"> /**</span> |
| <span class="source-line-no">063</span><span id="line-63"> * Returns true if this refCnt has a recycler.</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 boolean hasRecycler() {</span> |
| <span class="source-line-no">066</span><span id="line-66"> return recycler != ByteBuffAllocator.NONE;</span> |
| <span class="source-line-no">067</span><span id="line-67"> }</span> |
| <span class="source-line-no">068</span><span id="line-68"></span> |
| <span class="source-line-no">069</span><span id="line-69"> @Override</span> |
| <span class="source-line-no">070</span><span id="line-70"> public ReferenceCounted retain() {</span> |
| <span class="source-line-no">071</span><span id="line-71"> maybeRecord();</span> |
| <span class="source-line-no">072</span><span id="line-72"> return super.retain();</span> |
| <span class="source-line-no">073</span><span id="line-73"> }</span> |
| <span class="source-line-no">074</span><span id="line-74"></span> |
| <span class="source-line-no">075</span><span id="line-75"> @Override</span> |
| <span class="source-line-no">076</span><span id="line-76"> public ReferenceCounted retain(int increment) {</span> |
| <span class="source-line-no">077</span><span id="line-77"> maybeRecord();</span> |
| <span class="source-line-no">078</span><span id="line-78"> return super.retain(increment);</span> |
| <span class="source-line-no">079</span><span id="line-79"> }</span> |
| <span class="source-line-no">080</span><span id="line-80"></span> |
| <span class="source-line-no">081</span><span id="line-81"> @Override</span> |
| <span class="source-line-no">082</span><span id="line-82"> public boolean release() {</span> |
| <span class="source-line-no">083</span><span id="line-83"> maybeRecord();</span> |
| <span class="source-line-no">084</span><span id="line-84"> return super.release();</span> |
| <span class="source-line-no">085</span><span id="line-85"> }</span> |
| <span class="source-line-no">086</span><span id="line-86"></span> |
| <span class="source-line-no">087</span><span id="line-87"> @Override</span> |
| <span class="source-line-no">088</span><span id="line-88"> public boolean release(int decrement) {</span> |
| <span class="source-line-no">089</span><span id="line-89"> maybeRecord();</span> |
| <span class="source-line-no">090</span><span id="line-90"> return super.release(decrement);</span> |
| <span class="source-line-no">091</span><span id="line-91"> }</span> |
| <span class="source-line-no">092</span><span id="line-92"></span> |
| <span class="source-line-no">093</span><span id="line-93"> @Override</span> |
| <span class="source-line-no">094</span><span id="line-94"> protected final void deallocate() {</span> |
| <span class="source-line-no">095</span><span id="line-95"> this.recycler.free();</span> |
| <span class="source-line-no">096</span><span id="line-96"> if (leak != null) {</span> |
| <span class="source-line-no">097</span><span id="line-97"> this.leak.close(this);</span> |
| <span class="source-line-no">098</span><span id="line-98"> }</span> |
| <span class="source-line-no">099</span><span id="line-99"> }</span> |
| <span class="source-line-no">100</span><span id="line-100"></span> |
| <span class="source-line-no">101</span><span id="line-101"> @Override</span> |
| <span class="source-line-no">102</span><span id="line-102"> public RefCnt touch() {</span> |
| <span class="source-line-no">103</span><span id="line-103"> maybeRecord();</span> |
| <span class="source-line-no">104</span><span id="line-104"> return this;</span> |
| <span class="source-line-no">105</span><span id="line-105"> }</span> |
| <span class="source-line-no">106</span><span id="line-106"></span> |
| <span class="source-line-no">107</span><span id="line-107"> @Override</span> |
| <span class="source-line-no">108</span><span id="line-108"> public final ReferenceCounted touch(Object hint) {</span> |
| <span class="source-line-no">109</span><span id="line-109"> maybeRecord(hint);</span> |
| <span class="source-line-no">110</span><span id="line-110"> return this;</span> |
| <span class="source-line-no">111</span><span id="line-111"> }</span> |
| <span class="source-line-no">112</span><span id="line-112"></span> |
| <span class="source-line-no">113</span><span id="line-113"> @RestrictedApi(explanation = "Should only be called in tests", link = "",</span> |
| <span class="source-line-no">114</span><span id="line-114"> allowedOnPath = ".*/src/test/.*")</span> |
| <span class="source-line-no">115</span><span id="line-115"> public Recycler getRecycler() {</span> |
| <span class="source-line-no">116</span><span id="line-116"> return recycler;</span> |
| <span class="source-line-no">117</span><span id="line-117"> }</span> |
| <span class="source-line-no">118</span><span id="line-118"></span> |
| <span class="source-line-no">119</span><span id="line-119"> private void maybeRecord() {</span> |
| <span class="source-line-no">120</span><span id="line-120"> maybeRecord(null);</span> |
| <span class="source-line-no">121</span><span id="line-121"> }</span> |
| <span class="source-line-no">122</span><span id="line-122"></span> |
| <span class="source-line-no">123</span><span id="line-123"> private void maybeRecord(Object hint) {</span> |
| <span class="source-line-no">124</span><span id="line-124"> if (leak != null) {</span> |
| <span class="source-line-no">125</span><span id="line-125"> leak.record(hint);</span> |
| <span class="source-line-no">126</span><span id="line-126"> }</span> |
| <span class="source-line-no">127</span><span id="line-127"> }</span> |
| <span class="source-line-no">128</span><span id="line-128">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
