| <!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.util, class: RotateFile"> |
| <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.util;</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 com.google.errorprone.annotations.RestrictedApi;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.io.EOFException;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.io.FileNotFoundException;</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.util.zip.CRC32;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.fs.FSDataInputStream;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.fs.FSDataOutputStream;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.fs.FileSystem;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.fs.Path;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.slf4j.Logger;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.slf4j.LoggerFactory;</span> |
| <span class="source-line-no">032</span><span id="line-32"></span> |
| <span class="source-line-no">033</span><span id="line-33">import org.apache.hbase.thirdparty.com.google.protobuf.ByteString;</span> |
| <span class="source-line-no">034</span><span id="line-34"></span> |
| <span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos;</span> |
| <span class="source-line-no">036</span><span id="line-36"></span> |
| <span class="source-line-no">037</span><span id="line-37">/**</span> |
| <span class="source-line-no">038</span><span id="line-38"> * A file storage which supports atomic update through two files, i.e, rotating. The implementation</span> |
| <span class="source-line-no">039</span><span id="line-39"> * does not require atomic rename.</span> |
| <span class="source-line-no">040</span><span id="line-40"> */</span> |
| <span class="source-line-no">041</span><span id="line-41">@InterfaceAudience.Private</span> |
| <span class="source-line-no">042</span><span id="line-42">public class RotateFile {</span> |
| <span class="source-line-no">043</span><span id="line-43"></span> |
| <span class="source-line-no">044</span><span id="line-44"> private static final Logger LOG = LoggerFactory.getLogger(RotateFile.class);</span> |
| <span class="source-line-no">045</span><span id="line-45"></span> |
| <span class="source-line-no">046</span><span id="line-46"> private final FileSystem fs;</span> |
| <span class="source-line-no">047</span><span id="line-47"></span> |
| <span class="source-line-no">048</span><span id="line-48"> private final long maxFileSize;</span> |
| <span class="source-line-no">049</span><span id="line-49"></span> |
| <span class="source-line-no">050</span><span id="line-50"> private final Path[] files = new Path[2];</span> |
| <span class="source-line-no">051</span><span id="line-51"></span> |
| <span class="source-line-no">052</span><span id="line-52"> // this is used to make sure that we do not go backwards</span> |
| <span class="source-line-no">053</span><span id="line-53"> private long prevTimestamp = -1;</span> |
| <span class="source-line-no">054</span><span id="line-54"></span> |
| <span class="source-line-no">055</span><span id="line-55"> private int nextFile = -1;</span> |
| <span class="source-line-no">056</span><span id="line-56"></span> |
| <span class="source-line-no">057</span><span id="line-57"> /**</span> |
| <span class="source-line-no">058</span><span id="line-58"> * Constructs a new RotateFile object with the given parameters.</span> |
| <span class="source-line-no">059</span><span id="line-59"> * @param fs the file system to use.</span> |
| <span class="source-line-no">060</span><span id="line-60"> * @param dir the directory where the files will be created.</span> |
| <span class="source-line-no">061</span><span id="line-61"> * @param name the base name for the files.</span> |
| <span class="source-line-no">062</span><span id="line-62"> * @param maxFileSize the maximum size of each file.</span> |
| <span class="source-line-no">063</span><span id="line-63"> */</span> |
| <span class="source-line-no">064</span><span id="line-64"> public RotateFile(FileSystem fs, Path dir, String name, long maxFileSize) {</span> |
| <span class="source-line-no">065</span><span id="line-65"> this.fs = fs;</span> |
| <span class="source-line-no">066</span><span id="line-66"> this.maxFileSize = maxFileSize;</span> |
| <span class="source-line-no">067</span><span id="line-67"> this.files[0] = new Path(dir, name + "-0");</span> |
| <span class="source-line-no">068</span><span id="line-68"> this.files[1] = new Path(dir, name + "-1");</span> |
| <span class="source-line-no">069</span><span id="line-69"> }</span> |
| <span class="source-line-no">070</span><span id="line-70"></span> |
| <span class="source-line-no">071</span><span id="line-71"> private HBaseProtos.RotateFileData read(Path path) throws IOException {</span> |
| <span class="source-line-no">072</span><span id="line-72"> byte[] data;</span> |
| <span class="source-line-no">073</span><span id="line-73"> int expectedChecksum;</span> |
| <span class="source-line-no">074</span><span id="line-74"> try (FSDataInputStream in = fs.open(path)) {</span> |
| <span class="source-line-no">075</span><span id="line-75"> int length = in.readInt();</span> |
| <span class="source-line-no">076</span><span id="line-76"> if (length <= 0 || length > maxFileSize) {</span> |
| <span class="source-line-no">077</span><span id="line-77"> throw new IOException("Invalid file length " + length</span> |
| <span class="source-line-no">078</span><span id="line-78"> + ", either less than 0 or greater then max allowed size " + maxFileSize);</span> |
| <span class="source-line-no">079</span><span id="line-79"> }</span> |
| <span class="source-line-no">080</span><span id="line-80"> data = new byte[length];</span> |
| <span class="source-line-no">081</span><span id="line-81"> in.readFully(data);</span> |
| <span class="source-line-no">082</span><span id="line-82"> expectedChecksum = in.readInt();</span> |
| <span class="source-line-no">083</span><span id="line-83"> }</span> |
| <span class="source-line-no">084</span><span id="line-84"> CRC32 crc32 = new CRC32();</span> |
| <span class="source-line-no">085</span><span id="line-85"> crc32.update(data);</span> |
| <span class="source-line-no">086</span><span id="line-86"> int calculatedChecksum = (int) crc32.getValue();</span> |
| <span class="source-line-no">087</span><span id="line-87"> if (expectedChecksum != calculatedChecksum) {</span> |
| <span class="source-line-no">088</span><span id="line-88"> throw new IOException(</span> |
| <span class="source-line-no">089</span><span id="line-89"> "Checksum mismatch, expected " + expectedChecksum + ", actual " + calculatedChecksum);</span> |
| <span class="source-line-no">090</span><span id="line-90"> }</span> |
| <span class="source-line-no">091</span><span id="line-91"> return HBaseProtos.RotateFileData.parseFrom(data);</span> |
| <span class="source-line-no">092</span><span id="line-92"> }</span> |
| <span class="source-line-no">093</span><span id="line-93"></span> |
| <span class="source-line-no">094</span><span id="line-94"> private int select(HBaseProtos.RotateFileData[] datas) {</span> |
| <span class="source-line-no">095</span><span id="line-95"> if (datas[0] == null) {</span> |
| <span class="source-line-no">096</span><span id="line-96"> return 1;</span> |
| <span class="source-line-no">097</span><span id="line-97"> }</span> |
| <span class="source-line-no">098</span><span id="line-98"> if (datas[1] == null) {</span> |
| <span class="source-line-no">099</span><span id="line-99"> return 0;</span> |
| <span class="source-line-no">100</span><span id="line-100"> }</span> |
| <span class="source-line-no">101</span><span id="line-101"> return datas[0].getTimestamp() >= datas[1].getTimestamp() ? 0 : 1;</span> |
| <span class="source-line-no">102</span><span id="line-102"> }</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"> * Reads the content of the rotate file by selecting the winner file based on the timestamp of the</span> |
| <span class="source-line-no">106</span><span id="line-106"> * data inside the files. It reads the content of both files and selects the one with the latest</span> |
| <span class="source-line-no">107</span><span id="line-107"> * timestamp as the winner. If a file is incomplete or does not exist, it logs the error and moves</span> |
| <span class="source-line-no">108</span><span id="line-108"> * on to the next file. It returns the content of the winner file as a byte array. If none of the</span> |
| <span class="source-line-no">109</span><span id="line-109"> * files have valid data, it returns null.</span> |
| <span class="source-line-no">110</span><span id="line-110"> * @return a byte array containing the data from the winner file, or null if no valid data is</span> |
| <span class="source-line-no">111</span><span id="line-111"> * found.</span> |
| <span class="source-line-no">112</span><span id="line-112"> * @throws IOException if an error occurs while reading the files.</span> |
| <span class="source-line-no">113</span><span id="line-113"> */</span> |
| <span class="source-line-no">114</span><span id="line-114"> public byte[] read() throws IOException {</span> |
| <span class="source-line-no">115</span><span id="line-115"> HBaseProtos.RotateFileData[] datas = new HBaseProtos.RotateFileData[2];</span> |
| <span class="source-line-no">116</span><span id="line-116"> for (int i = 0; i < 2; i++) {</span> |
| <span class="source-line-no">117</span><span id="line-117"> try {</span> |
| <span class="source-line-no">118</span><span id="line-118"> datas[i] = read(files[i]);</span> |
| <span class="source-line-no">119</span><span id="line-119"> } catch (FileNotFoundException e) {</span> |
| <span class="source-line-no">120</span><span id="line-120"> LOG.debug("file {} does not exist", files[i], e);</span> |
| <span class="source-line-no">121</span><span id="line-121"> } catch (EOFException e) {</span> |
| <span class="source-line-no">122</span><span id="line-122"> LOG.debug("file {} is incomplete", files[i], e);</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"> int winnerIndex = select(datas);</span> |
| <span class="source-line-no">126</span><span id="line-126"> nextFile = 1 - winnerIndex;</span> |
| <span class="source-line-no">127</span><span id="line-127"> if (datas[winnerIndex] != null) {</span> |
| <span class="source-line-no">128</span><span id="line-128"> prevTimestamp = datas[winnerIndex].getTimestamp();</span> |
| <span class="source-line-no">129</span><span id="line-129"> return datas[winnerIndex].getData().toByteArray();</span> |
| <span class="source-line-no">130</span><span id="line-130"> } else {</span> |
| <span class="source-line-no">131</span><span id="line-131"> return null;</span> |
| <span class="source-line-no">132</span><span id="line-132"> }</span> |
| <span class="source-line-no">133</span><span id="line-133"> }</span> |
| <span class="source-line-no">134</span><span id="line-134"></span> |
| <span class="source-line-no">135</span><span id="line-135"> @RestrictedApi(explanation = "Should only be called in tests", link = "",</span> |
| <span class="source-line-no">136</span><span id="line-136"> allowedOnPath = ".*/RotateFile.java|.*/src/test/.*")</span> |
| <span class="source-line-no">137</span><span id="line-137"> static void write(FileSystem fs, Path file, long timestamp, byte[] data) throws IOException {</span> |
| <span class="source-line-no">138</span><span id="line-138"> HBaseProtos.RotateFileData proto = HBaseProtos.RotateFileData.newBuilder()</span> |
| <span class="source-line-no">139</span><span id="line-139"> .setTimestamp(timestamp).setData(ByteString.copyFrom(data)).build();</span> |
| <span class="source-line-no">140</span><span id="line-140"> byte[] protoData = proto.toByteArray();</span> |
| <span class="source-line-no">141</span><span id="line-141"> CRC32 crc32 = new CRC32();</span> |
| <span class="source-line-no">142</span><span id="line-142"> crc32.update(protoData);</span> |
| <span class="source-line-no">143</span><span id="line-143"> int checksum = (int) crc32.getValue();</span> |
| <span class="source-line-no">144</span><span id="line-144"> // 4 bytes length, 8 bytes timestamp, 4 bytes checksum at the end</span> |
| <span class="source-line-no">145</span><span id="line-145"> try (FSDataOutputStream out = fs.create(file, true)) {</span> |
| <span class="source-line-no">146</span><span id="line-146"> out.writeInt(protoData.length);</span> |
| <span class="source-line-no">147</span><span id="line-147"> out.write(protoData);</span> |
| <span class="source-line-no">148</span><span id="line-148"> out.writeInt(checksum);</span> |
| <span class="source-line-no">149</span><span id="line-149"> }</span> |
| <span class="source-line-no">150</span><span id="line-150"> }</span> |
| <span class="source-line-no">151</span><span id="line-151"></span> |
| <span class="source-line-no">152</span><span id="line-152"> /**</span> |
| <span class="source-line-no">153</span><span id="line-153"> * Writes the given data to the next file in the rotation, with a timestamp calculated based on</span> |
| <span class="source-line-no">154</span><span id="line-154"> * the previous timestamp and the current time to make sure it is greater than the previous</span> |
| <span class="source-line-no">155</span><span id="line-155"> * timestamp. The method also deletes the previous file, which is no longer needed.</span> |
| <span class="source-line-no">156</span><span id="line-156"> * <p/></span> |
| <span class="source-line-no">157</span><span id="line-157"> * Notice that, for a newly created {@link RotateFile} instance, you need to call {@link #read()}</span> |
| <span class="source-line-no">158</span><span id="line-158"> * first to initialize the nextFile index, before calling this method.</span> |
| <span class="source-line-no">159</span><span id="line-159"> * @param data the data to be written to the file</span> |
| <span class="source-line-no">160</span><span id="line-160"> * @throws IOException if an I/O error occurs while writing the data to the file</span> |
| <span class="source-line-no">161</span><span id="line-161"> */</span> |
| <span class="source-line-no">162</span><span id="line-162"> public void write(byte[] data) throws IOException {</span> |
| <span class="source-line-no">163</span><span id="line-163"> if (data.length > maxFileSize) {</span> |
| <span class="source-line-no">164</span><span id="line-164"> throw new IOException(</span> |
| <span class="source-line-no">165</span><span id="line-165"> "Data size " + data.length + " is greater than max allowed size " + maxFileSize);</span> |
| <span class="source-line-no">166</span><span id="line-166"> }</span> |
| <span class="source-line-no">167</span><span id="line-167"> long timestamp = Math.max(prevTimestamp + 1, EnvironmentEdgeManager.currentTime());</span> |
| <span class="source-line-no">168</span><span id="line-168"> write(fs, files[nextFile], timestamp, data);</span> |
| <span class="source-line-no">169</span><span id="line-169"> prevTimestamp = timestamp;</span> |
| <span class="source-line-no">170</span><span id="line-170"> nextFile = 1 - nextFile;</span> |
| <span class="source-line-no">171</span><span id="line-171"> try {</span> |
| <span class="source-line-no">172</span><span id="line-172"> fs.delete(files[nextFile], false);</span> |
| <span class="source-line-no">173</span><span id="line-173"> } catch (IOException e) {</span> |
| <span class="source-line-no">174</span><span id="line-174"> // we will create new file with overwrite = true, so not a big deal here, only for speed up</span> |
| <span class="source-line-no">175</span><span id="line-175"> // loading as we do not need to read this file when loading</span> |
| <span class="source-line-no">176</span><span id="line-176"> LOG.debug("Failed to delete old file {}, ignoring the exception", files[nextFile], e);</span> |
| <span class="source-line-no">177</span><span id="line-177"> }</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"> /**</span> |
| <span class="source-line-no">181</span><span id="line-181"> * Deletes the two files used for rotating data. If any of the files cannot be deleted, an</span> |
| <span class="source-line-no">182</span><span id="line-182"> * IOException is thrown.</span> |
| <span class="source-line-no">183</span><span id="line-183"> * @throws IOException if there is an error deleting either file</span> |
| <span class="source-line-no">184</span><span id="line-184"> */</span> |
| <span class="source-line-no">185</span><span id="line-185"> public void delete() throws IOException {</span> |
| <span class="source-line-no">186</span><span id="line-186"> Path next = files[nextFile];</span> |
| <span class="source-line-no">187</span><span id="line-187"> // delete next file first, and then the current file, so when failing to delete, we can still</span> |
| <span class="source-line-no">188</span><span id="line-188"> // read the correct data</span> |
| <span class="source-line-no">189</span><span id="line-189"> if (fs.exists(next) && !fs.delete(next, false)) {</span> |
| <span class="source-line-no">190</span><span id="line-190"> throw new IOException("Can not delete " + next);</span> |
| <span class="source-line-no">191</span><span id="line-191"> }</span> |
| <span class="source-line-no">192</span><span id="line-192"> Path current = files[1 - nextFile];</span> |
| <span class="source-line-no">193</span><span id="line-193"> if (fs.exists(current) && !fs.delete(current, false)) {</span> |
| <span class="source-line-no">194</span><span id="line-194"> throw new IOException("Can not delete " + current);</span> |
| <span class="source-line-no">195</span><span id="line-195"> }</span> |
| <span class="source-line-no">196</span><span id="line-196"> }</span> |
| <span class="source-line-no">197</span><span id="line-197">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
