blob: 24de731cfa4bdad4d543bbb0323fb35e816454c5 [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.io.asyncfs, class: AsyncFSOutputHelper">
<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.asyncfs;</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.fs.CommonConfigurationKeysPublic;</span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.fs.FSDataOutputStream;</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.fs.StreamCapabilities;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.io.asyncfs.monitor.StreamSlowMonitor;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.util.CommonFSUtils;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.util.CommonFSUtils.StreamLacksCapabilityException;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hdfs.DistributedFileSystem;</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"></span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hbase.thirdparty.com.google.common.io.Closeables;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hbase.thirdparty.io.netty.channel.Channel;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hbase.thirdparty.io.netty.channel.EventLoopGroup;</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"> * Helper class for creating AsyncFSOutput.</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">public final class AsyncFSOutputHelper {</span>
<span class="source-line-no">041</span><span id="line-41"></span>
<span class="source-line-no">042</span><span id="line-42"> private AsyncFSOutputHelper() {</span>
<span class="source-line-no">043</span><span id="line-43"> }</span>
<span class="source-line-no">044</span><span id="line-44"></span>
<span class="source-line-no">045</span><span id="line-45"> /**</span>
<span class="source-line-no">046</span><span id="line-46"> * Create {@link FanOutOneBlockAsyncDFSOutput} for {@link DistributedFileSystem}, and a simple</span>
<span class="source-line-no">047</span><span id="line-47"> * implementation for other {@link FileSystem} which wraps around a {@link FSDataOutputStream}.</span>
<span class="source-line-no">048</span><span id="line-48"> */</span>
<span class="source-line-no">049</span><span id="line-49"> public static AsyncFSOutput createOutput(FileSystem fs, Path f, boolean overwrite,</span>
<span class="source-line-no">050</span><span id="line-50"> boolean createParent, short replication, long blockSize, EventLoopGroup eventLoopGroup,</span>
<span class="source-line-no">051</span><span id="line-51"> Class&lt;? extends Channel&gt; channelClass, StreamSlowMonitor monitor, boolean noLocalWrite)</span>
<span class="source-line-no">052</span><span id="line-52"> throws IOException, CommonFSUtils.StreamLacksCapabilityException {</span>
<span class="source-line-no">053</span><span id="line-53"> if (fs instanceof DistributedFileSystem) {</span>
<span class="source-line-no">054</span><span id="line-54"> return FanOutOneBlockAsyncDFSOutputHelper.createOutput((DistributedFileSystem) fs, f,</span>
<span class="source-line-no">055</span><span id="line-55"> overwrite, createParent, replication, blockSize, eventLoopGroup, channelClass, monitor,</span>
<span class="source-line-no">056</span><span id="line-56"> noLocalWrite);</span>
<span class="source-line-no">057</span><span id="line-57"> }</span>
<span class="source-line-no">058</span><span id="line-58"> final FSDataOutputStream out;</span>
<span class="source-line-no">059</span><span id="line-59"> int bufferSize = fs.getConf().getInt(CommonConfigurationKeysPublic.IO_FILE_BUFFER_SIZE_KEY,</span>
<span class="source-line-no">060</span><span id="line-60"> CommonConfigurationKeysPublic.IO_FILE_BUFFER_SIZE_DEFAULT);</span>
<span class="source-line-no">061</span><span id="line-61"> // This is not a Distributed File System, so it won't be erasure coded; no builder API needed</span>
<span class="source-line-no">062</span><span id="line-62"> if (createParent) {</span>
<span class="source-line-no">063</span><span id="line-63"> out = fs.create(f, overwrite, bufferSize, replication, blockSize, null);</span>
<span class="source-line-no">064</span><span id="line-64"> } else {</span>
<span class="source-line-no">065</span><span id="line-65"> out = fs.createNonRecursive(f, overwrite, bufferSize, replication, blockSize, 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"> // After we create the stream but before we attempt to use it at all</span>
<span class="source-line-no">068</span><span id="line-68"> // ensure that we can provide the level of data safety we're configured</span>
<span class="source-line-no">069</span><span id="line-69"> // to provide.</span>
<span class="source-line-no">070</span><span id="line-70"> if (fs.getConf().getBoolean(CommonFSUtils.UNSAFE_STREAM_CAPABILITY_ENFORCE, true)) {</span>
<span class="source-line-no">071</span><span id="line-71"> if (!out.hasCapability(StreamCapabilities.HFLUSH)) {</span>
<span class="source-line-no">072</span><span id="line-72"> Closeables.close(out, true);</span>
<span class="source-line-no">073</span><span id="line-73"> throw new StreamLacksCapabilityException(StreamCapabilities.HFLUSH);</span>
<span class="source-line-no">074</span><span id="line-74"> }</span>
<span class="source-line-no">075</span><span id="line-75"> if (!out.hasCapability(StreamCapabilities.HSYNC)) {</span>
<span class="source-line-no">076</span><span id="line-76"> Closeables.close(out, true);</span>
<span class="source-line-no">077</span><span id="line-77"> throw new StreamLacksCapabilityException(StreamCapabilities.HSYNC);</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"> return new WrapperAsyncFSOutput(f, out);</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>
</pre>
</div>
</main>
</body>
</html>