blob: 069578f8021768eb6820300366dd2a1c00d94d1c [file] [log] [blame]
<!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.util, class: IdReadWriteLockWithObjectPool">
<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.util;</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.lang.ref.Reference;</span>
<span class="source-line-no">021</span><span id="line-21">import java.util.concurrent.locks.ReentrantReadWriteLock;</span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">023</span><span id="line-23"></span>
<span class="source-line-no">024</span><span id="line-24">@InterfaceAudience.Private</span>
<span class="source-line-no">025</span><span id="line-25">public class IdReadWriteLockWithObjectPool&lt;T&gt; extends IdReadWriteLock&lt;T&gt; {</span>
<span class="source-line-no">026</span><span id="line-26"> // The number of lock we want to easily support. It's not a maximum.</span>
<span class="source-line-no">027</span><span id="line-27"> private static final int NB_CONCURRENT_LOCKS = 1000;</span>
<span class="source-line-no">028</span><span id="line-28"> /**</span>
<span class="source-line-no">029</span><span id="line-29"> * The pool to get entry from, entries are mapped by {@link Reference} and will be automatically</span>
<span class="source-line-no">030</span><span id="line-30"> * garbage-collected by JVM</span>
<span class="source-line-no">031</span><span id="line-31"> */</span>
<span class="source-line-no">032</span><span id="line-32"> private final ObjectPool&lt;T, ReentrantReadWriteLock&gt; lockPool;</span>
<span class="source-line-no">033</span><span id="line-33"> private final ReferenceType refType;</span>
<span class="source-line-no">034</span><span id="line-34"></span>
<span class="source-line-no">035</span><span id="line-35"> public IdReadWriteLockWithObjectPool() {</span>
<span class="source-line-no">036</span><span id="line-36"> this(ReferenceType.WEAK);</span>
<span class="source-line-no">037</span><span id="line-37"> }</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"> * Constructor of IdReadWriteLockWithObjectPool</span>
<span class="source-line-no">041</span><span id="line-41"> * @param referenceType type of the reference used in lock pool, {@link ReferenceType#WEAK} by</span>
<span class="source-line-no">042</span><span id="line-42"> * default. Use {@link ReferenceType#SOFT} if the key set is limited and the</span>
<span class="source-line-no">043</span><span id="line-43"> * locks will be reused with a high frequency</span>
<span class="source-line-no">044</span><span id="line-44"> */</span>
<span class="source-line-no">045</span><span id="line-45"> public IdReadWriteLockWithObjectPool(ReferenceType referenceType) {</span>
<span class="source-line-no">046</span><span id="line-46"> this.refType = referenceType;</span>
<span class="source-line-no">047</span><span id="line-47"> switch (referenceType) {</span>
<span class="source-line-no">048</span><span id="line-48"> case SOFT:</span>
<span class="source-line-no">049</span><span id="line-49"> lockPool = new SoftObjectPool&lt;&gt;(new ObjectPool.ObjectFactory&lt;T, ReentrantReadWriteLock&gt;() {</span>
<span class="source-line-no">050</span><span id="line-50"> @Override</span>
<span class="source-line-no">051</span><span id="line-51"> public ReentrantReadWriteLock createObject(T id) {</span>
<span class="source-line-no">052</span><span id="line-52"> return new ReentrantReadWriteLock();</span>
<span class="source-line-no">053</span><span id="line-53"> }</span>
<span class="source-line-no">054</span><span id="line-54"> }, NB_CONCURRENT_LOCKS);</span>
<span class="source-line-no">055</span><span id="line-55"> break;</span>
<span class="source-line-no">056</span><span id="line-56"> case WEAK:</span>
<span class="source-line-no">057</span><span id="line-57"> default:</span>
<span class="source-line-no">058</span><span id="line-58"> lockPool = new WeakObjectPool&lt;&gt;(new ObjectPool.ObjectFactory&lt;T, ReentrantReadWriteLock&gt;() {</span>
<span class="source-line-no">059</span><span id="line-59"> @Override</span>
<span class="source-line-no">060</span><span id="line-60"> public ReentrantReadWriteLock createObject(T id) {</span>
<span class="source-line-no">061</span><span id="line-61"> return new ReentrantReadWriteLock();</span>
<span class="source-line-no">062</span><span id="line-62"> }</span>
<span class="source-line-no">063</span><span id="line-63"> }, NB_CONCURRENT_LOCKS);</span>
<span class="source-line-no">064</span><span id="line-64"> }</span>
<span class="source-line-no">065</span><span id="line-65"> }</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 enum ReferenceType {</span>
<span class="source-line-no">068</span><span id="line-68"> WEAK,</span>
<span class="source-line-no">069</span><span id="line-69"> SOFT</span>
<span class="source-line-no">070</span><span id="line-70"> }</span>
<span class="source-line-no">071</span><span id="line-71"></span>
<span class="source-line-no">072</span><span id="line-72"> /**</span>
<span class="source-line-no">073</span><span id="line-73"> * Get the ReentrantReadWriteLock corresponding to the given id</span>
<span class="source-line-no">074</span><span id="line-74"> * @param id an arbitrary number to identify the lock</span>
<span class="source-line-no">075</span><span id="line-75"> */</span>
<span class="source-line-no">076</span><span id="line-76"> @Override</span>
<span class="source-line-no">077</span><span id="line-77"> public ReentrantReadWriteLock getLock(T id) {</span>
<span class="source-line-no">078</span><span id="line-78"> lockPool.purge();</span>
<span class="source-line-no">079</span><span id="line-79"> ReentrantReadWriteLock readWriteLock = lockPool.get(id);</span>
<span class="source-line-no">080</span><span id="line-80"> return readWriteLock;</span>
<span class="source-line-no">081</span><span id="line-81"> }</span>
<span class="source-line-no">082</span><span id="line-82"></span>
<span class="source-line-no">083</span><span id="line-83"> /** For testing */</span>
<span class="source-line-no">084</span><span id="line-84"> int purgeAndGetEntryPoolSize() {</span>
<span class="source-line-no">085</span><span id="line-85"> gc();</span>
<span class="source-line-no">086</span><span id="line-86"> Threads.sleep(200);</span>
<span class="source-line-no">087</span><span id="line-87"> lockPool.purge();</span>
<span class="source-line-no">088</span><span id="line-88"> return lockPool.size();</span>
<span class="source-line-no">089</span><span id="line-89"> }</span>
<span class="source-line-no">090</span><span id="line-90"></span>
<span class="source-line-no">091</span><span id="line-91"> @edu.umd.cs.findbugs.annotations.SuppressWarnings(value = "DM_GC", justification = "Intentional")</span>
<span class="source-line-no">092</span><span id="line-92"> private void gc() {</span>
<span class="source-line-no">093</span><span id="line-93"> System.gc();</span>
<span class="source-line-no">094</span><span id="line-94"> }</span>
<span class="source-line-no">095</span><span id="line-95"></span>
<span class="source-line-no">096</span><span id="line-96"> public ReferenceType getReferenceType() {</span>
<span class="source-line-no">097</span><span id="line-97"> return this.refType;</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>
</pre>
</div>
</main>
</body>
</html>