blob: d1add5197e5bd19eceaa1c37a0095b18b22642dd [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.io.hfile;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.DataInputStream;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.io.DataOutput;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.io.IOException;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.io.OutputStream;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.nio.ByteBuffer;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.nio.ByteBuff;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>/**<a name="line.29"></a>
<span class="sourceLineNo">030</span> * Various types of HFile blocks. Ordinal values of these enum constants must not be relied upon.<a name="line.30"></a>
<span class="sourceLineNo">031</span> * The values in the enum appear in the order they appear in a version 2 HFile.<a name="line.31"></a>
<span class="sourceLineNo">032</span> */<a name="line.32"></a>
<span class="sourceLineNo">033</span>@InterfaceAudience.Private<a name="line.33"></a>
<span class="sourceLineNo">034</span>@SuppressWarnings("ImmutableEnumChecker")<a name="line.34"></a>
<span class="sourceLineNo">035</span>public enum BlockType {<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span> // Scanned block section<a name="line.37"></a>
<span class="sourceLineNo">038</span><a name="line.38"></a>
<span class="sourceLineNo">039</span> /** Data block, both versions */<a name="line.39"></a>
<span class="sourceLineNo">040</span> DATA("DATABLK*", BlockCategory.DATA),<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span> /** An encoded data block (e.g. with prefix compression), version 2 */<a name="line.42"></a>
<span class="sourceLineNo">043</span> ENCODED_DATA("DATABLKE", BlockCategory.DATA) {<a name="line.43"></a>
<span class="sourceLineNo">044</span> @Override<a name="line.44"></a>
<span class="sourceLineNo">045</span> public int getId() {<a name="line.45"></a>
<span class="sourceLineNo">046</span> return DATA.ordinal();<a name="line.46"></a>
<span class="sourceLineNo">047</span> }<a name="line.47"></a>
<span class="sourceLineNo">048</span> },<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span> /** Version 2 leaf index block. Appears in the data block section */<a name="line.50"></a>
<span class="sourceLineNo">051</span> LEAF_INDEX("IDXLEAF2", BlockCategory.INDEX),<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span> /** Bloom filter block, version 2 */<a name="line.53"></a>
<span class="sourceLineNo">054</span> BLOOM_CHUNK("BLMFBLK2", BlockCategory.BLOOM),<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> // Non-scanned block section<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> /** Meta blocks */<a name="line.58"></a>
<span class="sourceLineNo">059</span> META("METABLKc", BlockCategory.META),<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> /** Intermediate-level version 2 index in the non-data block section */<a name="line.61"></a>
<span class="sourceLineNo">062</span> INTERMEDIATE_INDEX("IDXINTE2", BlockCategory.INDEX),<a name="line.62"></a>
<span class="sourceLineNo">063</span><a name="line.63"></a>
<span class="sourceLineNo">064</span> // Load-on-open section.<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span> /** Root index block, also used for the single-level meta index, version 2 */<a name="line.66"></a>
<span class="sourceLineNo">067</span> ROOT_INDEX("IDXROOT2", BlockCategory.INDEX),<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span> /** File info, version 2 */<a name="line.69"></a>
<span class="sourceLineNo">070</span> FILE_INFO("FILEINF2", BlockCategory.META),<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span> /** General Bloom filter metadata, version 2 */<a name="line.72"></a>
<span class="sourceLineNo">073</span> GENERAL_BLOOM_META("BLMFMET2", BlockCategory.BLOOM),<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span> /** Delete Family Bloom filter metadata, version 2 */<a name="line.75"></a>
<span class="sourceLineNo">076</span> DELETE_FAMILY_BLOOM_META("DFBLMET2", BlockCategory.BLOOM),<a name="line.76"></a>
<span class="sourceLineNo">077</span><a name="line.77"></a>
<span class="sourceLineNo">078</span> // Trailer<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span> /** Fixed file trailer, both versions (always just a magic string) */<a name="line.80"></a>
<span class="sourceLineNo">081</span> TRAILER("TRABLK\"$", BlockCategory.META),<a name="line.81"></a>
<span class="sourceLineNo">082</span><a name="line.82"></a>
<span class="sourceLineNo">083</span> // Legacy blocks<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span> /** Block index magic string in version 1 */<a name="line.85"></a>
<span class="sourceLineNo">086</span> INDEX_V1("IDXBLK)+", BlockCategory.INDEX);<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span> public enum BlockCategory {<a name="line.88"></a>
<span class="sourceLineNo">089</span> DATA,<a name="line.89"></a>
<span class="sourceLineNo">090</span> META,<a name="line.90"></a>
<span class="sourceLineNo">091</span> INDEX,<a name="line.91"></a>
<span class="sourceLineNo">092</span> BLOOM,<a name="line.92"></a>
<span class="sourceLineNo">093</span> ALL_CATEGORIES,<a name="line.93"></a>
<span class="sourceLineNo">094</span> UNKNOWN;<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span> /**<a name="line.96"></a>
<span class="sourceLineNo">097</span> * Throws an exception if the block category passed is the special category meaning "all<a name="line.97"></a>
<span class="sourceLineNo">098</span> * categories".<a name="line.98"></a>
<span class="sourceLineNo">099</span> */<a name="line.99"></a>
<span class="sourceLineNo">100</span> public void expectSpecific() {<a name="line.100"></a>
<span class="sourceLineNo">101</span> if (this == ALL_CATEGORIES) {<a name="line.101"></a>
<span class="sourceLineNo">102</span> throw new IllegalArgumentException(<a name="line.102"></a>
<span class="sourceLineNo">103</span> "Expected a specific block " + "category but got " + this);<a name="line.103"></a>
<span class="sourceLineNo">104</span> }<a name="line.104"></a>
<span class="sourceLineNo">105</span> }<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> public static final int MAGIC_LENGTH = 8;<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span> private final byte[] magic;<a name="line.110"></a>
<span class="sourceLineNo">111</span> private final BlockCategory metricCat;<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span> private BlockType(String magicStr, BlockCategory metricCat) {<a name="line.113"></a>
<span class="sourceLineNo">114</span> magic = Bytes.toBytes(magicStr);<a name="line.114"></a>
<span class="sourceLineNo">115</span> this.metricCat = metricCat;<a name="line.115"></a>
<span class="sourceLineNo">116</span> assert magic.length == MAGIC_LENGTH;<a name="line.116"></a>
<span class="sourceLineNo">117</span> }<a name="line.117"></a>
<span class="sourceLineNo">118</span><a name="line.118"></a>
<span class="sourceLineNo">119</span> /**<a name="line.119"></a>
<span class="sourceLineNo">120</span> * Use this instead of {@link #ordinal()}. They work exactly the same, except DATA and<a name="line.120"></a>
<span class="sourceLineNo">121</span> * ENCODED_DATA get the same id using this method (overridden for {@link #ENCODED_DATA}).<a name="line.121"></a>
<span class="sourceLineNo">122</span> * @return block type id from 0 to the number of block types - 1<a name="line.122"></a>
<span class="sourceLineNo">123</span> */<a name="line.123"></a>
<span class="sourceLineNo">124</span> public int getId() {<a name="line.124"></a>
<span class="sourceLineNo">125</span> // Default implementation, can be overridden for individual enum members.<a name="line.125"></a>
<span class="sourceLineNo">126</span> return ordinal();<a name="line.126"></a>
<span class="sourceLineNo">127</span> }<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span> public void writeToStream(OutputStream out) throws IOException {<a name="line.129"></a>
<span class="sourceLineNo">130</span> out.write(magic);<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> public void write(DataOutput out) throws IOException {<a name="line.133"></a>
<span class="sourceLineNo">134</span> out.write(magic);<a name="line.134"></a>
<span class="sourceLineNo">135</span> }<a name="line.135"></a>
<span class="sourceLineNo">136</span><a name="line.136"></a>
<span class="sourceLineNo">137</span> public void write(ByteBuffer buf) {<a name="line.137"></a>
<span class="sourceLineNo">138</span> buf.put(magic);<a name="line.138"></a>
<span class="sourceLineNo">139</span> }<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span> public void write(ByteBuff buf) {<a name="line.141"></a>
<span class="sourceLineNo">142</span> buf.put(magic);<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> public BlockCategory getCategory() {<a name="line.145"></a>
<span class="sourceLineNo">146</span> return metricCat;<a name="line.146"></a>
<span class="sourceLineNo">147</span> }<a name="line.147"></a>
<span class="sourceLineNo">148</span><a name="line.148"></a>
<span class="sourceLineNo">149</span> public static BlockType parse(byte[] buf, int offset, int length) throws IOException {<a name="line.149"></a>
<span class="sourceLineNo">150</span> if (length != MAGIC_LENGTH) {<a name="line.150"></a>
<span class="sourceLineNo">151</span> throw new IOException(<a name="line.151"></a>
<span class="sourceLineNo">152</span> "Magic record of invalid length: " + Bytes.toStringBinary(buf, offset, length));<a name="line.152"></a>
<span class="sourceLineNo">153</span> }<a name="line.153"></a>
<span class="sourceLineNo">154</span><a name="line.154"></a>
<span class="sourceLineNo">155</span> for (BlockType blockType : values())<a name="line.155"></a>
<span class="sourceLineNo">156</span> if (Bytes.compareTo(blockType.magic, 0, MAGIC_LENGTH, buf, offset, MAGIC_LENGTH) == 0)<a name="line.156"></a>
<span class="sourceLineNo">157</span> return blockType;<a name="line.157"></a>
<span class="sourceLineNo">158</span><a name="line.158"></a>
<span class="sourceLineNo">159</span> throw new IOException(<a name="line.159"></a>
<span class="sourceLineNo">160</span> "Invalid HFile block magic: " + Bytes.toStringBinary(buf, offset, MAGIC_LENGTH));<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>
<span class="sourceLineNo">163</span> public static BlockType read(DataInputStream in) throws IOException {<a name="line.163"></a>
<span class="sourceLineNo">164</span> byte[] buf = new byte[MAGIC_LENGTH];<a name="line.164"></a>
<span class="sourceLineNo">165</span> in.readFully(buf);<a name="line.165"></a>
<span class="sourceLineNo">166</span> return parse(buf, 0, buf.length);<a name="line.166"></a>
<span class="sourceLineNo">167</span> }<a name="line.167"></a>
<span class="sourceLineNo">168</span><a name="line.168"></a>
<span class="sourceLineNo">169</span> public static BlockType read(ByteBuff buf) throws IOException {<a name="line.169"></a>
<span class="sourceLineNo">170</span> byte[] magicBuf = new byte[Math.min(buf.limit() - buf.position(), MAGIC_LENGTH)];<a name="line.170"></a>
<span class="sourceLineNo">171</span> buf.get(magicBuf);<a name="line.171"></a>
<span class="sourceLineNo">172</span> BlockType blockType = parse(magicBuf, 0, magicBuf.length);<a name="line.172"></a>
<span class="sourceLineNo">173</span> // If we got here, we have read exactly MAGIC_LENGTH bytes.<a name="line.173"></a>
<span class="sourceLineNo">174</span> return blockType;<a name="line.174"></a>
<span class="sourceLineNo">175</span> }<a name="line.175"></a>
<span class="sourceLineNo">176</span><a name="line.176"></a>
<span class="sourceLineNo">177</span> /**<a name="line.177"></a>
<span class="sourceLineNo">178</span> * Put the magic record out to the specified byte array position.<a name="line.178"></a>
<span class="sourceLineNo">179</span> * @param bytes the byte array<a name="line.179"></a>
<span class="sourceLineNo">180</span> * @param offset position in the array<a name="line.180"></a>
<span class="sourceLineNo">181</span> * @return incremented offset<a name="line.181"></a>
<span class="sourceLineNo">182</span> */<a name="line.182"></a>
<span class="sourceLineNo">183</span> // System.arraycopy is static native. We can't do anything about this until minimum JDK is 9.<a name="line.183"></a>
<span class="sourceLineNo">184</span> @SuppressWarnings("UnsafeFinalization")<a name="line.184"></a>
<span class="sourceLineNo">185</span> public int put(byte[] bytes, int offset) {<a name="line.185"></a>
<span class="sourceLineNo">186</span> System.arraycopy(magic, 0, bytes, offset, MAGIC_LENGTH);<a name="line.186"></a>
<span class="sourceLineNo">187</span> return offset + MAGIC_LENGTH;<a name="line.187"></a>
<span class="sourceLineNo">188</span> }<a name="line.188"></a>
<span class="sourceLineNo">189</span><a name="line.189"></a>
<span class="sourceLineNo">190</span> /**<a name="line.190"></a>
<span class="sourceLineNo">191</span> * Reads a magic record of the length {@link #MAGIC_LENGTH} from the given stream and expects it<a name="line.191"></a>
<span class="sourceLineNo">192</span> * to match this block type.<a name="line.192"></a>
<span class="sourceLineNo">193</span> */<a name="line.193"></a>
<span class="sourceLineNo">194</span> public void readAndCheck(DataInputStream in) throws IOException {<a name="line.194"></a>
<span class="sourceLineNo">195</span> byte[] buf = new byte[MAGIC_LENGTH];<a name="line.195"></a>
<span class="sourceLineNo">196</span> in.readFully(buf);<a name="line.196"></a>
<span class="sourceLineNo">197</span> if (Bytes.compareTo(buf, magic) != 0) {<a name="line.197"></a>
<span class="sourceLineNo">198</span> throw new IOException("Invalid magic: expected " + Bytes.toStringBinary(magic) + ", got "<a name="line.198"></a>
<span class="sourceLineNo">199</span> + Bytes.toStringBinary(buf));<a name="line.199"></a>
<span class="sourceLineNo">200</span> }<a name="line.200"></a>
<span class="sourceLineNo">201</span> }<a name="line.201"></a>
<span class="sourceLineNo">202</span><a name="line.202"></a>
<span class="sourceLineNo">203</span> /**<a name="line.203"></a>
<span class="sourceLineNo">204</span> * Reads a magic record of the length {@link #MAGIC_LENGTH} from the given byte buffer and expects<a name="line.204"></a>
<span class="sourceLineNo">205</span> * it to match this block type.<a name="line.205"></a>
<span class="sourceLineNo">206</span> */<a name="line.206"></a>
<span class="sourceLineNo">207</span> public void readAndCheck(ByteBuffer in) throws IOException {<a name="line.207"></a>
<span class="sourceLineNo">208</span> byte[] buf = new byte[MAGIC_LENGTH];<a name="line.208"></a>
<span class="sourceLineNo">209</span> in.get(buf);<a name="line.209"></a>
<span class="sourceLineNo">210</span> if (Bytes.compareTo(buf, magic) != 0) {<a name="line.210"></a>
<span class="sourceLineNo">211</span> throw new IOException("Invalid magic: expected " + Bytes.toStringBinary(magic) + ", got "<a name="line.211"></a>
<span class="sourceLineNo">212</span> + Bytes.toStringBinary(buf));<a name="line.212"></a>
<span class="sourceLineNo">213</span> }<a name="line.213"></a>
<span class="sourceLineNo">214</span> }<a name="line.214"></a>
<span class="sourceLineNo">215</span><a name="line.215"></a>
<span class="sourceLineNo">216</span> /** Returns whether this block type is encoded or unencoded data block */<a name="line.216"></a>
<span class="sourceLineNo">217</span> public final boolean isData() {<a name="line.217"></a>
<span class="sourceLineNo">218</span> return this == DATA || this == ENCODED_DATA;<a name="line.218"></a>
<span class="sourceLineNo">219</span> }<a name="line.219"></a>
<span class="sourceLineNo">220</span><a name="line.220"></a>
<span class="sourceLineNo">221</span> /** Returns whether this block category is index */<a name="line.221"></a>
<span class="sourceLineNo">222</span> public final boolean isIndex() {<a name="line.222"></a>
<span class="sourceLineNo">223</span> return this.getCategory() == BlockCategory.INDEX;<a name="line.223"></a>
<span class="sourceLineNo">224</span> }<a name="line.224"></a>
<span class="sourceLineNo">225</span><a name="line.225"></a>
<span class="sourceLineNo">226</span> /** Returns whether this block category is bloom filter */<a name="line.226"></a>
<span class="sourceLineNo">227</span> public final boolean isBloom() {<a name="line.227"></a>
<span class="sourceLineNo">228</span> return this.getCategory() == BlockCategory.BLOOM;<a name="line.228"></a>
<span class="sourceLineNo">229</span> }<a name="line.229"></a>
<span class="sourceLineNo">230</span>}<a name="line.230"></a>
</pre>
</div>
</body>
</html>