| <!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, class: Reference"> |
| <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;</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.BufferedInputStream;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.io.DataInput;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.io.DataInputStream;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.io.IOException;</span> |
| <span class="source-line-no">024</span><span id="line-24">import java.io.InputStream;</span> |
| <span class="source-line-no">025</span><span id="line-25">import java.util.Arrays;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.commons.io.IOUtils;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.fs.FSDataOutputStream;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.fs.FileSystem;</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.KeyValueUtil;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.util.Bytes;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">033</span><span id="line-33"></span> |
| <span class="source-line-no">034</span><span id="line-34">import org.apache.hbase.thirdparty.com.google.protobuf.UnsafeByteOperations;</span> |
| <span class="source-line-no">035</span><span id="line-35"></span> |
| <span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.shaded.protobuf.ProtobufUtil;</span> |
| <span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.shaded.protobuf.generated.FSProtos;</span> |
| <span class="source-line-no">038</span><span id="line-38"></span> |
| <span class="source-line-no">039</span><span id="line-39">/**</span> |
| <span class="source-line-no">040</span><span id="line-40"> * A reference to the top or bottom half of a store file where 'bottom' is the first half of the</span> |
| <span class="source-line-no">041</span><span id="line-41"> * file containing the keys that sort lowest and 'top' is the second half of the file with keys that</span> |
| <span class="source-line-no">042</span><span id="line-42"> * sort greater than those of the bottom half. The file referenced lives under a different region.</span> |
| <span class="source-line-no">043</span><span id="line-43"> * References are made at region split time.</span> |
| <span class="source-line-no">044</span><span id="line-44"> * <p></span> |
| <span class="source-line-no">045</span><span id="line-45"> * References work with a special half store file type. References know how to write out the</span> |
| <span class="source-line-no">046</span><span id="line-46"> * reference format in the file system and are what is juggled when references are mixed in with</span> |
| <span class="source-line-no">047</span><span id="line-47"> * direct store files. The half store file type is used reading the referred to file.</span> |
| <span class="source-line-no">048</span><span id="line-48"> * <p></span> |
| <span class="source-line-no">049</span><span id="line-49"> * References to store files located over in some other region look like this in the file system</span> |
| <span class="source-line-no">050</span><span id="line-50"> * <code>1278437856009925445.3323223323</code>: i.e. an id followed by hash of the referenced</span> |
| <span class="source-line-no">051</span><span id="line-51"> * region. Note, a region is itself not splittable if it has instances of store file references.</span> |
| <span class="source-line-no">052</span><span id="line-52"> * References are cleaned up by compactions.</span> |
| <span class="source-line-no">053</span><span id="line-53"> */</span> |
| <span class="source-line-no">054</span><span id="line-54">@InterfaceAudience.Private</span> |
| <span class="source-line-no">055</span><span id="line-55">public class Reference {</span> |
| <span class="source-line-no">056</span><span id="line-56"> private byte[] splitkey;</span> |
| <span class="source-line-no">057</span><span id="line-57"> private Range region;</span> |
| <span class="source-line-no">058</span><span id="line-58"></span> |
| <span class="source-line-no">059</span><span id="line-59"> /**</span> |
| <span class="source-line-no">060</span><span id="line-60"> * For split HStoreFiles, it specifies if the file covers the lower half or the upper half of the</span> |
| <span class="source-line-no">061</span><span id="line-61"> * key range</span> |
| <span class="source-line-no">062</span><span id="line-62"> */</span> |
| <span class="source-line-no">063</span><span id="line-63"> static enum Range {</span> |
| <span class="source-line-no">064</span><span id="line-64"> /** HStoreFile contains upper half of key range */</span> |
| <span class="source-line-no">065</span><span id="line-65"> top,</span> |
| <span class="source-line-no">066</span><span id="line-66"> /** HStoreFile contains lower half of key range */</span> |
| <span class="source-line-no">067</span><span id="line-67"> bottom</span> |
| <span class="source-line-no">068</span><span id="line-68"> }</span> |
| <span class="source-line-no">069</span><span id="line-69"></span> |
| <span class="source-line-no">070</span><span id="line-70"> /** Returns A {@link Reference} that points at top half of a an hfile */</span> |
| <span class="source-line-no">071</span><span id="line-71"> public static Reference createTopReference(final byte[] splitRow) {</span> |
| <span class="source-line-no">072</span><span id="line-72"> return new Reference(splitRow, Range.top);</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"> /** Returns A {@link Reference} that points at the bottom half of a an hfile */</span> |
| <span class="source-line-no">076</span><span id="line-76"> public static Reference createBottomReference(final byte[] splitRow) {</span> |
| <span class="source-line-no">077</span><span id="line-77"> return new Reference(splitRow, Range.bottom);</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"> /**</span> |
| <span class="source-line-no">081</span><span id="line-81"> * Constructor</span> |
| <span class="source-line-no">082</span><span id="line-82"> * @param splitRow This is row we are splitting around.</span> |
| <span class="source-line-no">083</span><span id="line-83"> */</span> |
| <span class="source-line-no">084</span><span id="line-84"> Reference(final byte[] splitRow, final Range fr) {</span> |
| <span class="source-line-no">085</span><span id="line-85"> this.splitkey = splitRow == null ? null : KeyValueUtil.createFirstOnRow(splitRow).getKey();</span> |
| <span class="source-line-no">086</span><span id="line-86"> this.region = fr;</span> |
| <span class="source-line-no">087</span><span id="line-87"> }</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"> * Used by serializations.</span> |
| <span class="source-line-no">091</span><span id="line-91"> * @deprecated need by pb serialization</span> |
| <span class="source-line-no">092</span><span id="line-92"> */</span> |
| <span class="source-line-no">093</span><span id="line-93"> @Deprecated</span> |
| <span class="source-line-no">094</span><span id="line-94"> // Make this private when it comes time to let go of this constructor.</span> |
| <span class="source-line-no">095</span><span id="line-95"> // Needed by pb serialization.</span> |
| <span class="source-line-no">096</span><span id="line-96"> public Reference() {</span> |
| <span class="source-line-no">097</span><span id="line-97"> this(null, Range.bottom);</span> |
| <span class="source-line-no">098</span><span id="line-98"> }</span> |
| <span class="source-line-no">099</span><span id="line-99"></span> |
| <span class="source-line-no">100</span><span id="line-100"> /**</span> |
| <span class="source-line-no">101</span><span id="line-101"> * */</span> |
| <span class="source-line-no">102</span><span id="line-102"> public Range getFileRegion() {</span> |
| <span class="source-line-no">103</span><span id="line-103"> return this.region;</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"> * */</span> |
| <span class="source-line-no">108</span><span id="line-108"> public byte[] getSplitKey() {</span> |
| <span class="source-line-no">109</span><span id="line-109"> return splitkey;</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"> /**</span> |
| <span class="source-line-no">113</span><span id="line-113"> * @see java.lang.Object#toString()</span> |
| <span class="source-line-no">114</span><span id="line-114"> */</span> |
| <span class="source-line-no">115</span><span id="line-115"> @Override</span> |
| <span class="source-line-no">116</span><span id="line-116"> public String toString() {</span> |
| <span class="source-line-no">117</span><span id="line-117"> return "" + this.region;</span> |
| <span class="source-line-no">118</span><span id="line-118"> }</span> |
| <span class="source-line-no">119</span><span id="line-119"></span> |
| <span class="source-line-no">120</span><span id="line-120"> public static boolean isTopFileRegion(final Range r) {</span> |
| <span class="source-line-no">121</span><span id="line-121"> return r.equals(Range.top);</span> |
| <span class="source-line-no">122</span><span id="line-122"> }</span> |
| <span class="source-line-no">123</span><span id="line-123"></span> |
| <span class="source-line-no">124</span><span id="line-124"> /**</span> |
| <span class="source-line-no">125</span><span id="line-125"> * @deprecated Writables are going away. Use the pb serialization methods instead. Remove in a</span> |
| <span class="source-line-no">126</span><span id="line-126"> * release after 0.96 goes out. This is here only to migrate old Reference files</span> |
| <span class="source-line-no">127</span><span id="line-127"> * written with Writables before 0.96.</span> |
| <span class="source-line-no">128</span><span id="line-128"> */</span> |
| <span class="source-line-no">129</span><span id="line-129"> @Deprecated</span> |
| <span class="source-line-no">130</span><span id="line-130"> public void readFields(DataInput in) throws IOException {</span> |
| <span class="source-line-no">131</span><span id="line-131"> boolean tmp = in.readBoolean();</span> |
| <span class="source-line-no">132</span><span id="line-132"> // If true, set region to top.</span> |
| <span class="source-line-no">133</span><span id="line-133"> this.region = tmp ? Range.top : Range.bottom;</span> |
| <span class="source-line-no">134</span><span id="line-134"> this.splitkey = Bytes.readByteArray(in);</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"> public Path write(final FileSystem fs, final Path p) throws IOException {</span> |
| <span class="source-line-no">138</span><span id="line-138"> FSDataOutputStream out = fs.create(p, false);</span> |
| <span class="source-line-no">139</span><span id="line-139"> try {</span> |
| <span class="source-line-no">140</span><span id="line-140"> out.write(toByteArray());</span> |
| <span class="source-line-no">141</span><span id="line-141"> } finally {</span> |
| <span class="source-line-no">142</span><span id="line-142"> out.close();</span> |
| <span class="source-line-no">143</span><span id="line-143"> }</span> |
| <span class="source-line-no">144</span><span id="line-144"> return p;</span> |
| <span class="source-line-no">145</span><span id="line-145"> }</span> |
| <span class="source-line-no">146</span><span id="line-146"></span> |
| <span class="source-line-no">147</span><span id="line-147"> /**</span> |
| <span class="source-line-no">148</span><span id="line-148"> * Read a Reference from FileSystem.</span> |
| <span class="source-line-no">149</span><span id="line-149"> * @return New Reference made from passed <code>p</code></span> |
| <span class="source-line-no">150</span><span id="line-150"> */</span> |
| <span class="source-line-no">151</span><span id="line-151"> public static Reference read(final FileSystem fs, final Path p) throws IOException {</span> |
| <span class="source-line-no">152</span><span id="line-152"> InputStream in = fs.open(p);</span> |
| <span class="source-line-no">153</span><span id="line-153"> try {</span> |
| <span class="source-line-no">154</span><span id="line-154"> // I need to be able to move back in the stream if this is not a pb serialization so I can</span> |
| <span class="source-line-no">155</span><span id="line-155"> // do the Writable decoding instead.</span> |
| <span class="source-line-no">156</span><span id="line-156"> in = in.markSupported() ? in : new BufferedInputStream(in);</span> |
| <span class="source-line-no">157</span><span id="line-157"> int pblen = ProtobufUtil.lengthOfPBMagic();</span> |
| <span class="source-line-no">158</span><span id="line-158"> in.mark(pblen);</span> |
| <span class="source-line-no">159</span><span id="line-159"> byte[] pbuf = new byte[pblen];</span> |
| <span class="source-line-no">160</span><span id="line-160"> IOUtils.readFully(in, pbuf, 0, pblen);</span> |
| <span class="source-line-no">161</span><span id="line-161"> // WATCHOUT! Return in middle of function!!!</span> |
| <span class="source-line-no">162</span><span id="line-162"> if (ProtobufUtil.isPBMagicPrefix(pbuf)) return convert(FSProtos.Reference.parseFrom(in));</span> |
| <span class="source-line-no">163</span><span id="line-163"> // Else presume Writables. Need to reset the stream since it didn't start w/ pb.</span> |
| <span class="source-line-no">164</span><span id="line-164"> // We won't bother rewriting thie Reference as a pb since Reference is transitory.</span> |
| <span class="source-line-no">165</span><span id="line-165"> in.reset();</span> |
| <span class="source-line-no">166</span><span id="line-166"> Reference r = new Reference();</span> |
| <span class="source-line-no">167</span><span id="line-167"> DataInputStream dis = new DataInputStream(in);</span> |
| <span class="source-line-no">168</span><span id="line-168"> // Set in = dis so it gets the close below in the finally on our way out.</span> |
| <span class="source-line-no">169</span><span id="line-169"> in = dis;</span> |
| <span class="source-line-no">170</span><span id="line-170"> r.readFields(dis);</span> |
| <span class="source-line-no">171</span><span id="line-171"> return r;</span> |
| <span class="source-line-no">172</span><span id="line-172"> } finally {</span> |
| <span class="source-line-no">173</span><span id="line-173"> in.close();</span> |
| <span class="source-line-no">174</span><span id="line-174"> }</span> |
| <span class="source-line-no">175</span><span id="line-175"> }</span> |
| <span class="source-line-no">176</span><span id="line-176"></span> |
| <span class="source-line-no">177</span><span id="line-177"> public FSProtos.Reference convert() {</span> |
| <span class="source-line-no">178</span><span id="line-178"> FSProtos.Reference.Builder builder = FSProtos.Reference.newBuilder();</span> |
| <span class="source-line-no">179</span><span id="line-179"> builder.setRange(isTopFileRegion(getFileRegion())</span> |
| <span class="source-line-no">180</span><span id="line-180"> ? FSProtos.Reference.Range.TOP</span> |
| <span class="source-line-no">181</span><span id="line-181"> : FSProtos.Reference.Range.BOTTOM);</span> |
| <span class="source-line-no">182</span><span id="line-182"> builder.setSplitkey(UnsafeByteOperations.unsafeWrap(getSplitKey()));</span> |
| <span class="source-line-no">183</span><span id="line-183"> return builder.build();</span> |
| <span class="source-line-no">184</span><span id="line-184"> }</span> |
| <span class="source-line-no">185</span><span id="line-185"></span> |
| <span class="source-line-no">186</span><span id="line-186"> public static Reference convert(final FSProtos.Reference r) {</span> |
| <span class="source-line-no">187</span><span id="line-187"> Reference result = new Reference();</span> |
| <span class="source-line-no">188</span><span id="line-188"> result.splitkey = r.getSplitkey().toByteArray();</span> |
| <span class="source-line-no">189</span><span id="line-189"> result.region = r.getRange() == FSProtos.Reference.Range.TOP ? Range.top : Range.bottom;</span> |
| <span class="source-line-no">190</span><span id="line-190"> return result;</span> |
| <span class="source-line-no">191</span><span id="line-191"> }</span> |
| <span class="source-line-no">192</span><span id="line-192"></span> |
| <span class="source-line-no">193</span><span id="line-193"> /**</span> |
| <span class="source-line-no">194</span><span id="line-194"> * Use this when writing to a stream and you want to use the pb mergeDelimitedFrom (w/o the</span> |
| <span class="source-line-no">195</span><span id="line-195"> * delimiter, pb reads to EOF which may not be what you want).</span> |
| <span class="source-line-no">196</span><span id="line-196"> * @return This instance serialized as a delimited protobuf w/ a magic pb prefix.</span> |
| <span class="source-line-no">197</span><span id="line-197"> */</span> |
| <span class="source-line-no">198</span><span id="line-198"> byte[] toByteArray() throws IOException {</span> |
| <span class="source-line-no">199</span><span id="line-199"> return ProtobufUtil.prependPBMagic(convert().toByteArray());</span> |
| <span class="source-line-no">200</span><span id="line-200"> }</span> |
| <span class="source-line-no">201</span><span id="line-201"></span> |
| <span class="source-line-no">202</span><span id="line-202"> @Override</span> |
| <span class="source-line-no">203</span><span id="line-203"> public int hashCode() {</span> |
| <span class="source-line-no">204</span><span id="line-204"> return Arrays.hashCode(splitkey) + region.hashCode();</span> |
| <span class="source-line-no">205</span><span id="line-205"> }</span> |
| <span class="source-line-no">206</span><span id="line-206"></span> |
| <span class="source-line-no">207</span><span id="line-207"> @Override</span> |
| <span class="source-line-no">208</span><span id="line-208"> public boolean equals(Object o) {</span> |
| <span class="source-line-no">209</span><span id="line-209"> if (this == o) return true;</span> |
| <span class="source-line-no">210</span><span id="line-210"> if (o == null) return false;</span> |
| <span class="source-line-no">211</span><span id="line-211"> if (!(o instanceof Reference)) return false;</span> |
| <span class="source-line-no">212</span><span id="line-212"></span> |
| <span class="source-line-no">213</span><span id="line-213"> Reference r = (Reference) o;</span> |
| <span class="source-line-no">214</span><span id="line-214"> if (splitkey != null && r.splitkey == null) return false;</span> |
| <span class="source-line-no">215</span><span id="line-215"> if (splitkey == null && r.splitkey != null) return false;</span> |
| <span class="source-line-no">216</span><span id="line-216"> if (splitkey != null && !Arrays.equals(splitkey, r.splitkey)) return false;</span> |
| <span class="source-line-no">217</span><span id="line-217"></span> |
| <span class="source-line-no">218</span><span id="line-218"> return region.equals(r.region);</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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
