| <!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.hfile, class: HFilePreadReader"> |
| <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.hfile;</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.Optional;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.commons.lang3.mutable.MutableBoolean;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.conf.Configuration;</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.FSDataInputStreamWrapper;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.slf4j.Logger;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.slf4j.LoggerFactory;</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"> * Implementation of {@link HFile.Reader} to deal with pread.</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 HFilePreadReader extends HFileReaderImpl {</span> |
| <span class="source-line-no">035</span><span id="line-35"> private static final Logger LOG = LoggerFactory.getLogger(HFileReaderImpl.class);</span> |
| <span class="source-line-no">036</span><span id="line-36"></span> |
| <span class="source-line-no">037</span><span id="line-37"> private static final int WAIT_TIME_FOR_CACHE_INITIALIZATION = 10 * 60 * 1000;</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 HFilePreadReader(ReaderContext context, HFileInfo fileInfo, CacheConfig cacheConf,</span> |
| <span class="source-line-no">040</span><span id="line-40"> Configuration conf) throws IOException {</span> |
| <span class="source-line-no">041</span><span id="line-41"> super(context, fileInfo, cacheConf, conf);</span> |
| <span class="source-line-no">042</span><span id="line-42"> final MutableBoolean shouldCache = new MutableBoolean(true);</span> |
| <span class="source-line-no">043</span><span id="line-43"></span> |
| <span class="source-line-no">044</span><span id="line-44"> cacheConf.getBlockCache().ifPresent(cache -> {</span> |
| <span class="source-line-no">045</span><span id="line-45"> cache.waitForCacheInitialization(WAIT_TIME_FOR_CACHE_INITIALIZATION);</span> |
| <span class="source-line-no">046</span><span id="line-46"> Optional<Boolean> result = cache.shouldCacheFile(path.getName());</span> |
| <span class="source-line-no">047</span><span id="line-47"> shouldCache.setValue(result.isPresent() ? result.get().booleanValue() : true);</span> |
| <span class="source-line-no">048</span><span id="line-48"> });</span> |
| <span class="source-line-no">049</span><span id="line-49"></span> |
| <span class="source-line-no">050</span><span id="line-50"> // Prefetch file blocks upon open if requested</span> |
| <span class="source-line-no">051</span><span id="line-51"> if (cacheConf.shouldPrefetchOnOpen() && shouldCache.booleanValue()) {</span> |
| <span class="source-line-no">052</span><span id="line-52"> PrefetchExecutor.request(path, new Runnable() {</span> |
| <span class="source-line-no">053</span><span id="line-53"> @Override</span> |
| <span class="source-line-no">054</span><span id="line-54"> public void run() {</span> |
| <span class="source-line-no">055</span><span id="line-55"> long offset = 0;</span> |
| <span class="source-line-no">056</span><span id="line-56"> long end = 0;</span> |
| <span class="source-line-no">057</span><span id="line-57"> HFile.Reader prefetchStreamReader = null;</span> |
| <span class="source-line-no">058</span><span id="line-58"> try {</span> |
| <span class="source-line-no">059</span><span id="line-59"> ReaderContext streamReaderContext = ReaderContextBuilder.newBuilder(context)</span> |
| <span class="source-line-no">060</span><span id="line-60"> .withReaderType(ReaderContext.ReaderType.STREAM)</span> |
| <span class="source-line-no">061</span><span id="line-61"> .withInputStreamWrapper(new FSDataInputStreamWrapper(context.getFileSystem(),</span> |
| <span class="source-line-no">062</span><span id="line-62"> context.getInputStreamWrapper().getReaderPath()))</span> |
| <span class="source-line-no">063</span><span id="line-63"> .build();</span> |
| <span class="source-line-no">064</span><span id="line-64"> prefetchStreamReader =</span> |
| <span class="source-line-no">065</span><span id="line-65"> new HFileStreamReader(streamReaderContext, fileInfo, cacheConf, conf);</span> |
| <span class="source-line-no">066</span><span id="line-66"> end = getTrailer().getLoadOnOpenDataOffset();</span> |
| <span class="source-line-no">067</span><span id="line-67"> if (LOG.isTraceEnabled()) {</span> |
| <span class="source-line-no">068</span><span id="line-68"> LOG.trace("Prefetch start " + getPathOffsetEndStr(path, offset, end));</span> |
| <span class="source-line-no">069</span><span id="line-69"> }</span> |
| <span class="source-line-no">070</span><span id="line-70"> // Don't use BlockIterator here, because it's designed to read load-on-open section.</span> |
| <span class="source-line-no">071</span><span id="line-71"> long onDiskSizeOfNextBlock = -1;</span> |
| <span class="source-line-no">072</span><span id="line-72"> // if we are here, block cache is present anyways</span> |
| <span class="source-line-no">073</span><span id="line-73"> BlockCache cache = cacheConf.getBlockCache().get();</span> |
| <span class="source-line-no">074</span><span id="line-74"> boolean interrupted = false;</span> |
| <span class="source-line-no">075</span><span id="line-75"> int blockCount = 0;</span> |
| <span class="source-line-no">076</span><span id="line-76"> int dataBlockCount = 0;</span> |
| <span class="source-line-no">077</span><span id="line-77"> while (offset < end) {</span> |
| <span class="source-line-no">078</span><span id="line-78"> if (Thread.interrupted()) {</span> |
| <span class="source-line-no">079</span><span id="line-79"> break;</span> |
| <span class="source-line-no">080</span><span id="line-80"> }</span> |
| <span class="source-line-no">081</span><span id="line-81"> // Some cache implementations can be persistent and resilient to restarts,</span> |
| <span class="source-line-no">082</span><span id="line-82"> // so we check first if the block exists on its in-memory index, if so, we just</span> |
| <span class="source-line-no">083</span><span id="line-83"> // update the offset and move on to the next block without actually going read all</span> |
| <span class="source-line-no">084</span><span id="line-84"> // the way to the cache.</span> |
| <span class="source-line-no">085</span><span id="line-85"> BlockCacheKey cacheKey = new BlockCacheKey(name, offset);</span> |
| <span class="source-line-no">086</span><span id="line-86"> if (cache.isAlreadyCached(cacheKey).orElse(false)) {</span> |
| <span class="source-line-no">087</span><span id="line-87"> // Right now, isAlreadyCached is only supported by BucketCache, which should</span> |
| <span class="source-line-no">088</span><span id="line-88"> // always cache data blocks.</span> |
| <span class="source-line-no">089</span><span id="line-89"> int size = cache.getBlockSize(cacheKey).orElse(0);</span> |
| <span class="source-line-no">090</span><span id="line-90"> if (size > 0) {</span> |
| <span class="source-line-no">091</span><span id="line-91"> offset += size;</span> |
| <span class="source-line-no">092</span><span id="line-92"> LOG.debug("Found block of size {} for cache key {}. "</span> |
| <span class="source-line-no">093</span><span id="line-93"> + "Skipping prefetch, the block is already cached.", size, cacheKey);</span> |
| <span class="source-line-no">094</span><span id="line-94"> blockCount++;</span> |
| <span class="source-line-no">095</span><span id="line-95"> dataBlockCount++;</span> |
| <span class="source-line-no">096</span><span id="line-96"> continue;</span> |
| <span class="source-line-no">097</span><span id="line-97"> } else {</span> |
| <span class="source-line-no">098</span><span id="line-98"> LOG.debug("Found block for cache key {}, but couldn't get its size. "</span> |
| <span class="source-line-no">099</span><span id="line-99"> + "Maybe the cache implementation doesn't support it? "</span> |
| <span class="source-line-no">100</span><span id="line-100"> + "We'll need to read the block from cache or file system. ", cacheKey);</span> |
| <span class="source-line-no">101</span><span id="line-101"> }</span> |
| <span class="source-line-no">102</span><span id="line-102"> } else {</span> |
| <span class="source-line-no">103</span><span id="line-103"> LOG.debug("No entry in the backing map for cache key {}. ", cacheKey);</span> |
| <span class="source-line-no">104</span><span id="line-104"> }</span> |
| <span class="source-line-no">105</span><span id="line-105"> // Perhaps we got our block from cache? Unlikely as this may be, if it happens, then</span> |
| <span class="source-line-no">106</span><span id="line-106"> // the internal-to-hfileblock thread local which holds the overread that gets the</span> |
| <span class="source-line-no">107</span><span id="line-107"> // next header, will not have happened...so, pass in the onDiskSize gotten from the</span> |
| <span class="source-line-no">108</span><span id="line-108"> // cached block. This 'optimization' triggers extremely rarely I'd say.</span> |
| <span class="source-line-no">109</span><span id="line-109"> HFileBlock block = prefetchStreamReader.readBlock(offset, onDiskSizeOfNextBlock,</span> |
| <span class="source-line-no">110</span><span id="line-110"> /* cacheBlock= */true, /* pread= */false, false, false, null, null, true);</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"> if (!cacheConf.isInMemory()) {</span> |
| <span class="source-line-no">113</span><span id="line-113"> if (!cache.blockFitsIntoTheCache(block).orElse(true)) {</span> |
| <span class="source-line-no">114</span><span id="line-114"> LOG.warn(</span> |
| <span class="source-line-no">115</span><span id="line-115"> "Interrupting prefetch for file {} because block {} of size {} "</span> |
| <span class="source-line-no">116</span><span id="line-116"> + "doesn't fit in the available cache space. isCacheEnabled: {}",</span> |
| <span class="source-line-no">117</span><span id="line-117"> path, cacheKey, block.getOnDiskSizeWithHeader(), cache.isCacheEnabled());</span> |
| <span class="source-line-no">118</span><span id="line-118"> interrupted = true;</span> |
| <span class="source-line-no">119</span><span id="line-119"> break;</span> |
| <span class="source-line-no">120</span><span id="line-120"> }</span> |
| <span class="source-line-no">121</span><span id="line-121"> if (!cacheConf.isHeapUsageBelowThreshold()) {</span> |
| <span class="source-line-no">122</span><span id="line-122"> LOG.warn(</span> |
| <span class="source-line-no">123</span><span id="line-123"> "Interrupting prefetch because heap usage is above the threshold: {} "</span> |
| <span class="source-line-no">124</span><span id="line-124"> + "configured via {}",</span> |
| <span class="source-line-no">125</span><span id="line-125"> cacheConf.getHeapUsageThreshold(), CacheConfig.PREFETCH_HEAP_USAGE_THRESHOLD);</span> |
| <span class="source-line-no">126</span><span id="line-126"> interrupted = true;</span> |
| <span class="source-line-no">127</span><span id="line-127"> break;</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"> onDiskSizeOfNextBlock = block.getNextBlockOnDiskSize();</span> |
| <span class="source-line-no">131</span><span id="line-131"> offset += block.getOnDiskSizeWithHeader();</span> |
| <span class="source-line-no">132</span><span id="line-132"> blockCount++;</span> |
| <span class="source-line-no">133</span><span id="line-133"> if (block.getBlockType().isData()) {</span> |
| <span class="source-line-no">134</span><span id="line-134"> dataBlockCount++;</span> |
| <span class="source-line-no">135</span><span id="line-135"> }</span> |
| <span class="source-line-no">136</span><span id="line-136"> } finally {</span> |
| <span class="source-line-no">137</span><span id="line-137"> // Ideally here the readBlock won't find the block in cache. We call this</span> |
| <span class="source-line-no">138</span><span id="line-138"> // readBlock so that block data is read from FS and cached in BC. we must call</span> |
| <span class="source-line-no">139</span><span id="line-139"> // returnBlock here to decrease the reference count of block.</span> |
| <span class="source-line-no">140</span><span id="line-140"> block.release();</span> |
| <span class="source-line-no">141</span><span id="line-141"> }</span> |
| <span class="source-line-no">142</span><span id="line-142"> }</span> |
| <span class="source-line-no">143</span><span id="line-143"> if (!interrupted) {</span> |
| <span class="source-line-no">144</span><span id="line-144"> cacheConf.getBlockCache().get().notifyFileCachingCompleted(path, blockCount,</span> |
| <span class="source-line-no">145</span><span id="line-145"> dataBlockCount, offset);</span> |
| <span class="source-line-no">146</span><span id="line-146"> }</span> |
| <span class="source-line-no">147</span><span id="line-147"> } catch (IOException e) {</span> |
| <span class="source-line-no">148</span><span id="line-148"> // IOExceptions are probably due to region closes (relocation, etc.)</span> |
| <span class="source-line-no">149</span><span id="line-149"> if (LOG.isTraceEnabled()) {</span> |
| <span class="source-line-no">150</span><span id="line-150"> LOG.trace("Prefetch " + getPathOffsetEndStr(path, offset, end), e);</span> |
| <span class="source-line-no">151</span><span id="line-151"> }</span> |
| <span class="source-line-no">152</span><span id="line-152"> } catch (Throwable e) {</span> |
| <span class="source-line-no">153</span><span id="line-153"> // Other exceptions are interesting</span> |
| <span class="source-line-no">154</span><span id="line-154"> LOG.warn("Prefetch " + getPathOffsetEndStr(path, offset, end), e);</span> |
| <span class="source-line-no">155</span><span id="line-155"> } finally {</span> |
| <span class="source-line-no">156</span><span id="line-156"> if (prefetchStreamReader != null) {</span> |
| <span class="source-line-no">157</span><span id="line-157"> try {</span> |
| <span class="source-line-no">158</span><span id="line-158"> prefetchStreamReader.close(false);</span> |
| <span class="source-line-no">159</span><span id="line-159"> } catch (IOException e) {</span> |
| <span class="source-line-no">160</span><span id="line-160"> LOG.warn("Close prefetch stream reader failed, path: " + path, e);</span> |
| <span class="source-line-no">161</span><span id="line-161"> }</span> |
| <span class="source-line-no">162</span><span id="line-162"> }</span> |
| <span class="source-line-no">163</span><span id="line-163"> PrefetchExecutor.complete(path);</span> |
| <span class="source-line-no">164</span><span id="line-164"> }</span> |
| <span class="source-line-no">165</span><span id="line-165"> }</span> |
| <span class="source-line-no">166</span><span id="line-166"> });</span> |
| <span class="source-line-no">167</span><span id="line-167"> }</span> |
| <span class="source-line-no">168</span><span id="line-168"> }</span> |
| <span class="source-line-no">169</span><span id="line-169"></span> |
| <span class="source-line-no">170</span><span id="line-170"> /*</span> |
| <span class="source-line-no">171</span><span id="line-171"> * Get the region name for the given file path. A HFile is always kept under the <region>/<column</span> |
| <span class="source-line-no">172</span><span id="line-172"> * family>/<hfile>. To find the region for a given hFile, just find the name of the grandparent</span> |
| <span class="source-line-no">173</span><span id="line-173"> * directory.</span> |
| <span class="source-line-no">174</span><span id="line-174"> */</span> |
| <span class="source-line-no">175</span><span id="line-175"> private static String getRegionName(Path path) {</span> |
| <span class="source-line-no">176</span><span id="line-176"> return path.getParent().getParent().getName();</span> |
| <span class="source-line-no">177</span><span id="line-177"> }</span> |
| <span class="source-line-no">178</span><span id="line-178"></span> |
| <span class="source-line-no">179</span><span id="line-179"> private static String getPathOffsetEndStr(final Path path, final long offset, final long end) {</span> |
| <span class="source-line-no">180</span><span id="line-180"> return "path=" + path.toString() + ", offset=" + offset + ", end=" + end;</span> |
| <span class="source-line-no">181</span><span id="line-181"> }</span> |
| <span class="source-line-no">182</span><span id="line-182"></span> |
| <span class="source-line-no">183</span><span id="line-183"> public void close(boolean evictOnClose) throws IOException {</span> |
| <span class="source-line-no">184</span><span id="line-184"> PrefetchExecutor.cancel(path);</span> |
| <span class="source-line-no">185</span><span id="line-185"> // Deallocate blocks in load-on-open section</span> |
| <span class="source-line-no">186</span><span id="line-186"> this.fileInfo.close();</span> |
| <span class="source-line-no">187</span><span id="line-187"> // Deallocate data blocks</span> |
| <span class="source-line-no">188</span><span id="line-188"> cacheConf.getBlockCache().ifPresent(cache -> {</span> |
| <span class="source-line-no">189</span><span id="line-189"> if (evictOnClose) {</span> |
| <span class="source-line-no">190</span><span id="line-190"> int numEvicted = cache.evictBlocksByHfileName(name);</span> |
| <span class="source-line-no">191</span><span id="line-191"> if (LOG.isTraceEnabled()) {</span> |
| <span class="source-line-no">192</span><span id="line-192"> LOG.trace("On close, file= {} evicted= {} block(s)", name, numEvicted);</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"> fsBlockReader.closeStreams();</span> |
| <span class="source-line-no">197</span><span id="line-197"> }</span> |
| <span class="source-line-no">198</span><span id="line-198">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
