| <!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.wal, class: FSHLogProvider"> |
| <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.wal;</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 org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.fs.FileSystem;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.fs.Path;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.client.RegionInfo;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.io.asyncfs.monitor.StreamSlowMonitor;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.regionserver.wal.FSHLog;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.regionserver.wal.ProtobufLogWriter;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.regionserver.wal.WALUtil;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.util.CommonFSUtils;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.util.CommonFSUtils.StreamLacksCapabilityException;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.yetus.audience.InterfaceStability;</span> |
| <span class="source-line-no">033</span><span id="line-33">import org.slf4j.Logger;</span> |
| <span class="source-line-no">034</span><span id="line-34">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">035</span><span id="line-35"></span> |
| <span class="source-line-no">036</span><span id="line-36">/**</span> |
| <span class="source-line-no">037</span><span id="line-37"> * A WAL provider that use {@link FSHLog}.</span> |
| <span class="source-line-no">038</span><span id="line-38"> */</span> |
| <span class="source-line-no">039</span><span id="line-39">@InterfaceAudience.Private</span> |
| <span class="source-line-no">040</span><span id="line-40">@InterfaceStability.Evolving</span> |
| <span class="source-line-no">041</span><span id="line-41">public class FSHLogProvider extends AbstractFSWALProvider<FSHLog> {</span> |
| <span class="source-line-no">042</span><span id="line-42"></span> |
| <span class="source-line-no">043</span><span id="line-43"> private static final Logger LOG = LoggerFactory.getLogger(FSHLogProvider.class);</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 static final String WRITER_IMPL = "hbase.regionserver.wal.writer.impl";</span> |
| <span class="source-line-no">046</span><span id="line-46"></span> |
| <span class="source-line-no">047</span><span id="line-47"> // Only public so classes back in regionserver.wal can access</span> |
| <span class="source-line-no">048</span><span id="line-48"> public interface Writer extends WALProvider.Writer {</span> |
| <span class="source-line-no">049</span><span id="line-49"> /**</span> |
| <span class="source-line-no">050</span><span id="line-50"> * @throws IOException if something goes wrong initializing an output stream</span> |
| <span class="source-line-no">051</span><span id="line-51"> * @throws StreamLacksCapabilityException if the given FileSystem can't provide streams that</span> |
| <span class="source-line-no">052</span><span id="line-52"> * meet the needs of the given Writer implementation.</span> |
| <span class="source-line-no">053</span><span id="line-53"> */</span> |
| <span class="source-line-no">054</span><span id="line-54"> void init(FileSystem fs, Path path, Configuration c, boolean overwritable, long blocksize,</span> |
| <span class="source-line-no">055</span><span id="line-55"> StreamSlowMonitor monitor) throws IOException, CommonFSUtils.StreamLacksCapabilityException;</span> |
| <span class="source-line-no">056</span><span id="line-56"> }</span> |
| <span class="source-line-no">057</span><span id="line-57"></span> |
| <span class="source-line-no">058</span><span id="line-58"> /**</span> |
| <span class="source-line-no">059</span><span id="line-59"> * Public because of FSHLog. Should be package-private</span> |
| <span class="source-line-no">060</span><span id="line-60"> * @param overwritable if the created writer can overwrite. For recovered edits, it is true and</span> |
| <span class="source-line-no">061</span><span id="line-61"> * for WAL it is false. Thus we can distinguish WAL and recovered edits by</span> |
| <span class="source-line-no">062</span><span id="line-62"> * this.</span> |
| <span class="source-line-no">063</span><span id="line-63"> */</span> |
| <span class="source-line-no">064</span><span id="line-64"> public static Writer createWriter(final Configuration conf, final FileSystem fs, final Path path,</span> |
| <span class="source-line-no">065</span><span id="line-65"> final boolean overwritable) throws IOException {</span> |
| <span class="source-line-no">066</span><span id="line-66"> return createWriter(conf, fs, path, overwritable,</span> |
| <span class="source-line-no">067</span><span id="line-67"> WALUtil.getWALBlockSize(conf, fs, path, overwritable));</span> |
| <span class="source-line-no">068</span><span id="line-68"> }</span> |
| <span class="source-line-no">069</span><span id="line-69"></span> |
| <span class="source-line-no">070</span><span id="line-70"> /**</span> |
| <span class="source-line-no">071</span><span id="line-71"> * Public because of FSHLog. Should be package-private</span> |
| <span class="source-line-no">072</span><span id="line-72"> */</span> |
| <span class="source-line-no">073</span><span id="line-73"> public static Writer createWriter(final Configuration conf, final FileSystem fs, final Path path,</span> |
| <span class="source-line-no">074</span><span id="line-74"> final boolean overwritable, long blocksize) throws IOException {</span> |
| <span class="source-line-no">075</span><span id="line-75"> // Configuration already does caching for the Class lookup.</span> |
| <span class="source-line-no">076</span><span id="line-76"> Class<? extends Writer> logWriterClass =</span> |
| <span class="source-line-no">077</span><span id="line-77"> conf.getClass(WRITER_IMPL, ProtobufLogWriter.class, Writer.class);</span> |
| <span class="source-line-no">078</span><span id="line-78"> Writer writer = null;</span> |
| <span class="source-line-no">079</span><span id="line-79"> try {</span> |
| <span class="source-line-no">080</span><span id="line-80"> writer = logWriterClass.getDeclaredConstructor().newInstance();</span> |
| <span class="source-line-no">081</span><span id="line-81"> FileSystem rootFs = FileSystem.get(path.toUri(), conf);</span> |
| <span class="source-line-no">082</span><span id="line-82"> writer.init(rootFs, path, conf, overwritable, blocksize,</span> |
| <span class="source-line-no">083</span><span id="line-83"> StreamSlowMonitor.create(conf, path.getName()));</span> |
| <span class="source-line-no">084</span><span id="line-84"> return writer;</span> |
| <span class="source-line-no">085</span><span id="line-85"> } catch (Exception e) {</span> |
| <span class="source-line-no">086</span><span id="line-86"> if (e instanceof CommonFSUtils.StreamLacksCapabilityException) {</span> |
| <span class="source-line-no">087</span><span id="line-87"> LOG.error("The RegionServer write ahead log provider for FileSystem implementations "</span> |
| <span class="source-line-no">088</span><span id="line-88"> + "relies on the ability to call " + e.getMessage() + " for proper operation during "</span> |
| <span class="source-line-no">089</span><span id="line-89"> + "component failures, but the current FileSystem does not support doing so. Please "</span> |
| <span class="source-line-no">090</span><span id="line-90"> + "check the config value of '" + CommonFSUtils.HBASE_WAL_DIR + "' and ensure "</span> |
| <span class="source-line-no">091</span><span id="line-91"> + "it points to a FileSystem mount that has suitable capabilities for output streams.");</span> |
| <span class="source-line-no">092</span><span id="line-92"> } else {</span> |
| <span class="source-line-no">093</span><span id="line-93"> LOG.debug("Error instantiating log writer.", e);</span> |
| <span class="source-line-no">094</span><span id="line-94"> }</span> |
| <span class="source-line-no">095</span><span id="line-95"> throw new IOException("cannot get log writer", e);</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"></span> |
| <span class="source-line-no">099</span><span id="line-99"> @Override</span> |
| <span class="source-line-no">100</span><span id="line-100"> protected FSHLog createWAL() throws IOException {</span> |
| <span class="source-line-no">101</span><span id="line-101"> return new FSHLog(CommonFSUtils.getWALFileSystem(conf), abortable,</span> |
| <span class="source-line-no">102</span><span id="line-102"> CommonFSUtils.getWALRootDir(conf), getWALDirectoryName(factory.factoryId),</span> |
| <span class="source-line-no">103</span><span id="line-103"> getWALArchiveDirectoryName(conf, factory.factoryId), conf, listeners, true, logPrefix,</span> |
| <span class="source-line-no">104</span><span id="line-104"> META_WAL_PROVIDER_ID.equals(providerId) ? META_WAL_PROVIDER_ID : null, null, null);</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"> protected WAL createRemoteWAL(RegionInfo region, FileSystem remoteFs, Path remoteWALDir,</span> |
| <span class="source-line-no">109</span><span id="line-109"> String prefix, String suffix) throws IOException {</span> |
| <span class="source-line-no">110</span><span id="line-110"> return new FSHLog(CommonFSUtils.getWALFileSystem(conf), abortable,</span> |
| <span class="source-line-no">111</span><span id="line-111"> CommonFSUtils.getWALRootDir(conf), getWALDirectoryName(factory.factoryId),</span> |
| <span class="source-line-no">112</span><span id="line-112"> getWALArchiveDirectoryName(conf, factory.factoryId), conf, listeners, true, prefix, suffix,</span> |
| <span class="source-line-no">113</span><span id="line-113"> remoteFs, remoteWALDir);</span> |
| <span class="source-line-no">114</span><span id="line-114"> }</span> |
| <span class="source-line-no">115</span><span id="line-115"></span> |
| <span class="source-line-no">116</span><span id="line-116"> @Override</span> |
| <span class="source-line-no">117</span><span id="line-117"> protected void doInit(Configuration conf) throws IOException {</span> |
| <span class="source-line-no">118</span><span id="line-118"> }</span> |
| <span class="source-line-no">119</span><span id="line-119"></span> |
| <span class="source-line-no">120</span><span id="line-120">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
