blob: d4bdee254c4a5f26a619db49ceea4dd52e11134a [file]
<!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.mob, class: CachedMobFile">
<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.mob;</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.io.IOException;</span>
<span class="source-line-no">021</span><span id="line-21">import java.util.concurrent.atomic.AtomicLong;</span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.fs.FileSystem;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.fs.Path;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.io.hfile.CacheConfig;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.regionserver.BloomType;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.regionserver.HStoreFile;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">029</span><span id="line-29"></span>
<span class="source-line-no">030</span><span id="line-30">/**</span>
<span class="source-line-no">031</span><span id="line-31"> * Cached mob file.</span>
<span class="source-line-no">032</span><span id="line-32"> */</span>
<span class="source-line-no">033</span><span id="line-33">@InterfaceAudience.Private</span>
<span class="source-line-no">034</span><span id="line-34">public class CachedMobFile extends MobFile implements Comparable&lt;CachedMobFile&gt; {</span>
<span class="source-line-no">035</span><span id="line-35"></span>
<span class="source-line-no">036</span><span id="line-36"> private long accessCount;</span>
<span class="source-line-no">037</span><span id="line-37"> private AtomicLong referenceCount = new AtomicLong(0);</span>
<span class="source-line-no">038</span><span id="line-38"></span>
<span class="source-line-no">039</span><span id="line-39"> public CachedMobFile(HStoreFile sf) {</span>
<span class="source-line-no">040</span><span id="line-40"> super(sf);</span>
<span class="source-line-no">041</span><span id="line-41"> }</span>
<span class="source-line-no">042</span><span id="line-42"></span>
<span class="source-line-no">043</span><span id="line-43"> public static CachedMobFile create(FileSystem fs, Path path, Configuration conf,</span>
<span class="source-line-no">044</span><span id="line-44"> CacheConfig cacheConf) throws IOException {</span>
<span class="source-line-no">045</span><span id="line-45"> // XXX: primaryReplica is only used for constructing the key of block cache so it is not a</span>
<span class="source-line-no">046</span><span id="line-46"> // critical problem if we pass the wrong value, so here we always pass true. Need to fix later.</span>
<span class="source-line-no">047</span><span id="line-47"> HStoreFile sf = new HStoreFile(fs, path, conf, cacheConf, BloomType.NONE, true);</span>
<span class="source-line-no">048</span><span id="line-48"> return new CachedMobFile(sf);</span>
<span class="source-line-no">049</span><span id="line-49"> }</span>
<span class="source-line-no">050</span><span id="line-50"></span>
<span class="source-line-no">051</span><span id="line-51"> public void access(long accessCount) {</span>
<span class="source-line-no">052</span><span id="line-52"> this.accessCount = accessCount;</span>
<span class="source-line-no">053</span><span id="line-53"> }</span>
<span class="source-line-no">054</span><span id="line-54"></span>
<span class="source-line-no">055</span><span id="line-55"> @Override</span>
<span class="source-line-no">056</span><span id="line-56"> public int compareTo(CachedMobFile that) {</span>
<span class="source-line-no">057</span><span id="line-57"> if (this.accessCount == that.accessCount) return 0;</span>
<span class="source-line-no">058</span><span id="line-58"> return this.accessCount &lt; that.accessCount ? 1 : -1;</span>
<span class="source-line-no">059</span><span id="line-59"> }</span>
<span class="source-line-no">060</span><span id="line-60"></span>
<span class="source-line-no">061</span><span id="line-61"> @Override</span>
<span class="source-line-no">062</span><span id="line-62"> public boolean equals(Object obj) {</span>
<span class="source-line-no">063</span><span id="line-63"> if (this == obj) {</span>
<span class="source-line-no">064</span><span id="line-64"> return true;</span>
<span class="source-line-no">065</span><span id="line-65"> }</span>
<span class="source-line-no">066</span><span id="line-66"> if (obj == null) {</span>
<span class="source-line-no">067</span><span id="line-67"> return false;</span>
<span class="source-line-no">068</span><span id="line-68"> }</span>
<span class="source-line-no">069</span><span id="line-69"> if (!(obj instanceof CachedMobFile)) {</span>
<span class="source-line-no">070</span><span id="line-70"> return false;</span>
<span class="source-line-no">071</span><span id="line-71"> }</span>
<span class="source-line-no">072</span><span id="line-72"> return compareTo((CachedMobFile) obj) == 0;</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 int hashCode() {</span>
<span class="source-line-no">077</span><span id="line-77"> return (int) (accessCount ^ (accessCount &gt;&gt;&gt; 32));</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"> /**</span>
<span class="source-line-no">081</span><span id="line-81"> * Opens the mob file if it's not opened yet and increases the reference. It's not thread-safe.</span>
<span class="source-line-no">082</span><span id="line-82"> * Use MobFileCache.openFile() instead. The reader of the mob file is just opened when it's not</span>
<span class="source-line-no">083</span><span id="line-83"> * opened no matter how many times this open() method is invoked. The reference is a counter that</span>
<span class="source-line-no">084</span><span id="line-84"> * how many times this reader is referenced. When the reference is 0, this reader is closed.</span>
<span class="source-line-no">085</span><span id="line-85"> */</span>
<span class="source-line-no">086</span><span id="line-86"> @Override</span>
<span class="source-line-no">087</span><span id="line-87"> public void open() throws IOException {</span>
<span class="source-line-no">088</span><span id="line-88"> super.open();</span>
<span class="source-line-no">089</span><span id="line-89"> referenceCount.incrementAndGet();</span>
<span class="source-line-no">090</span><span id="line-90"> }</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"> * Decreases the reference of the underlying reader for the mob file. It's not thread-safe. Use</span>
<span class="source-line-no">094</span><span id="line-94"> * MobFileCache.closeFile() instead. This underlying reader isn't closed until the reference is 0.</span>
<span class="source-line-no">095</span><span id="line-95"> */</span>
<span class="source-line-no">096</span><span id="line-96"> @Override</span>
<span class="source-line-no">097</span><span id="line-97"> public void close() throws IOException {</span>
<span class="source-line-no">098</span><span id="line-98"> long refs = referenceCount.decrementAndGet();</span>
<span class="source-line-no">099</span><span id="line-99"> if (refs == 0) {</span>
<span class="source-line-no">100</span><span id="line-100"> super.close();</span>
<span class="source-line-no">101</span><span id="line-101"> }</span>
<span class="source-line-no">102</span><span id="line-102"> }</span>
<span class="source-line-no">103</span><span id="line-103"></span>
<span class="source-line-no">104</span><span id="line-104"> /**</span>
<span class="source-line-no">105</span><span id="line-105"> * Gets the reference of the current mob file. Internal usage, currently it's for testing.</span>
<span class="source-line-no">106</span><span id="line-106"> * @return The reference of the current mob file.</span>
<span class="source-line-no">107</span><span id="line-107"> */</span>
<span class="source-line-no">108</span><span id="line-108"> public long getReferenceCount() {</span>
<span class="source-line-no">109</span><span id="line-109"> return this.referenceCount.longValue();</span>
<span class="source-line-no">110</span><span id="line-110"> }</span>
<span class="source-line-no">111</span><span id="line-111">}</span>
</pre>
</div>
</main>
</body>
</html>