| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> */<a name="line.17"></a> |
| <span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.wal;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.Closeable;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.io.IOException;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.List;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.OptionalLong;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.concurrent.CompletableFuture;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.hadoop.conf.Configuration;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.Abortable;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.client.RegionInfo;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.regionserver.wal.AsyncFSWAL;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.regionserver.wal.WALActionsListener;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.replication.regionserver.PeerActionListener;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.replication.regionserver.SyncReplicationPeerInfoProvider;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.replication.regionserver.WALFileLengthProvider;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span><a name="line.34"></a> |
| <span class="sourceLineNo">035</span>/**<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * The Write Ahead Log (WAL) stores all durable edits to the HRegion. This interface provides the<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * entry point for all WAL implementors.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * <p><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * See {@link FSHLogProvider} for an example implementation. A single WALProvider will be used for<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * retrieving multiple WALs in a particular region server and must be threadsafe.<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> */<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>@InterfaceAudience.Private<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>public interface WALProvider {<a name="line.43"></a> |
| <span class="sourceLineNo">044</span><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> /**<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * Set up the provider to create wals. will only be called once per instance.<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * @param factory factory that made us may not be null<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * @param conf may not be null<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * @param providerId differentiate between providers from one factory. may be null<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> */<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> void init(WALFactory factory, Configuration conf, String providerId, Abortable server)<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> throws IOException;<a name="line.52"></a> |
| <span class="sourceLineNo">053</span><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> /**<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * @param region the region which we want to get a WAL for it. Could be null.<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * @return a WAL for writing entries for the given region.<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> */<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> WAL getWAL(RegionInfo region) throws IOException;<a name="line.58"></a> |
| <span class="sourceLineNo">059</span><a name="line.59"></a> |
| <span class="sourceLineNo">060</span> /** Returns the List of WALs that are used by this server */<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> List<WAL> getWALs();<a name="line.61"></a> |
| <span class="sourceLineNo">062</span><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> /**<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * persist outstanding WALs to storage and stop accepting new appends. This method serves as<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * shorthand for sending a sync to every WAL provided by a given implementation. Those WALs will<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * also stop accepting new writes.<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> */<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> void shutdown() throws IOException;<a name="line.68"></a> |
| <span class="sourceLineNo">069</span><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> /**<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * shutdown utstanding WALs and clean up any persisted state. Call this method only when you will<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * not need to replay any of the edits to the WALs from this provider. After this call completes,<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * the underlying resources should have been reclaimed.<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> */<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> void close() throws IOException;<a name="line.75"></a> |
| <span class="sourceLineNo">076</span><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> interface WriterBase extends Closeable {<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> long getLength();<a name="line.78"></a> |
| <span class="sourceLineNo">079</span><a name="line.79"></a> |
| <span class="sourceLineNo">080</span> /**<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * NOTE: We add this method for {@link WALFileLengthProvider} used for replication, considering<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * the case if we use {@link AsyncFSWAL},we write to 3 DNs concurrently, according to the<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * visibility guarantee of HDFS, the data will be available immediately when arriving at DN<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * since all the DNs will be considered as the last one in pipeline. This means replication may<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * read uncommitted data and replicate it to the remote cluster and cause data inconsistency.<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * The method {@link WriterBase#getLength} may return length which just in hdfs client buffer<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * and not successfully synced to HDFS, so we use this method to return the length successfully<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * synced to HDFS and replication thread could only read writing WAL file limited by this<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * length. see also HBASE-14004 and this document for more details:<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * https://docs.google.com/document/d/11AyWtGhItQs6vsLRIx32PwTxmBY3libXwGXI25obVEY/edit#<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * @return byteSize successfully synced to underlying filesystem.<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> */<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> long getSyncedLength();<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> }<a name="line.94"></a> |
| <span class="sourceLineNo">095</span><a name="line.95"></a> |
| <span class="sourceLineNo">096</span> // Writers are used internally. Users outside of the WAL should be relying on the<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> // interface provided by WAL.<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> interface Writer extends WriterBase {<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> void sync(boolean forceSync) throws IOException;<a name="line.99"></a> |
| <span class="sourceLineNo">100</span><a name="line.100"></a> |
| <span class="sourceLineNo">101</span> void append(WAL.Entry entry) throws IOException;<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> }<a name="line.102"></a> |
| <span class="sourceLineNo">103</span><a name="line.103"></a> |
| <span class="sourceLineNo">104</span> interface AsyncWriter extends WriterBase {<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> CompletableFuture<Long> sync(boolean forceSync);<a name="line.105"></a> |
| <span class="sourceLineNo">106</span><a name="line.106"></a> |
| <span class="sourceLineNo">107</span> void append(WAL.Entry entry);<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> }<a name="line.108"></a> |
| <span class="sourceLineNo">109</span><a name="line.109"></a> |
| <span class="sourceLineNo">110</span> /**<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * Get number of the log files this provider is managing<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> */<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> long getNumLogFiles();<a name="line.113"></a> |
| <span class="sourceLineNo">114</span><a name="line.114"></a> |
| <span class="sourceLineNo">115</span> /**<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * Get size of the log files this provider is managing<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> */<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> long getLogFileSize();<a name="line.118"></a> |
| <span class="sourceLineNo">119</span><a name="line.119"></a> |
| <span class="sourceLineNo">120</span> /**<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * Add a {@link WALActionsListener}.<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * <p><a name="line.122"></a> |
| <span class="sourceLineNo">123</span> * Notice that you must call this method before calling {@link #getWAL(RegionInfo)} as this method<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * will not effect the {@link WAL} which has already been created. And as long as we can only it<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * when initialization, it is not thread safe.<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> */<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> void addWALActionsListener(WALActionsListener listener);<a name="line.127"></a> |
| <span class="sourceLineNo">128</span><a name="line.128"></a> |
| <span class="sourceLineNo">129</span> default WALFileLengthProvider getWALFileLengthProvider() {<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> return path -> getWALs().stream().map(w -> w.getLogFileSizeIfBeingWritten(path))<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> .filter(o -> o.isPresent()).findAny().orElse(OptionalLong.empty());<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> }<a name="line.132"></a> |
| <span class="sourceLineNo">133</span><a name="line.133"></a> |
| <span class="sourceLineNo">134</span> // sync replication related<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> default PeerActionListener getPeerActionListener() {<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> return PeerActionListener.DUMMY;<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> }<a name="line.137"></a> |
| <span class="sourceLineNo">138</span><a name="line.138"></a> |
| <span class="sourceLineNo">139</span> default void setSyncReplicationPeerInfoProvider(SyncReplicationPeerInfoProvider provider) {<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> }<a name="line.140"></a> |
| <span class="sourceLineNo">141</span>}<a name="line.141"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
