Google Git
Sign in
apache / hbase-site / 2e3aaee18b357604e6f6797bafb8e59d3025ccb0 / . / devapidocs / src-html / org / apache / hadoop / hbase / regionserver / wal / FSWALEntry.html
blob: 1b70a98ed862c9d1bff6fe70967ca444cc3c7314 [file] [log] [blame]
<!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.regionserver.wal;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.Collections;<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.Set;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.TreeSet;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.Cell;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.CellUtil;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.PrivateCellUtil;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.client.RegionInfo;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.ipc.ServerCall;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.regionserver.MultiVersionConcurrencyControl;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.wal.WAL.Entry;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.wal.WALEdit;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.wal.WALKeyImpl;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hbase.thirdparty.com.google.common.annotations.VisibleForTesting;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.hbase.thirdparty.org.apache.commons.collections4.CollectionUtils;<a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span>/**<a name="line.40"></a>
<span class="sourceLineNo">041</span> * A WAL Entry for {@link AbstractFSWAL} implementation. Immutable.<a name="line.41"></a>
<span class="sourceLineNo">042</span> * A subclass of {@link Entry} that carries extra info across the ring buffer such as<a name="line.42"></a>
<span class="sourceLineNo">043</span> * region sequenceid (we want to use this later, just before we write the WAL to ensure region<a name="line.43"></a>
<span class="sourceLineNo">044</span> * edits maintain order). The extra info added here is not 'serialized' as part of the WALEdit<a name="line.44"></a>
<span class="sourceLineNo">045</span> * hence marked 'transient' to underline this fact. It also adds mechanism so we can wait on<a name="line.45"></a>
<span class="sourceLineNo">046</span> * the assign of the region sequence id. See #stampRegionSequenceId().<a name="line.46"></a>
<span class="sourceLineNo">047</span> */<a name="line.47"></a>
<span class="sourceLineNo">048</span>@InterfaceAudience.Private<a name="line.48"></a>
<span class="sourceLineNo">049</span>class FSWALEntry extends Entry {<a name="line.49"></a>
<span class="sourceLineNo">050</span> // The below data members are denoted 'transient' just to highlight these are not persisted;<a name="line.50"></a>
<span class="sourceLineNo">051</span> // they are only in memory and held here while passing over the ring buffer.<a name="line.51"></a>
<span class="sourceLineNo">052</span> private final transient long txid;<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> * If false, means this is a meta edit written by the hbase system itself. It was not in<a name="line.55"></a>
<span class="sourceLineNo">056</span> * memstore. HBase uses these edit types to note in the log operational transitions such<a name="line.56"></a>
<span class="sourceLineNo">057</span> * as compactions, flushes, or region open/closes.<a name="line.57"></a>
<span class="sourceLineNo">058</span> */<a name="line.58"></a>
<span class="sourceLineNo">059</span> private final transient boolean inMemstore;<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> /**<a name="line.61"></a>
<span class="sourceLineNo">062</span> * Set if this is a meta edit and it is of close region type.<a name="line.62"></a>
<span class="sourceLineNo">063</span> */<a name="line.63"></a>
<span class="sourceLineNo">064</span> private final transient boolean closeRegion;<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span> private final transient RegionInfo regionInfo;<a name="line.66"></a>
<span class="sourceLineNo">067</span> private final transient Set&lt;byte[]&gt; familyNames;<a name="line.67"></a>
<span class="sourceLineNo">068</span> private final transient ServerCall&lt;?&gt; rpcCall;<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> * @param inMemstore If true, then this is a data edit, one that came from client. If false, it<a name="line.71"></a>
<span class="sourceLineNo">072</span> * is a meta edit made by the hbase system itself and is for the WAL only.<a name="line.72"></a>
<span class="sourceLineNo">073</span> */<a name="line.73"></a>
<span class="sourceLineNo">074</span> FSWALEntry(final long txid, final WALKeyImpl key, final WALEdit edit, final RegionInfo regionInfo,<a name="line.74"></a>
<span class="sourceLineNo">075</span> final boolean inMemstore, ServerCall&lt;?&gt; rpcCall) {<a name="line.75"></a>
<span class="sourceLineNo">076</span> super(key, edit);<a name="line.76"></a>
<span class="sourceLineNo">077</span> this.inMemstore = inMemstore;<a name="line.77"></a>
<span class="sourceLineNo">078</span> this.closeRegion = !inMemstore &amp;&amp; edit.isRegionCloseMarker();<a name="line.78"></a>
<span class="sourceLineNo">079</span> this.regionInfo = regionInfo;<a name="line.79"></a>
<span class="sourceLineNo">080</span> this.txid = txid;<a name="line.80"></a>
<span class="sourceLineNo">081</span> if (inMemstore) {<a name="line.81"></a>
<span class="sourceLineNo">082</span> // construct familyNames here to reduce the work of log sinker.<a name="line.82"></a>
<span class="sourceLineNo">083</span> Set&lt;byte[]&gt; families = edit.getFamilies();<a name="line.83"></a>
<span class="sourceLineNo">084</span> this.familyNames = families != null ? families : collectFamilies(edit.getCells());<a name="line.84"></a>
<span class="sourceLineNo">085</span> } else {<a name="line.85"></a>
<span class="sourceLineNo">086</span> this.familyNames = Collections.emptySet();<a name="line.86"></a>
<span class="sourceLineNo">087</span> }<a name="line.87"></a>
<span class="sourceLineNo">088</span> this.rpcCall = rpcCall;<a name="line.88"></a>
<span class="sourceLineNo">089</span> if (rpcCall != null) {<a name="line.89"></a>
<span class="sourceLineNo">090</span> rpcCall.retainByWAL();<a name="line.90"></a>
<span class="sourceLineNo">091</span> }<a name="line.91"></a>
<span class="sourceLineNo">092</span> }<a name="line.92"></a>
<span class="sourceLineNo">093</span><a name="line.93"></a>
<span class="sourceLineNo">094</span> @VisibleForTesting<a name="line.94"></a>
<span class="sourceLineNo">095</span> static Set&lt;byte[]&gt; collectFamilies(List&lt;Cell&gt; cells) {<a name="line.95"></a>
<span class="sourceLineNo">096</span> if (CollectionUtils.isEmpty(cells)) {<a name="line.96"></a>
<span class="sourceLineNo">097</span> return Collections.emptySet();<a name="line.97"></a>
<span class="sourceLineNo">098</span> } else {<a name="line.98"></a>
<span class="sourceLineNo">099</span> Set&lt;byte[]&gt; set = new TreeSet&lt;&gt;(Bytes.BYTES_COMPARATOR);<a name="line.99"></a>
<span class="sourceLineNo">100</span> for (Cell cell: cells) {<a name="line.100"></a>
<span class="sourceLineNo">101</span> if (!WALEdit.isMetaEditFamily(cell)) {<a name="line.101"></a>
<span class="sourceLineNo">102</span> set.add(CellUtil.cloneFamily(cell));<a name="line.102"></a>
<span class="sourceLineNo">103</span> }<a name="line.103"></a>
<span class="sourceLineNo">104</span> }<a name="line.104"></a>
<span class="sourceLineNo">105</span> return set;<a name="line.105"></a>
<span class="sourceLineNo">106</span> }<a name="line.106"></a>
<span class="sourceLineNo">107</span> }<a name="line.107"></a>
<span class="sourceLineNo">108</span><a name="line.108"></a>
<span class="sourceLineNo">109</span> @Override<a name="line.109"></a>
<span class="sourceLineNo">110</span> public String toString() {<a name="line.110"></a>
<span class="sourceLineNo">111</span> return "sequence=" + this.txid + ", " + super.toString();<a name="line.111"></a>
<span class="sourceLineNo">112</span> }<a name="line.112"></a>
<span class="sourceLineNo">113</span><a name="line.113"></a>
<span class="sourceLineNo">114</span> boolean isInMemStore() {<a name="line.114"></a>
<span class="sourceLineNo">115</span> return this.inMemstore;<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span> boolean isCloseRegion() {<a name="line.118"></a>
<span class="sourceLineNo">119</span> return closeRegion;<a name="line.119"></a>
<span class="sourceLineNo">120</span> }<a name="line.120"></a>
<span class="sourceLineNo">121</span><a name="line.121"></a>
<span class="sourceLineNo">122</span> RegionInfo getRegionInfo() {<a name="line.122"></a>
<span class="sourceLineNo">123</span> return this.regionInfo;<a name="line.123"></a>
<span class="sourceLineNo">124</span> }<a name="line.124"></a>
<span class="sourceLineNo">125</span><a name="line.125"></a>
<span class="sourceLineNo">126</span> /**<a name="line.126"></a>
<span class="sourceLineNo">127</span> * @return The transaction id of this edit.<a name="line.127"></a>
<span class="sourceLineNo">128</span> */<a name="line.128"></a>
<span class="sourceLineNo">129</span> long getTxid() {<a name="line.129"></a>
<span class="sourceLineNo">130</span> return this.txid;<a name="line.130"></a>
<span class="sourceLineNo">131</span> }<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> * Here is where a WAL edit gets its sequenceid. SIDE-EFFECT is our stamping the sequenceid into<a name="line.134"></a>
<span class="sourceLineNo">135</span> * every Cell AND setting the sequenceid into the MVCC WriteEntry!!!!<a name="line.135"></a>
<span class="sourceLineNo">136</span> * @return The sequenceid we stamped on this edit.<a name="line.136"></a>
<span class="sourceLineNo">137</span> */<a name="line.137"></a>
<span class="sourceLineNo">138</span> long stampRegionSequenceId(MultiVersionConcurrencyControl.WriteEntry we) throws IOException {<a name="line.138"></a>
<span class="sourceLineNo">139</span> long regionSequenceId = we.getWriteNumber();<a name="line.139"></a>
<span class="sourceLineNo">140</span> if (!this.getEdit().isReplay() &amp;&amp; inMemstore) {<a name="line.140"></a>
<span class="sourceLineNo">141</span> for (Cell c : getEdit().getCells()) {<a name="line.141"></a>
<span class="sourceLineNo">142</span> PrivateCellUtil.setSequenceId(c, regionSequenceId);<a name="line.142"></a>
<span class="sourceLineNo">143</span> }<a name="line.143"></a>
<span class="sourceLineNo">144</span> }<a name="line.144"></a>
<span class="sourceLineNo">145</span><a name="line.145"></a>
<span class="sourceLineNo">146</span> getKey().setWriteEntry(we);<a name="line.146"></a>
<span class="sourceLineNo">147</span> return regionSequenceId;<a name="line.147"></a>
<span class="sourceLineNo">148</span> }<a name="line.148"></a>
<span class="sourceLineNo">149</span><a name="line.149"></a>
<span class="sourceLineNo">150</span> /**<a name="line.150"></a>
<span class="sourceLineNo">151</span> * @return the family names which are effected by this edit.<a name="line.151"></a>
<span class="sourceLineNo">152</span> */<a name="line.152"></a>
<span class="sourceLineNo">153</span> Set&lt;byte[]&gt; getFamilyNames() {<a name="line.153"></a>
<span class="sourceLineNo">154</span> return familyNames;<a name="line.154"></a>
<span class="sourceLineNo">155</span> }<a name="line.155"></a>
<span class="sourceLineNo">156</span><a name="line.156"></a>
<span class="sourceLineNo">157</span> void release() {<a name="line.157"></a>
<span class="sourceLineNo">158</span> if (rpcCall != null) {<a name="line.158"></a>
<span class="sourceLineNo">159</span> rpcCall.releaseByWAL();<a name="line.159"></a>
<span class="sourceLineNo">160</span> }<a name="line.160"></a>
<span class="sourceLineNo">161</span> }<a name="line.161"></a>
<span class="sourceLineNo">162</span>}<a name="line.162"></a>
</pre>
</div>
</body>
</html>