blob: aec3860a8758b9ab738da11981aa7e83452508b8 [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.wal, class: DisabledWALProvider">
<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 java.util.ArrayList;</span>
<span class="source-line-no">022</span><span id="line-22">import java.util.List;</span>
<span class="source-line-no">023</span><span id="line-23">import java.util.Map;</span>
<span class="source-line-no">024</span><span id="line-24">import java.util.OptionalLong;</span>
<span class="source-line-no">025</span><span id="line-25">import java.util.Set;</span>
<span class="source-line-no">026</span><span id="line-26">import java.util.concurrent.CopyOnWriteArrayList;</span>
<span class="source-line-no">027</span><span id="line-27">import java.util.concurrent.atomic.AtomicBoolean;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.conf.Configuration;</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.hadoop.hbase.Abortable;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.Cell;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.HConstants;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.PrivateCellUtil;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.client.RegionInfo;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.regionserver.MultiVersionConcurrencyControl.WriteEntry;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.regionserver.wal.WALActionsListener;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.regionserver.wal.WALCoprocessorHost;</span>
<span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.util.CommonFSUtils;</span>
<span class="source-line-no">039</span><span id="line-39">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">040</span><span id="line-40">import org.slf4j.Logger;</span>
<span class="source-line-no">041</span><span id="line-41">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">042</span><span id="line-42"></span>
<span class="source-line-no">043</span><span id="line-43">// imports for things that haven't moved from regionserver.wal yet.</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"> * No-op implementation of {@link WALProvider} used when the WAL is disabled. Should only be used</span>
<span class="source-line-no">047</span><span id="line-47"> * when severe data loss is acceptable.</span>
<span class="source-line-no">048</span><span id="line-48"> */</span>
<span class="source-line-no">049</span><span id="line-49">@InterfaceAudience.Private</span>
<span class="source-line-no">050</span><span id="line-50">class DisabledWALProvider implements WALProvider {</span>
<span class="source-line-no">051</span><span id="line-51"></span>
<span class="source-line-no">052</span><span id="line-52"> private static final Logger LOG = LoggerFactory.getLogger(DisabledWALProvider.class);</span>
<span class="source-line-no">053</span><span id="line-53"></span>
<span class="source-line-no">054</span><span id="line-54"> WAL disabled;</span>
<span class="source-line-no">055</span><span id="line-55"></span>
<span class="source-line-no">056</span><span id="line-56"> @Override</span>
<span class="source-line-no">057</span><span id="line-57"> public void init(WALFactory factory, Configuration conf, String providerId, Abortable abortable)</span>
<span class="source-line-no">058</span><span id="line-58"> throws IOException {</span>
<span class="source-line-no">059</span><span id="line-59"> if (null != disabled) {</span>
<span class="source-line-no">060</span><span id="line-60"> throw new IllegalStateException("WALProvider.init should only be called once.");</span>
<span class="source-line-no">061</span><span id="line-61"> }</span>
<span class="source-line-no">062</span><span id="line-62"> if (null == providerId) {</span>
<span class="source-line-no">063</span><span id="line-63"> providerId = "defaultDisabled";</span>
<span class="source-line-no">064</span><span id="line-64"> }</span>
<span class="source-line-no">065</span><span id="line-65"> disabled = new DisabledWAL(new Path(CommonFSUtils.getWALRootDir(conf), providerId), conf, 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"></span>
<span class="source-line-no">068</span><span id="line-68"> @Override</span>
<span class="source-line-no">069</span><span id="line-69"> public List&lt;WAL&gt; getWALs() {</span>
<span class="source-line-no">070</span><span id="line-70"> List&lt;WAL&gt; wals = new ArrayList&lt;&gt;(1);</span>
<span class="source-line-no">071</span><span id="line-71"> wals.add(disabled);</span>
<span class="source-line-no">072</span><span id="line-72"> return wals;</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 WAL getWAL(RegionInfo region) throws IOException {</span>
<span class="source-line-no">077</span><span id="line-77"> return disabled;</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"> @Override</span>
<span class="source-line-no">081</span><span id="line-81"> public void close() throws IOException {</span>
<span class="source-line-no">082</span><span id="line-82"> disabled.close();</span>
<span class="source-line-no">083</span><span id="line-83"> }</span>
<span class="source-line-no">084</span><span id="line-84"></span>
<span class="source-line-no">085</span><span id="line-85"> @Override</span>
<span class="source-line-no">086</span><span id="line-86"> public void shutdown() throws IOException {</span>
<span class="source-line-no">087</span><span id="line-87"> disabled.shutdown();</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"> private static class DisabledWAL implements WAL {</span>
<span class="source-line-no">091</span><span id="line-91"> protected final List&lt;WALActionsListener&gt; listeners = new CopyOnWriteArrayList&lt;&gt;();</span>
<span class="source-line-no">092</span><span id="line-92"> protected final Path path;</span>
<span class="source-line-no">093</span><span id="line-93"> protected final WALCoprocessorHost coprocessorHost;</span>
<span class="source-line-no">094</span><span id="line-94"> protected final AtomicBoolean closed = new AtomicBoolean(false);</span>
<span class="source-line-no">095</span><span id="line-95"></span>
<span class="source-line-no">096</span><span id="line-96"> public DisabledWAL(final Path path, final Configuration conf,</span>
<span class="source-line-no">097</span><span id="line-97"> final List&lt;WALActionsListener&gt; listeners) {</span>
<span class="source-line-no">098</span><span id="line-98"> this.coprocessorHost = new WALCoprocessorHost(this, conf);</span>
<span class="source-line-no">099</span><span id="line-99"> this.path = path;</span>
<span class="source-line-no">100</span><span id="line-100"> if (null != listeners) {</span>
<span class="source-line-no">101</span><span id="line-101"> for (WALActionsListener listener : listeners) {</span>
<span class="source-line-no">102</span><span id="line-102"> registerWALActionsListener(listener);</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"> }</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"> public void registerWALActionsListener(final WALActionsListener listener) {</span>
<span class="source-line-no">109</span><span id="line-109"> listeners.add(listener);</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>
<span class="source-line-no">112</span><span id="line-112"> @Override</span>
<span class="source-line-no">113</span><span id="line-113"> public boolean unregisterWALActionsListener(final WALActionsListener listener) {</span>
<span class="source-line-no">114</span><span id="line-114"> return listeners.remove(listener);</span>
<span class="source-line-no">115</span><span id="line-115"> }</span>
<span class="source-line-no">116</span><span id="line-116"></span>
<span class="source-line-no">117</span><span id="line-117"> @Override</span>
<span class="source-line-no">118</span><span id="line-118"> public Map&lt;byte[], List&lt;byte[]&gt;&gt; rollWriter() {</span>
<span class="source-line-no">119</span><span id="line-119"> if (!listeners.isEmpty()) {</span>
<span class="source-line-no">120</span><span id="line-120"> for (WALActionsListener listener : listeners) {</span>
<span class="source-line-no">121</span><span id="line-121"> listener.logRollRequested(WALActionsListener.RollRequestReason.ERROR);</span>
<span class="source-line-no">122</span><span id="line-122"> }</span>
<span class="source-line-no">123</span><span id="line-123"> for (WALActionsListener listener : listeners) {</span>
<span class="source-line-no">124</span><span id="line-124"> try {</span>
<span class="source-line-no">125</span><span id="line-125"> listener.preLogRoll(path, path);</span>
<span class="source-line-no">126</span><span id="line-126"> } catch (IOException exception) {</span>
<span class="source-line-no">127</span><span id="line-127"> LOG.debug("Ignoring exception from listener.", exception);</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"> for (WALActionsListener listener : listeners) {</span>
<span class="source-line-no">131</span><span id="line-131"> try {</span>
<span class="source-line-no">132</span><span id="line-132"> listener.postLogRoll(path, path);</span>
<span class="source-line-no">133</span><span id="line-133"> } catch (IOException exception) {</span>
<span class="source-line-no">134</span><span id="line-134"> LOG.debug("Ignoring exception from listener.", exception);</span>
<span class="source-line-no">135</span><span id="line-135"> }</span>
<span class="source-line-no">136</span><span id="line-136"> }</span>
<span class="source-line-no">137</span><span id="line-137"> }</span>
<span class="source-line-no">138</span><span id="line-138"> return null;</span>
<span class="source-line-no">139</span><span id="line-139"> }</span>
<span class="source-line-no">140</span><span id="line-140"></span>
<span class="source-line-no">141</span><span id="line-141"> @Override</span>
<span class="source-line-no">142</span><span id="line-142"> public Map&lt;byte[], List&lt;byte[]&gt;&gt; rollWriter(boolean force) {</span>
<span class="source-line-no">143</span><span id="line-143"> return rollWriter();</span>
<span class="source-line-no">144</span><span id="line-144"> }</span>
<span class="source-line-no">145</span><span id="line-145"></span>
<span class="source-line-no">146</span><span id="line-146"> @Override</span>
<span class="source-line-no">147</span><span id="line-147"> public void shutdown() {</span>
<span class="source-line-no">148</span><span id="line-148"> if (closed.compareAndSet(false, true)) {</span>
<span class="source-line-no">149</span><span id="line-149"> if (!this.listeners.isEmpty()) {</span>
<span class="source-line-no">150</span><span id="line-150"> for (WALActionsListener listener : this.listeners) {</span>
<span class="source-line-no">151</span><span id="line-151"> listener.logCloseRequested();</span>
<span class="source-line-no">152</span><span id="line-152"> }</span>
<span class="source-line-no">153</span><span id="line-153"> }</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"></span>
<span class="source-line-no">157</span><span id="line-157"> @Override</span>
<span class="source-line-no">158</span><span id="line-158"> public void close() {</span>
<span class="source-line-no">159</span><span id="line-159"> shutdown();</span>
<span class="source-line-no">160</span><span id="line-160"> }</span>
<span class="source-line-no">161</span><span id="line-161"></span>
<span class="source-line-no">162</span><span id="line-162"> @Override</span>
<span class="source-line-no">163</span><span id="line-163"> public long appendData(RegionInfo info, WALKeyImpl key, WALEdit edits) throws IOException {</span>
<span class="source-line-no">164</span><span id="line-164"> return append(info, key, edits, true);</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"> @Override</span>
<span class="source-line-no">168</span><span id="line-168"> public long appendMarker(RegionInfo info, WALKeyImpl key, WALEdit edits) throws IOException {</span>
<span class="source-line-no">169</span><span id="line-169"> return append(info, key, edits, false);</span>
<span class="source-line-no">170</span><span id="line-170"> }</span>
<span class="source-line-no">171</span><span id="line-171"></span>
<span class="source-line-no">172</span><span id="line-172"> private long append(RegionInfo info, WALKeyImpl key, WALEdit edits, boolean inMemstore)</span>
<span class="source-line-no">173</span><span id="line-173"> throws IOException {</span>
<span class="source-line-no">174</span><span id="line-174"> WriteEntry writeEntry = key.getMvcc().begin();</span>
<span class="source-line-no">175</span><span id="line-175"> if (!edits.isReplay()) {</span>
<span class="source-line-no">176</span><span id="line-176"> for (Cell cell : edits.getCells()) {</span>
<span class="source-line-no">177</span><span id="line-177"> PrivateCellUtil.setSequenceId(cell, writeEntry.getWriteNumber());</span>
<span class="source-line-no">178</span><span id="line-178"> }</span>
<span class="source-line-no">179</span><span id="line-179"> }</span>
<span class="source-line-no">180</span><span id="line-180"> key.setWriteEntry(writeEntry);</span>
<span class="source-line-no">181</span><span id="line-181"> if (!this.listeners.isEmpty()) {</span>
<span class="source-line-no">182</span><span id="line-182"> final long start = System.nanoTime();</span>
<span class="source-line-no">183</span><span id="line-183"> long len = 0;</span>
<span class="source-line-no">184</span><span id="line-184"> for (Cell cell : edits.getCells()) {</span>
<span class="source-line-no">185</span><span id="line-185"> len += PrivateCellUtil.estimatedSerializedSizeOf(cell);</span>
<span class="source-line-no">186</span><span id="line-186"> }</span>
<span class="source-line-no">187</span><span id="line-187"> final long elapsed = (System.nanoTime() - start) / 1000000L;</span>
<span class="source-line-no">188</span><span id="line-188"> for (WALActionsListener listener : this.listeners) {</span>
<span class="source-line-no">189</span><span id="line-189"> listener.postAppend(len, elapsed, key, edits);</span>
<span class="source-line-no">190</span><span id="line-190"> }</span>
<span class="source-line-no">191</span><span id="line-191"> }</span>
<span class="source-line-no">192</span><span id="line-192"> return -1;</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"> @Override</span>
<span class="source-line-no">196</span><span id="line-196"> public void updateStore(byte[] encodedRegionName, byte[] familyName, Long sequenceid,</span>
<span class="source-line-no">197</span><span id="line-197"> boolean onlyIfGreater) {</span>
<span class="source-line-no">198</span><span id="line-198"> return;</span>
<span class="source-line-no">199</span><span id="line-199"> }</span>
<span class="source-line-no">200</span><span id="line-200"></span>
<span class="source-line-no">201</span><span id="line-201"> @Override</span>
<span class="source-line-no">202</span><span id="line-202"> public void sync() {</span>
<span class="source-line-no">203</span><span id="line-203"> if (!this.listeners.isEmpty()) {</span>
<span class="source-line-no">204</span><span id="line-204"> for (WALActionsListener listener : this.listeners) {</span>
<span class="source-line-no">205</span><span id="line-205"> listener.postSync(0L, 0);</span>
<span class="source-line-no">206</span><span id="line-206"> }</span>
<span class="source-line-no">207</span><span id="line-207"> }</span>
<span class="source-line-no">208</span><span id="line-208"> }</span>
<span class="source-line-no">209</span><span id="line-209"></span>
<span class="source-line-no">210</span><span id="line-210"> @Override</span>
<span class="source-line-no">211</span><span id="line-211"> public void sync(long txid) {</span>
<span class="source-line-no">212</span><span id="line-212"> sync();</span>
<span class="source-line-no">213</span><span id="line-213"> }</span>
<span class="source-line-no">214</span><span id="line-214"></span>
<span class="source-line-no">215</span><span id="line-215"> @Override</span>
<span class="source-line-no">216</span><span id="line-216"> public Long startCacheFlush(final byte[] encodedRegionName,</span>
<span class="source-line-no">217</span><span id="line-217"> Map&lt;byte[], Long&gt; flushedFamilyNamesToSeq) {</span>
<span class="source-line-no">218</span><span id="line-218"> return startCacheFlush(encodedRegionName, flushedFamilyNamesToSeq.keySet());</span>
<span class="source-line-no">219</span><span id="line-219"> }</span>
<span class="source-line-no">220</span><span id="line-220"></span>
<span class="source-line-no">221</span><span id="line-221"> @Override</span>
<span class="source-line-no">222</span><span id="line-222"> public Long startCacheFlush(final byte[] encodedRegionName, Set&lt;byte[]&gt; flushedFamilyNames) {</span>
<span class="source-line-no">223</span><span id="line-223"> if (closed.get()) return null;</span>
<span class="source-line-no">224</span><span id="line-224"> return HConstants.NO_SEQNUM;</span>
<span class="source-line-no">225</span><span id="line-225"> }</span>
<span class="source-line-no">226</span><span id="line-226"></span>
<span class="source-line-no">227</span><span id="line-227"> @Override</span>
<span class="source-line-no">228</span><span id="line-228"> public void completeCacheFlush(final byte[] encodedRegionName, long maxFlushedSeqId) {</span>
<span class="source-line-no">229</span><span id="line-229"> }</span>
<span class="source-line-no">230</span><span id="line-230"></span>
<span class="source-line-no">231</span><span id="line-231"> @Override</span>
<span class="source-line-no">232</span><span id="line-232"> public void abortCacheFlush(byte[] encodedRegionName) {</span>
<span class="source-line-no">233</span><span id="line-233"> }</span>
<span class="source-line-no">234</span><span id="line-234"></span>
<span class="source-line-no">235</span><span id="line-235"> @Override</span>
<span class="source-line-no">236</span><span id="line-236"> public WALCoprocessorHost getCoprocessorHost() {</span>
<span class="source-line-no">237</span><span id="line-237"> return coprocessorHost;</span>
<span class="source-line-no">238</span><span id="line-238"> }</span>
<span class="source-line-no">239</span><span id="line-239"></span>
<span class="source-line-no">240</span><span id="line-240"> @Override</span>
<span class="source-line-no">241</span><span id="line-241"> public long getEarliestMemStoreSeqNum(byte[] encodedRegionName, byte[] familyName) {</span>
<span class="source-line-no">242</span><span id="line-242"> return HConstants.NO_SEQNUM;</span>
<span class="source-line-no">243</span><span id="line-243"> }</span>
<span class="source-line-no">244</span><span id="line-244"></span>
<span class="source-line-no">245</span><span id="line-245"> @Override</span>
<span class="source-line-no">246</span><span id="line-246"> public String toString() {</span>
<span class="source-line-no">247</span><span id="line-247"> return "WAL disabled.";</span>
<span class="source-line-no">248</span><span id="line-248"> }</span>
<span class="source-line-no">249</span><span id="line-249"></span>
<span class="source-line-no">250</span><span id="line-250"> @Override</span>
<span class="source-line-no">251</span><span id="line-251"> public OptionalLong getLogFileSizeIfBeingWritten(Path path) {</span>
<span class="source-line-no">252</span><span id="line-252"> return OptionalLong.empty();</span>
<span class="source-line-no">253</span><span id="line-253"> }</span>
<span class="source-line-no">254</span><span id="line-254"> }</span>
<span class="source-line-no">255</span><span id="line-255"></span>
<span class="source-line-no">256</span><span id="line-256"> @Override</span>
<span class="source-line-no">257</span><span id="line-257"> public long getNumLogFiles() {</span>
<span class="source-line-no">258</span><span id="line-258"> return 0;</span>
<span class="source-line-no">259</span><span id="line-259"> }</span>
<span class="source-line-no">260</span><span id="line-260"></span>
<span class="source-line-no">261</span><span id="line-261"> @Override</span>
<span class="source-line-no">262</span><span id="line-262"> public long getLogFileSize() {</span>
<span class="source-line-no">263</span><span id="line-263"> return 0;</span>
<span class="source-line-no">264</span><span id="line-264"> }</span>
<span class="source-line-no">265</span><span id="line-265"></span>
<span class="source-line-no">266</span><span id="line-266"> @Override</span>
<span class="source-line-no">267</span><span id="line-267"> public void addWALActionsListener(WALActionsListener listener) {</span>
<span class="source-line-no">268</span><span id="line-268"> disabled.registerWALActionsListener(listener);</span>
<span class="source-line-no">269</span><span id="line-269"> }</span>
<span class="source-line-no">270</span><span id="line-270">}</span>
</pre>
</div>
</main>
</body>
</html>