| <!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.compress, class: DictionaryCache"> |
| <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.compress;</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.ByteArrayOutputStream;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.io.FileNotFoundException;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.io.IOException;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.io.InputStream;</span> |
| <span class="source-line-no">024</span><span id="line-24">import java.util.concurrent.ExecutionException;</span> |
| <span class="source-line-no">025</span><span id="line-25">import java.util.concurrent.TimeUnit;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.fs.FSDataInputStream;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.fs.FileSystem;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.fs.Path;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.slf4j.Logger;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">033</span><span id="line-33"></span> |
| <span class="source-line-no">034</span><span id="line-34">import org.apache.hbase.thirdparty.com.google.common.cache.CacheBuilder;</span> |
| <span class="source-line-no">035</span><span id="line-35">import org.apache.hbase.thirdparty.com.google.common.cache.CacheLoader;</span> |
| <span class="source-line-no">036</span><span id="line-36">import org.apache.hbase.thirdparty.com.google.common.cache.LoadingCache;</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"> * A utility class for managing compressor/decompressor dictionary loading and caching of load</span> |
| <span class="source-line-no">040</span><span id="line-40"> * results. Useful for any codec that can support changing dictionaries at runtime, such as</span> |
| <span class="source-line-no">041</span><span id="line-41"> * ZStandard.</span> |
| <span class="source-line-no">042</span><span id="line-42"> */</span> |
| <span class="source-line-no">043</span><span id="line-43">@InterfaceAudience.Private</span> |
| <span class="source-line-no">044</span><span id="line-44">public final class DictionaryCache {</span> |
| <span class="source-line-no">045</span><span id="line-45"></span> |
| <span class="source-line-no">046</span><span id="line-46"> public static final String DICTIONARY_MAX_SIZE_KEY = "hbase.io.compress.dictionary.max.size";</span> |
| <span class="source-line-no">047</span><span id="line-47"> public static final int DEFAULT_DICTIONARY_MAX_SIZE = 10 * 1024 * 1024;</span> |
| <span class="source-line-no">048</span><span id="line-48"> public static final String RESOURCE_SCHEME = "resource://";</span> |
| <span class="source-line-no">049</span><span id="line-49"></span> |
| <span class="source-line-no">050</span><span id="line-50"> private static final Logger LOG = LoggerFactory.getLogger(DictionaryCache.class);</span> |
| <span class="source-line-no">051</span><span id="line-51"> private static volatile LoadingCache<String, byte[]> CACHE;</span> |
| <span class="source-line-no">052</span><span id="line-52"></span> |
| <span class="source-line-no">053</span><span id="line-53"> private DictionaryCache() {</span> |
| <span class="source-line-no">054</span><span id="line-54"> }</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"> * Load a dictionary or return a previously cached load.</span> |
| <span class="source-line-no">058</span><span id="line-58"> * @param conf configuration</span> |
| <span class="source-line-no">059</span><span id="line-59"> * @param path the hadoop Path where the dictionary is located, as a String</span> |
| <span class="source-line-no">060</span><span id="line-60"> * @return the dictionary bytes if successful, null otherwise</span> |
| <span class="source-line-no">061</span><span id="line-61"> */</span> |
| <span class="source-line-no">062</span><span id="line-62"> public static byte[] getDictionary(final Configuration conf, final String path)</span> |
| <span class="source-line-no">063</span><span id="line-63"> throws IOException {</span> |
| <span class="source-line-no">064</span><span id="line-64"> if (path == null || path.isEmpty()) {</span> |
| <span class="source-line-no">065</span><span id="line-65"> return null;</span> |
| <span class="source-line-no">066</span><span id="line-66"> }</span> |
| <span class="source-line-no">067</span><span id="line-67"> // Create the dictionary loading cache if we haven't already</span> |
| <span class="source-line-no">068</span><span id="line-68"> if (CACHE == null) {</span> |
| <span class="source-line-no">069</span><span id="line-69"> synchronized (DictionaryCache.class) {</span> |
| <span class="source-line-no">070</span><span id="line-70"> if (CACHE == null) {</span> |
| <span class="source-line-no">071</span><span id="line-71"> final int maxSize = conf.getInt(DICTIONARY_MAX_SIZE_KEY, DEFAULT_DICTIONARY_MAX_SIZE);</span> |
| <span class="source-line-no">072</span><span id="line-72"> CACHE = CacheBuilder.newBuilder().maximumSize(100).expireAfterAccess(10, TimeUnit.MINUTES)</span> |
| <span class="source-line-no">073</span><span id="line-73"> .build(new CacheLoader<String, byte[]>() {</span> |
| <span class="source-line-no">074</span><span id="line-74"> @Override</span> |
| <span class="source-line-no">075</span><span id="line-75"> public byte[] load(String s) throws Exception {</span> |
| <span class="source-line-no">076</span><span id="line-76"> byte[] bytes;</span> |
| <span class="source-line-no">077</span><span id="line-77"> if (path.startsWith(RESOURCE_SCHEME)) {</span> |
| <span class="source-line-no">078</span><span id="line-78"> bytes = loadFromResource(conf, path, maxSize);</span> |
| <span class="source-line-no">079</span><span id="line-79"> } else {</span> |
| <span class="source-line-no">080</span><span id="line-80"> bytes = loadFromHadoopFs(conf, path, maxSize);</span> |
| <span class="source-line-no">081</span><span id="line-81"> }</span> |
| <span class="source-line-no">082</span><span id="line-82"> LOG.info("Loaded dictionary from {} (size {})", s, bytes.length);</span> |
| <span class="source-line-no">083</span><span id="line-83"> return bytes;</span> |
| <span class="source-line-no">084</span><span id="line-84"> }</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"> }</span> |
| <span class="source-line-no">088</span><span id="line-88"> }</span> |
| <span class="source-line-no">089</span><span id="line-89"></span> |
| <span class="source-line-no">090</span><span id="line-90"> // Get or load the dictionary for the given path</span> |
| <span class="source-line-no">091</span><span id="line-91"> try {</span> |
| <span class="source-line-no">092</span><span id="line-92"> return CACHE.get(path);</span> |
| <span class="source-line-no">093</span><span id="line-93"> } catch (ExecutionException e) {</span> |
| <span class="source-line-no">094</span><span id="line-94"> throw new IOException(e);</span> |
| <span class="source-line-no">095</span><span id="line-95"> }</span> |
| <span class="source-line-no">096</span><span id="line-96"> }</span> |
| <span class="source-line-no">097</span><span id="line-97"></span> |
| <span class="source-line-no">098</span><span id="line-98"> // Visible for testing</span> |
| <span class="source-line-no">099</span><span id="line-99"> public static byte[] loadFromResource(final Configuration conf, final String s, final int maxSize)</span> |
| <span class="source-line-no">100</span><span id="line-100"> throws IOException {</span> |
| <span class="source-line-no">101</span><span id="line-101"> if (!s.startsWith(RESOURCE_SCHEME)) {</span> |
| <span class="source-line-no">102</span><span id="line-102"> throw new IOException("Path does not start with " + RESOURCE_SCHEME);</span> |
| <span class="source-line-no">103</span><span id="line-103"> }</span> |
| <span class="source-line-no">104</span><span id="line-104"> final String path = s.substring(RESOURCE_SCHEME.length(), s.length());</span> |
| <span class="source-line-no">105</span><span id="line-105"> LOG.info("Loading resource {}", path);</span> |
| <span class="source-line-no">106</span><span id="line-106"> final InputStream in = DictionaryCache.class.getClassLoader().getResourceAsStream(path);</span> |
| <span class="source-line-no">107</span><span id="line-107"> if (in == null) {</span> |
| <span class="source-line-no">108</span><span id="line-108"> throw new FileNotFoundException("Resource " + path + " not found");</span> |
| <span class="source-line-no">109</span><span id="line-109"> }</span> |
| <span class="source-line-no">110</span><span id="line-110"> final ByteArrayOutputStream baos = new ByteArrayOutputStream();</span> |
| <span class="source-line-no">111</span><span id="line-111"> try {</span> |
| <span class="source-line-no">112</span><span id="line-112"> final byte[] buffer = new byte[8192];</span> |
| <span class="source-line-no">113</span><span id="line-113"> int n, len = 0;</span> |
| <span class="source-line-no">114</span><span id="line-114"> do {</span> |
| <span class="source-line-no">115</span><span id="line-115"> n = in.read(buffer);</span> |
| <span class="source-line-no">116</span><span id="line-116"> if (n > 0) {</span> |
| <span class="source-line-no">117</span><span id="line-117"> len += n;</span> |
| <span class="source-line-no">118</span><span id="line-118"> if (len > maxSize) {</span> |
| <span class="source-line-no">119</span><span id="line-119"> throw new IOException("Dictionary " + s + " is too large, limit=" + maxSize);</span> |
| <span class="source-line-no">120</span><span id="line-120"> }</span> |
| <span class="source-line-no">121</span><span id="line-121"> baos.write(buffer, 0, n);</span> |
| <span class="source-line-no">122</span><span id="line-122"> }</span> |
| <span class="source-line-no">123</span><span id="line-123"> } while (n > 0);</span> |
| <span class="source-line-no">124</span><span id="line-124"> } finally {</span> |
| <span class="source-line-no">125</span><span id="line-125"> in.close();</span> |
| <span class="source-line-no">126</span><span id="line-126"> }</span> |
| <span class="source-line-no">127</span><span id="line-127"> return baos.toByteArray();</span> |
| <span class="source-line-no">128</span><span id="line-128"> }</span> |
| <span class="source-line-no">129</span><span id="line-129"></span> |
| <span class="source-line-no">130</span><span id="line-130"> private static byte[] loadFromHadoopFs(final Configuration conf, final String s,</span> |
| <span class="source-line-no">131</span><span id="line-131"> final int maxSize) throws IOException {</span> |
| <span class="source-line-no">132</span><span id="line-132"> final Path path = new Path(s);</span> |
| <span class="source-line-no">133</span><span id="line-133"> final FileSystem fs = FileSystem.get(path.toUri(), conf);</span> |
| <span class="source-line-no">134</span><span id="line-134"> LOG.info("Loading file {}", path);</span> |
| <span class="source-line-no">135</span><span id="line-135"> final ByteArrayOutputStream baos = new ByteArrayOutputStream();</span> |
| <span class="source-line-no">136</span><span id="line-136"> final FSDataInputStream in = fs.open(path);</span> |
| <span class="source-line-no">137</span><span id="line-137"> try {</span> |
| <span class="source-line-no">138</span><span id="line-138"> final byte[] buffer = new byte[8192];</span> |
| <span class="source-line-no">139</span><span id="line-139"> int n, len = 0;</span> |
| <span class="source-line-no">140</span><span id="line-140"> do {</span> |
| <span class="source-line-no">141</span><span id="line-141"> n = in.read(buffer);</span> |
| <span class="source-line-no">142</span><span id="line-142"> if (n > 0) {</span> |
| <span class="source-line-no">143</span><span id="line-143"> len += n;</span> |
| <span class="source-line-no">144</span><span id="line-144"> if (len > maxSize) {</span> |
| <span class="source-line-no">145</span><span id="line-145"> throw new IOException("Dictionary " + s + " is too large, limit=" + maxSize);</span> |
| <span class="source-line-no">146</span><span id="line-146"> }</span> |
| <span class="source-line-no">147</span><span id="line-147"> baos.write(buffer, 0, n);</span> |
| <span class="source-line-no">148</span><span id="line-148"> }</span> |
| <span class="source-line-no">149</span><span id="line-149"> } while (n > 0);</span> |
| <span class="source-line-no">150</span><span id="line-150"> } finally {</span> |
| <span class="source-line-no">151</span><span id="line-151"> in.close();</span> |
| <span class="source-line-no">152</span><span id="line-152"> }</span> |
| <span class="source-line-no">153</span><span id="line-153"> return baos.toByteArray();</span> |
| <span class="source-line-no">154</span><span id="line-154"> }</span> |
| <span class="source-line-no">155</span><span id="line-155"></span> |
| <span class="source-line-no">156</span><span id="line-156"> // Visible for testing</span> |
| <span class="source-line-no">157</span><span id="line-157"> public static boolean contains(String dictionaryPath) {</span> |
| <span class="source-line-no">158</span><span id="line-158"> if (CACHE != null) {</span> |
| <span class="source-line-no">159</span><span id="line-159"> return CACHE.asMap().containsKey(dictionaryPath);</span> |
| <span class="source-line-no">160</span><span id="line-160"> }</span> |
| <span class="source-line-no">161</span><span id="line-161"> return false;</span> |
| <span class="source-line-no">162</span><span id="line-162"> }</span> |
| <span class="source-line-no">163</span><span id="line-163"></span> |
| <span class="source-line-no">164</span><span id="line-164">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
