http://git-wip-us.apache.org/repos/asf/hbase-site/blob/1ada5f22/devapidocs/src-html/org/apache/hadoop/hbase/io/hfile/bucket/FileIOEngine.FileReadAccessor.html
----------------------------------------------------------------------
diff --git
a/devapidocs/src-html/org/apache/hadoop/hbase/io/hfile/bucket/FileIOEngine.FileReadAccessor.html
b/devapidocs/src-html/org/apache/hadoop/hbase/io/hfile/bucket/FileIOEngine.FileReadAccessor.html
index 803999d..8af4814 100644
---
a/devapidocs/src-html/org/apache/hadoop/hbase/io/hfile/bucket/FileIOEngine.FileReadAccessor.html
+++
b/devapidocs/src-html/org/apache/hadoop/hbase/io/hfile/bucket/FileIOEngine.FileReadAccessor.html
@@ -41,241 +41,248 @@
<span class="sourceLineNo">033</span>import
org.apache.hadoop.hbase.io.hfile.Cacheable.MemoryType;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import
org.apache.hadoop.hbase.nio.ByteBuff;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import
org.apache.hadoop.hbase.nio.SingleByteBuff;<a name="line.35"></a>
-<span class="sourceLineNo">036</span>import
org.apache.hadoop.util.StringUtils;<a name="line.36"></a>
-<span class="sourceLineNo">037</span><a name="line.37"></a>
-<span class="sourceLineNo">038</span>/**<a name="line.38"></a>
-<span class="sourceLineNo">039</span> * IO engine that stores data to a file
on the local file system.<a name="line.39"></a>
-<span class="sourceLineNo">040</span> */<a name="line.40"></a>
-<span class="sourceLineNo">041</span>@InterfaceAudience.Private<a
name="line.41"></a>
-<span class="sourceLineNo">042</span>public class FileIOEngine implements
IOEngine {<a name="line.42"></a>
-<span class="sourceLineNo">043</span> private static final Log LOG =
LogFactory.getLog(FileIOEngine.class);<a name="line.43"></a>
-<span class="sourceLineNo">044</span> public static final String
FILE_DELIMITER = ",";<a name="line.44"></a>
-<span class="sourceLineNo">045</span> private final String[] filePaths;<a
name="line.45"></a>
-<span class="sourceLineNo">046</span> private final FileChannel[]
fileChannels;<a name="line.46"></a>
-<span class="sourceLineNo">047</span> private final RandomAccessFile[]
rafs;<a name="line.47"></a>
-<span class="sourceLineNo">048</span><a name="line.48"></a>
-<span class="sourceLineNo">049</span> private final long sizePerFile;<a
name="line.49"></a>
-<span class="sourceLineNo">050</span> private final long capacity;<a
name="line.50"></a>
-<span class="sourceLineNo">051</span><a name="line.51"></a>
-<span class="sourceLineNo">052</span> private FileReadAccessor readAccessor =
new FileReadAccessor();<a name="line.52"></a>
-<span class="sourceLineNo">053</span> private FileWriteAccessor writeAccessor
= new FileWriteAccessor();<a name="line.53"></a>
-<span class="sourceLineNo">054</span><a name="line.54"></a>
-<span class="sourceLineNo">055</span> public FileIOEngine(long capacity,
boolean maintainPersistence, String... filePaths)<a name="line.55"></a>
-<span class="sourceLineNo">056</span> throws IOException {<a
name="line.56"></a>
-<span class="sourceLineNo">057</span> this.sizePerFile = capacity /
filePaths.length;<a name="line.57"></a>
-<span class="sourceLineNo">058</span> this.capacity = this.sizePerFile *
filePaths.length;<a name="line.58"></a>
-<span class="sourceLineNo">059</span> this.filePaths = filePaths;<a
name="line.59"></a>
-<span class="sourceLineNo">060</span> this.fileChannels = new
FileChannel[filePaths.length];<a name="line.60"></a>
-<span class="sourceLineNo">061</span> if (!maintainPersistence) {<a
name="line.61"></a>
-<span class="sourceLineNo">062</span> for (String filePath : filePaths)
{<a name="line.62"></a>
-<span class="sourceLineNo">063</span> File file = new File(filePath);<a
name="line.63"></a>
-<span class="sourceLineNo">064</span> if (file.exists()) {<a
name="line.64"></a>
-<span class="sourceLineNo">065</span> if (LOG.isDebugEnabled()) {<a
name="line.65"></a>
-<span class="sourceLineNo">066</span> LOG.debug("File " + filePath
+ " already exists. Deleting!!");<a name="line.66"></a>
-<span class="sourceLineNo">067</span> }<a name="line.67"></a>
-<span class="sourceLineNo">068</span> file.delete();<a
name="line.68"></a>
-<span class="sourceLineNo">069</span> // If deletion fails still we
can manage with the writes<a name="line.69"></a>
-<span class="sourceLineNo">070</span> }<a name="line.70"></a>
-<span class="sourceLineNo">071</span> }<a name="line.71"></a>
-<span class="sourceLineNo">072</span> }<a name="line.72"></a>
-<span class="sourceLineNo">073</span> this.rafs = new
RandomAccessFile[filePaths.length];<a name="line.73"></a>
-<span class="sourceLineNo">074</span> for (int i = 0; i <
filePaths.length; i++) {<a name="line.74"></a>
-<span class="sourceLineNo">075</span> String filePath = filePaths[i];<a
name="line.75"></a>
-<span class="sourceLineNo">076</span> try {<a name="line.76"></a>
-<span class="sourceLineNo">077</span> rafs[i] = new
RandomAccessFile(filePath, "rw");<a name="line.77"></a>
-<span class="sourceLineNo">078</span> long totalSpace = new
File(filePath).getTotalSpace();<a name="line.78"></a>
-<span class="sourceLineNo">079</span> if (totalSpace < sizePerFile)
{<a name="line.79"></a>
-<span class="sourceLineNo">080</span> // The next setting length will
throw exception,logging this message<a name="line.80"></a>
-<span class="sourceLineNo">081</span> // is just used for the detail
reason of exceptionï¼<a name="line.81"></a>
-<span class="sourceLineNo">082</span> String msg = "Only " +
StringUtils.byteDesc(totalSpace)<a name="line.82"></a>
-<span class="sourceLineNo">083</span> + " total space under " +
filePath + ", not enough for requested "<a name="line.83"></a>
-<span class="sourceLineNo">084</span> +
StringUtils.byteDesc(sizePerFile);<a name="line.84"></a>
-<span class="sourceLineNo">085</span> LOG.warn(msg);<a
name="line.85"></a>
-<span class="sourceLineNo">086</span> }<a name="line.86"></a>
-<span class="sourceLineNo">087</span> rafs[i].setLength(sizePerFile);<a
name="line.87"></a>
-<span class="sourceLineNo">088</span> fileChannels[i] =
rafs[i].getChannel();<a name="line.88"></a>
-<span class="sourceLineNo">089</span> LOG.info("Allocating cache " +
StringUtils.byteDesc(sizePerFile)<a name="line.89"></a>
-<span class="sourceLineNo">090</span> + ", on the path:" +
filePath);<a name="line.90"></a>
-<span class="sourceLineNo">091</span> } catch (IOException fex) {<a
name="line.91"></a>
-<span class="sourceLineNo">092</span> LOG.error("Failed allocating
cache on " + filePath, fex);<a name="line.92"></a>
-<span class="sourceLineNo">093</span> shutdown();<a name="line.93"></a>
-<span class="sourceLineNo">094</span> throw fex;<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> }<a name="line.97"></a>
-<span class="sourceLineNo">098</span><a name="line.98"></a>
-<span class="sourceLineNo">099</span> @Override<a name="line.99"></a>
-<span class="sourceLineNo">100</span> public String toString() {<a
name="line.100"></a>
-<span class="sourceLineNo">101</span> return "ioengine=" +
this.getClass().getSimpleName() + ", paths="<a name="line.101"></a>
-<span class="sourceLineNo">102</span> + Arrays.asList(filePaths) + ",
capacity=" + String.format("%,d", this.capacity);<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> /**<a name="line.105"></a>
-<span class="sourceLineNo">106</span> * File IO engine is always able to
support persistent storage for the cache<a name="line.106"></a>
-<span class="sourceLineNo">107</span> * @return true<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 boolean isPersistent() {<a
name="line.110"></a>
-<span class="sourceLineNo">111</span> return true;<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> /**<a name="line.114"></a>
-<span class="sourceLineNo">115</span> * Transfers data from file to the
given byte buffer<a name="line.115"></a>
-<span class="sourceLineNo">116</span> * @param offset The offset in the file
where the first byte to be read<a name="line.116"></a>
-<span class="sourceLineNo">117</span> * @param length The length of buffer
that should be allocated for reading<a name="line.117"></a>
-<span class="sourceLineNo">118</span> * from the file
channel<a name="line.118"></a>
-<span class="sourceLineNo">119</span> * @return number of bytes read<a
name="line.119"></a>
-<span class="sourceLineNo">120</span> * @throws IOException<a
name="line.120"></a>
-<span class="sourceLineNo">121</span> */<a name="line.121"></a>
-<span class="sourceLineNo">122</span> @Override<a name="line.122"></a>
-<span class="sourceLineNo">123</span> public Cacheable read(long offset, int
length, CacheableDeserializer<Cacheable> deserializer)<a
name="line.123"></a>
-<span class="sourceLineNo">124</span> throws IOException {<a
name="line.124"></a>
-<span class="sourceLineNo">125</span> ByteBuffer dstBuffer =
ByteBuffer.allocate(length);<a name="line.125"></a>
-<span class="sourceLineNo">126</span> accessFile(readAccessor, dstBuffer,
offset);<a name="line.126"></a>
-<span class="sourceLineNo">127</span> // The buffer created out of the
fileChannel is formed by copying the data from the file<a name="line.127"></a>
-<span class="sourceLineNo">128</span> // Hence in this case there is no
shared memory that we point to. Even if the BucketCache evicts<a
name="line.128"></a>
-<span class="sourceLineNo">129</span> // this buffer from the file the data
is already copied and there is no need to ensure that<a name="line.129"></a>
-<span class="sourceLineNo">130</span> // the results are not corrupted
before consuming them.<a name="line.130"></a>
-<span class="sourceLineNo">131</span> if (dstBuffer.limit() != length) {<a
name="line.131"></a>
-<span class="sourceLineNo">132</span> throw new RuntimeException("Only "
+ dstBuffer.limit() + " bytes read, " + length<a name="line.132"></a>
-<span class="sourceLineNo">133</span> + " expected");<a
name="line.133"></a>
-<span class="sourceLineNo">134</span> }<a name="line.134"></a>
-<span class="sourceLineNo">135</span> return deserializer.deserialize(new
SingleByteBuff(dstBuffer), true, MemoryType.EXCLUSIVE);<a name="line.135"></a>
-<span class="sourceLineNo">136</span> }<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> * Transfers data from the given byte
buffer to file<a name="line.139"></a>
-<span class="sourceLineNo">140</span> * @param srcBuffer the given byte
buffer from which bytes are to be read<a name="line.140"></a>
-<span class="sourceLineNo">141</span> * @param offset The offset in the file
where the first byte to be written<a name="line.141"></a>
-<span class="sourceLineNo">142</span> * @throws IOException<a
name="line.142"></a>
-<span class="sourceLineNo">143</span> */<a name="line.143"></a>
-<span class="sourceLineNo">144</span> @Override<a name="line.144"></a>
-<span class="sourceLineNo">145</span> public void write(ByteBuffer srcBuffer,
long offset) throws IOException {<a name="line.145"></a>
-<span class="sourceLineNo">146</span> accessFile(writeAccessor, srcBuffer,
offset);<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> /**<a name="line.149"></a>
-<span class="sourceLineNo">150</span> * Sync the data to file after
writing<a name="line.150"></a>
-<span class="sourceLineNo">151</span> * @throws IOException<a
name="line.151"></a>
-<span class="sourceLineNo">152</span> */<a name="line.152"></a>
-<span class="sourceLineNo">153</span> @Override<a name="line.153"></a>
-<span class="sourceLineNo">154</span> public void sync() throws IOException
{<a name="line.154"></a>
-<span class="sourceLineNo">155</span> for (int i = 0; i <
fileChannels.length; i++) {<a name="line.155"></a>
-<span class="sourceLineNo">156</span> try {<a name="line.156"></a>
-<span class="sourceLineNo">157</span> if (fileChannels[i] != null) {<a
name="line.157"></a>
-<span class="sourceLineNo">158</span> fileChannels[i].force(true);<a
name="line.158"></a>
-<span class="sourceLineNo">159</span> }<a name="line.159"></a>
-<span class="sourceLineNo">160</span> } catch (IOException ie) {<a
name="line.160"></a>
-<span class="sourceLineNo">161</span> LOG.warn("Failed syncing data to
" + this.filePaths[i]);<a name="line.161"></a>
-<span class="sourceLineNo">162</span> throw ie;<a name="line.162"></a>
-<span class="sourceLineNo">163</span> }<a name="line.163"></a>
-<span class="sourceLineNo">164</span> }<a name="line.164"></a>
-<span class="sourceLineNo">165</span> }<a name="line.165"></a>
-<span class="sourceLineNo">166</span><a name="line.166"></a>
-<span class="sourceLineNo">167</span> /**<a name="line.167"></a>
-<span class="sourceLineNo">168</span> * Close the file<a name="line.168"></a>
-<span class="sourceLineNo">169</span> */<a name="line.169"></a>
-<span class="sourceLineNo">170</span> @Override<a name="line.170"></a>
-<span class="sourceLineNo">171</span> public void shutdown() {<a
name="line.171"></a>
-<span class="sourceLineNo">172</span> for (int i = 0; i <
filePaths.length; i++) {<a name="line.172"></a>
-<span class="sourceLineNo">173</span> try {<a name="line.173"></a>
-<span class="sourceLineNo">174</span> if (fileChannels[i] != null) {<a
name="line.174"></a>
-<span class="sourceLineNo">175</span> fileChannels[i].close();<a
name="line.175"></a>
-<span class="sourceLineNo">176</span> }<a name="line.176"></a>
-<span class="sourceLineNo">177</span> if (rafs[i] != null) {<a
name="line.177"></a>
-<span class="sourceLineNo">178</span> rafs[i].close();<a
name="line.178"></a>
-<span class="sourceLineNo">179</span> }<a name="line.179"></a>
-<span class="sourceLineNo">180</span> } catch (IOException ex) {<a
name="line.180"></a>
-<span class="sourceLineNo">181</span> LOG.error("Failed closing " +
filePaths[i] + " when shudown the IOEngine", ex);<a name="line.181"></a>
-<span class="sourceLineNo">182</span> }<a name="line.182"></a>
-<span class="sourceLineNo">183</span> }<a name="line.183"></a>
-<span class="sourceLineNo">184</span> }<a name="line.184"></a>
-<span class="sourceLineNo">185</span><a name="line.185"></a>
-<span class="sourceLineNo">186</span> @Override<a name="line.186"></a>
-<span class="sourceLineNo">187</span> public void write(ByteBuff srcBuffer,
long offset) throws IOException {<a name="line.187"></a>
-<span class="sourceLineNo">188</span> // When caching block into
BucketCache there will be single buffer backing for this HFileBlock.<a
name="line.188"></a>
-<span class="sourceLineNo">189</span> assert srcBuffer.hasArray();<a
name="line.189"></a>
-<span class="sourceLineNo">190</span>
write(ByteBuffer.wrap(srcBuffer.array(), srcBuffer.arrayOffset(),<a
name="line.190"></a>
-<span class="sourceLineNo">191</span> srcBuffer.remaining()),
offset);<a name="line.191"></a>
-<span class="sourceLineNo">192</span> }<a name="line.192"></a>
-<span class="sourceLineNo">193</span><a name="line.193"></a>
-<span class="sourceLineNo">194</span> private void accessFile(FileAccessor
accessor, ByteBuffer buffer,<a name="line.194"></a>
-<span class="sourceLineNo">195</span> long globalOffset) throws
IOException {<a name="line.195"></a>
-<span class="sourceLineNo">196</span> int startFileNum =
getFileNum(globalOffset);<a name="line.196"></a>
-<span class="sourceLineNo">197</span> int remainingAccessDataLen =
buffer.remaining();<a name="line.197"></a>
-<span class="sourceLineNo">198</span> int endFileNum =
getFileNum(globalOffset + remainingAccessDataLen - 1);<a name="line.198"></a>
-<span class="sourceLineNo">199</span> int accessFileNum = startFileNum;<a
name="line.199"></a>
-<span class="sourceLineNo">200</span> long accessOffset =
getAbsoluteOffsetInFile(accessFileNum, globalOffset);<a name="line.200"></a>
-<span class="sourceLineNo">201</span> int bufLimit = buffer.limit();<a
name="line.201"></a>
-<span class="sourceLineNo">202</span> while (true) {<a name="line.202"></a>
-<span class="sourceLineNo">203</span> FileChannel fileChannel =
fileChannels[accessFileNum];<a name="line.203"></a>
-<span class="sourceLineNo">204</span> if (endFileNum > accessFileNum)
{<a name="line.204"></a>
-<span class="sourceLineNo">205</span> // short the limit;<a
name="line.205"></a>
-<span class="sourceLineNo">206</span> buffer.limit((int)
(buffer.limit() - remainingAccessDataLen<a name="line.206"></a>
-<span class="sourceLineNo">207</span> + sizePerFile -
accessOffset));<a name="line.207"></a>
-<span class="sourceLineNo">208</span> }<a name="line.208"></a>
-<span class="sourceLineNo">209</span> int accessLen =
accessor.access(fileChannel, buffer, accessOffset);<a name="line.209"></a>
-<span class="sourceLineNo">210</span> // recover the limit<a
name="line.210"></a>
-<span class="sourceLineNo">211</span> buffer.limit(bufLimit);<a
name="line.211"></a>
-<span class="sourceLineNo">212</span> if (accessLen <
remainingAccessDataLen) {<a name="line.212"></a>
-<span class="sourceLineNo">213</span> remainingAccessDataLen -=
accessLen;<a name="line.213"></a>
-<span class="sourceLineNo">214</span> accessFileNum++;<a
name="line.214"></a>
-<span class="sourceLineNo">215</span> accessOffset = 0;<a
name="line.215"></a>
-<span class="sourceLineNo">216</span> } else {<a name="line.216"></a>
-<span class="sourceLineNo">217</span> break;<a name="line.217"></a>
-<span class="sourceLineNo">218</span> }<a name="line.218"></a>
-<span class="sourceLineNo">219</span> if (accessFileNum >=
fileChannels.length) {<a name="line.219"></a>
-<span class="sourceLineNo">220</span> throw new IOException("Required
data len "<a name="line.220"></a>
-<span class="sourceLineNo">221</span> +
StringUtils.byteDesc(buffer.remaining())<a name="line.221"></a>
-<span class="sourceLineNo">222</span> + " exceed the engine's
capacity " + StringUtils.byteDesc(capacity)<a name="line.222"></a>
-<span class="sourceLineNo">223</span> + " where offset=" +
globalOffset);<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> }<a name="line.226"></a>
-<span class="sourceLineNo">227</span><a name="line.227"></a>
-<span class="sourceLineNo">228</span> /**<a name="line.228"></a>
-<span class="sourceLineNo">229</span> * Get the absolute offset in given
file with the relative global offset.<a name="line.229"></a>
-<span class="sourceLineNo">230</span> * @param fileNum<a name="line.230"></a>
-<span class="sourceLineNo">231</span> * @param globalOffset<a
name="line.231"></a>
-<span class="sourceLineNo">232</span> * @return the absolute offset<a
name="line.232"></a>
-<span class="sourceLineNo">233</span> */<a name="line.233"></a>
-<span class="sourceLineNo">234</span> private long
getAbsoluteOffsetInFile(int fileNum, long globalOffset) {<a name="line.234"></a>
-<span class="sourceLineNo">235</span> return globalOffset - fileNum *
sizePerFile;<a name="line.235"></a>
-<span class="sourceLineNo">236</span> }<a name="line.236"></a>
-<span class="sourceLineNo">237</span><a name="line.237"></a>
-<span class="sourceLineNo">238</span> private int getFileNum(long offset) {<a
name="line.238"></a>
-<span class="sourceLineNo">239</span> if (offset < 0) {<a
name="line.239"></a>
-<span class="sourceLineNo">240</span> throw new
IllegalArgumentException("Unexpected offset " + offset);<a name="line.240"></a>
-<span class="sourceLineNo">241</span> }<a name="line.241"></a>
-<span class="sourceLineNo">242</span> int fileNum = (int) (offset /
sizePerFile);<a name="line.242"></a>
-<span class="sourceLineNo">243</span> if (fileNum >=
fileChannels.length) {<a name="line.243"></a>
-<span class="sourceLineNo">244</span> throw new RuntimeException("Not
expected offset " + offset<a name="line.244"></a>
-<span class="sourceLineNo">245</span> + " where capacity=" +
capacity);<a name="line.245"></a>
-<span class="sourceLineNo">246</span> }<a name="line.246"></a>
-<span class="sourceLineNo">247</span> return fileNum;<a name="line.247"></a>
-<span class="sourceLineNo">248</span> }<a name="line.248"></a>
-<span class="sourceLineNo">249</span><a name="line.249"></a>
-<span class="sourceLineNo">250</span> private static interface FileAccessor
{<a name="line.250"></a>
-<span class="sourceLineNo">251</span> int access(FileChannel fileChannel,
ByteBuffer byteBuffer, long accessOffset)<a name="line.251"></a>
-<span class="sourceLineNo">252</span> throws IOException;<a
name="line.252"></a>
-<span class="sourceLineNo">253</span> }<a name="line.253"></a>
-<span class="sourceLineNo">254</span><a name="line.254"></a>
-<span class="sourceLineNo">255</span> private static class FileReadAccessor
implements FileAccessor {<a name="line.255"></a>
-<span class="sourceLineNo">256</span> @Override<a name="line.256"></a>
-<span class="sourceLineNo">257</span> public int access(FileChannel
fileChannel, ByteBuffer byteBuffer,<a name="line.257"></a>
-<span class="sourceLineNo">258</span> long accessOffset) throws
IOException {<a name="line.258"></a>
-<span class="sourceLineNo">259</span> return fileChannel.read(byteBuffer,
accessOffset);<a name="line.259"></a>
-<span class="sourceLineNo">260</span> }<a name="line.260"></a>
-<span class="sourceLineNo">261</span> }<a name="line.261"></a>
-<span class="sourceLineNo">262</span><a name="line.262"></a>
-<span class="sourceLineNo">263</span> private static class FileWriteAccessor
implements FileAccessor {<a name="line.263"></a>
-<span class="sourceLineNo">264</span> @Override<a name="line.264"></a>
-<span class="sourceLineNo">265</span> public int access(FileChannel
fileChannel, ByteBuffer byteBuffer,<a name="line.265"></a>
-<span class="sourceLineNo">266</span> long accessOffset) throws
IOException {<a name="line.266"></a>
-<span class="sourceLineNo">267</span> return
fileChannel.write(byteBuffer, accessOffset);<a name="line.267"></a>
-<span class="sourceLineNo">268</span> }<a name="line.268"></a>
-<span class="sourceLineNo">269</span> }<a name="line.269"></a>
-<span class="sourceLineNo">270</span>}<a name="line.270"></a>
+<span class="sourceLineNo">036</span>import
org.apache.hadoop.hbase.shaded.com.google.common.base.Preconditions;<a
name="line.36"></a>
+<span class="sourceLineNo">037</span>import
org.apache.hadoop.util.StringUtils;<a name="line.37"></a>
+<span class="sourceLineNo">038</span><a name="line.38"></a>
+<span class="sourceLineNo">039</span>/**<a name="line.39"></a>
+<span class="sourceLineNo">040</span> * IO engine that stores data to a file
on the local file system.<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 class FileIOEngine implements
IOEngine {<a name="line.43"></a>
+<span class="sourceLineNo">044</span> private static final Log LOG =
LogFactory.getLog(FileIOEngine.class);<a name="line.44"></a>
+<span class="sourceLineNo">045</span> public static final String
FILE_DELIMITER = ",";<a name="line.45"></a>
+<span class="sourceLineNo">046</span> private final String[] filePaths;<a
name="line.46"></a>
+<span class="sourceLineNo">047</span> private final FileChannel[]
fileChannels;<a name="line.47"></a>
+<span class="sourceLineNo">048</span> private final RandomAccessFile[]
rafs;<a name="line.48"></a>
+<span class="sourceLineNo">049</span><a name="line.49"></a>
+<span class="sourceLineNo">050</span> private final long sizePerFile;<a
name="line.50"></a>
+<span class="sourceLineNo">051</span> private final long capacity;<a
name="line.51"></a>
+<span class="sourceLineNo">052</span><a name="line.52"></a>
+<span class="sourceLineNo">053</span> private FileReadAccessor readAccessor =
new FileReadAccessor();<a name="line.53"></a>
+<span class="sourceLineNo">054</span> private FileWriteAccessor writeAccessor
= new FileWriteAccessor();<a name="line.54"></a>
+<span class="sourceLineNo">055</span><a name="line.55"></a>
+<span class="sourceLineNo">056</span> public FileIOEngine(long capacity,
boolean maintainPersistence, String... filePaths)<a name="line.56"></a>
+<span class="sourceLineNo">057</span> throws IOException {<a
name="line.57"></a>
+<span class="sourceLineNo">058</span> this.sizePerFile = capacity /
filePaths.length;<a name="line.58"></a>
+<span class="sourceLineNo">059</span> this.capacity = this.sizePerFile *
filePaths.length;<a name="line.59"></a>
+<span class="sourceLineNo">060</span> this.filePaths = filePaths;<a
name="line.60"></a>
+<span class="sourceLineNo">061</span> this.fileChannels = new
FileChannel[filePaths.length];<a name="line.61"></a>
+<span class="sourceLineNo">062</span> if (!maintainPersistence) {<a
name="line.62"></a>
+<span class="sourceLineNo">063</span> for (String filePath : filePaths)
{<a name="line.63"></a>
+<span class="sourceLineNo">064</span> File file = new File(filePath);<a
name="line.64"></a>
+<span class="sourceLineNo">065</span> if (file.exists()) {<a
name="line.65"></a>
+<span class="sourceLineNo">066</span> if (LOG.isDebugEnabled()) {<a
name="line.66"></a>
+<span class="sourceLineNo">067</span> LOG.debug("File " + filePath
+ " already exists. Deleting!!");<a name="line.67"></a>
+<span class="sourceLineNo">068</span> }<a name="line.68"></a>
+<span class="sourceLineNo">069</span> file.delete();<a
name="line.69"></a>
+<span class="sourceLineNo">070</span> // If deletion fails still we
can manage with the writes<a name="line.70"></a>
+<span class="sourceLineNo">071</span> }<a name="line.71"></a>
+<span class="sourceLineNo">072</span> }<a name="line.72"></a>
+<span class="sourceLineNo">073</span> }<a name="line.73"></a>
+<span class="sourceLineNo">074</span> this.rafs = new
RandomAccessFile[filePaths.length];<a name="line.74"></a>
+<span class="sourceLineNo">075</span> for (int i = 0; i <
filePaths.length; i++) {<a name="line.75"></a>
+<span class="sourceLineNo">076</span> String filePath = filePaths[i];<a
name="line.76"></a>
+<span class="sourceLineNo">077</span> try {<a name="line.77"></a>
+<span class="sourceLineNo">078</span> rafs[i] = new
RandomAccessFile(filePath, "rw");<a name="line.78"></a>
+<span class="sourceLineNo">079</span> long totalSpace = new
File(filePath).getTotalSpace();<a name="line.79"></a>
+<span class="sourceLineNo">080</span> if (totalSpace < sizePerFile)
{<a name="line.80"></a>
+<span class="sourceLineNo">081</span> // The next setting length will
throw exception,logging this message<a name="line.81"></a>
+<span class="sourceLineNo">082</span> // is just used for the detail
reason of exceptionï¼<a name="line.82"></a>
+<span class="sourceLineNo">083</span> String msg = "Only " +
StringUtils.byteDesc(totalSpace)<a name="line.83"></a>
+<span class="sourceLineNo">084</span> + " total space under " +
filePath + ", not enough for requested "<a name="line.84"></a>
+<span class="sourceLineNo">085</span> +
StringUtils.byteDesc(sizePerFile);<a name="line.85"></a>
+<span class="sourceLineNo">086</span> LOG.warn(msg);<a
name="line.86"></a>
+<span class="sourceLineNo">087</span> }<a name="line.87"></a>
+<span class="sourceLineNo">088</span> rafs[i].setLength(sizePerFile);<a
name="line.88"></a>
+<span class="sourceLineNo">089</span> fileChannels[i] =
rafs[i].getChannel();<a name="line.89"></a>
+<span class="sourceLineNo">090</span> LOG.info("Allocating cache " +
StringUtils.byteDesc(sizePerFile)<a name="line.90"></a>
+<span class="sourceLineNo">091</span> + ", on the path:" +
filePath);<a name="line.91"></a>
+<span class="sourceLineNo">092</span> } catch (IOException fex) {<a
name="line.92"></a>
+<span class="sourceLineNo">093</span> LOG.error("Failed allocating
cache on " + filePath, fex);<a name="line.93"></a>
+<span class="sourceLineNo">094</span> shutdown();<a name="line.94"></a>
+<span class="sourceLineNo">095</span> throw fex;<a name="line.95"></a>
+<span class="sourceLineNo">096</span> }<a name="line.96"></a>
+<span class="sourceLineNo">097</span> }<a name="line.97"></a>
+<span class="sourceLineNo">098</span> }<a name="line.98"></a>
+<span class="sourceLineNo">099</span><a name="line.99"></a>
+<span class="sourceLineNo">100</span> @Override<a name="line.100"></a>
+<span class="sourceLineNo">101</span> public String toString() {<a
name="line.101"></a>
+<span class="sourceLineNo">102</span> return "ioengine=" +
this.getClass().getSimpleName() + ", paths="<a name="line.102"></a>
+<span class="sourceLineNo">103</span> + Arrays.asList(filePaths) + ",
capacity=" + String.format("%,d", this.capacity);<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> * File IO engine is always able to
support persistent storage for the cache<a name="line.107"></a>
+<span class="sourceLineNo">108</span> * @return true<a name="line.108"></a>
+<span class="sourceLineNo">109</span> */<a name="line.109"></a>
+<span class="sourceLineNo">110</span> @Override<a name="line.110"></a>
+<span class="sourceLineNo">111</span> public boolean isPersistent() {<a
name="line.111"></a>
+<span class="sourceLineNo">112</span> return true;<a name="line.112"></a>
+<span class="sourceLineNo">113</span> }<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> * Transfers data from file to the
given byte buffer<a name="line.116"></a>
+<span class="sourceLineNo">117</span> * @param offset The offset in the file
where the first byte to be read<a name="line.117"></a>
+<span class="sourceLineNo">118</span> * @param length The length of buffer
that should be allocated for reading<a name="line.118"></a>
+<span class="sourceLineNo">119</span> * from the file
channel<a name="line.119"></a>
+<span class="sourceLineNo">120</span> * @return number of bytes read<a
name="line.120"></a>
+<span class="sourceLineNo">121</span> * @throws IOException<a
name="line.121"></a>
+<span class="sourceLineNo">122</span> */<a name="line.122"></a>
+<span class="sourceLineNo">123</span> @Override<a name="line.123"></a>
+<span class="sourceLineNo">124</span> public Cacheable read(long offset, int
length, CacheableDeserializer<Cacheable> deserializer)<a
name="line.124"></a>
+<span class="sourceLineNo">125</span> throws IOException {<a
name="line.125"></a>
+<span class="sourceLineNo">126</span> Preconditions.checkArgument(length
>= 0, "Length of read can not be less than 0.");<a name="line.126"></a>
+<span class="sourceLineNo">127</span> ByteBuffer dstBuffer =
ByteBuffer.allocate(length);<a name="line.127"></a>
+<span class="sourceLineNo">128</span> if (length != 0) {<a
name="line.128"></a>
+<span class="sourceLineNo">129</span> accessFile(readAccessor, dstBuffer,
offset);<a name="line.129"></a>
+<span class="sourceLineNo">130</span> // The buffer created out of the
fileChannel is formed by copying the data from the file<a name="line.130"></a>
+<span class="sourceLineNo">131</span> // Hence in this case there is no
shared memory that we point to. Even if the BucketCache evicts<a
name="line.131"></a>
+<span class="sourceLineNo">132</span> // this buffer from the file the
data is already copied and there is no need to ensure that<a
name="line.132"></a>
+<span class="sourceLineNo">133</span> // the results are not corrupted
before consuming them.<a name="line.133"></a>
+<span class="sourceLineNo">134</span> if (dstBuffer.limit() != length)
{<a name="line.134"></a>
+<span class="sourceLineNo">135</span> throw new RuntimeException("Only
" + dstBuffer.limit() + " bytes read, " + length<a name="line.135"></a>
+<span class="sourceLineNo">136</span> + " expected");<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> return deserializer.deserialize(new
SingleByteBuff(dstBuffer), true, MemoryType.EXCLUSIVE);<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>
+<span class="sourceLineNo">142</span> /**<a name="line.142"></a>
+<span class="sourceLineNo">143</span> * Transfers data from the given byte
buffer to file<a name="line.143"></a>
+<span class="sourceLineNo">144</span> * @param srcBuffer the given byte
buffer from which bytes are to be read<a name="line.144"></a>
+<span class="sourceLineNo">145</span> * @param offset The offset in the file
where the first byte to be written<a name="line.145"></a>
+<span class="sourceLineNo">146</span> * @throws IOException<a
name="line.146"></a>
+<span class="sourceLineNo">147</span> */<a name="line.147"></a>
+<span class="sourceLineNo">148</span> @Override<a name="line.148"></a>
+<span class="sourceLineNo">149</span> public void write(ByteBuffer srcBuffer,
long offset) throws IOException {<a name="line.149"></a>
+<span class="sourceLineNo">150</span> if (!srcBuffer.hasRemaining()) {<a
name="line.150"></a>
+<span class="sourceLineNo">151</span> return;<a name="line.151"></a>
+<span class="sourceLineNo">152</span> }<a name="line.152"></a>
+<span class="sourceLineNo">153</span> accessFile(writeAccessor, srcBuffer,
offset);<a name="line.153"></a>
+<span class="sourceLineNo">154</span> }<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> * Sync the data to file after
writing<a name="line.157"></a>
+<span class="sourceLineNo">158</span> * @throws IOException<a
name="line.158"></a>
+<span class="sourceLineNo">159</span> */<a name="line.159"></a>
+<span class="sourceLineNo">160</span> @Override<a name="line.160"></a>
+<span class="sourceLineNo">161</span> public void sync() throws IOException
{<a name="line.161"></a>
+<span class="sourceLineNo">162</span> for (int i = 0; i <
fileChannels.length; i++) {<a name="line.162"></a>
+<span class="sourceLineNo">163</span> try {<a name="line.163"></a>
+<span class="sourceLineNo">164</span> if (fileChannels[i] != null) {<a
name="line.164"></a>
+<span class="sourceLineNo">165</span> fileChannels[i].force(true);<a
name="line.165"></a>
+<span class="sourceLineNo">166</span> }<a name="line.166"></a>
+<span class="sourceLineNo">167</span> } catch (IOException ie) {<a
name="line.167"></a>
+<span class="sourceLineNo">168</span> LOG.warn("Failed syncing data to
" + this.filePaths[i]);<a name="line.168"></a>
+<span class="sourceLineNo">169</span> throw ie;<a name="line.169"></a>
+<span class="sourceLineNo">170</span> }<a name="line.170"></a>
+<span class="sourceLineNo">171</span> }<a name="line.171"></a>
+<span class="sourceLineNo">172</span> }<a name="line.172"></a>
+<span class="sourceLineNo">173</span><a name="line.173"></a>
+<span class="sourceLineNo">174</span> /**<a name="line.174"></a>
+<span class="sourceLineNo">175</span> * Close the file<a name="line.175"></a>
+<span class="sourceLineNo">176</span> */<a name="line.176"></a>
+<span class="sourceLineNo">177</span> @Override<a name="line.177"></a>
+<span class="sourceLineNo">178</span> public void shutdown() {<a
name="line.178"></a>
+<span class="sourceLineNo">179</span> for (int i = 0; i <
filePaths.length; i++) {<a name="line.179"></a>
+<span class="sourceLineNo">180</span> try {<a name="line.180"></a>
+<span class="sourceLineNo">181</span> if (fileChannels[i] != null) {<a
name="line.181"></a>
+<span class="sourceLineNo">182</span> fileChannels[i].close();<a
name="line.182"></a>
+<span class="sourceLineNo">183</span> }<a name="line.183"></a>
+<span class="sourceLineNo">184</span> if (rafs[i] != null) {<a
name="line.184"></a>
+<span class="sourceLineNo">185</span> rafs[i].close();<a
name="line.185"></a>
+<span class="sourceLineNo">186</span> }<a name="line.186"></a>
+<span class="sourceLineNo">187</span> } catch (IOException ex) {<a
name="line.187"></a>
+<span class="sourceLineNo">188</span> LOG.error("Failed closing " +
filePaths[i] + " when shudown the IOEngine", ex);<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> }<a name="line.191"></a>
+<span class="sourceLineNo">192</span><a name="line.192"></a>
+<span class="sourceLineNo">193</span> @Override<a name="line.193"></a>
+<span class="sourceLineNo">194</span> public void write(ByteBuff srcBuffer,
long offset) throws IOException {<a name="line.194"></a>
+<span class="sourceLineNo">195</span> // When caching block into
BucketCache there will be single buffer backing for this HFileBlock.<a
name="line.195"></a>
+<span class="sourceLineNo">196</span> assert srcBuffer.hasArray();<a
name="line.196"></a>
+<span class="sourceLineNo">197</span>
write(ByteBuffer.wrap(srcBuffer.array(), srcBuffer.arrayOffset(),<a
name="line.197"></a>
+<span class="sourceLineNo">198</span> srcBuffer.remaining()),
offset);<a name="line.198"></a>
+<span class="sourceLineNo">199</span> }<a name="line.199"></a>
+<span class="sourceLineNo">200</span><a name="line.200"></a>
+<span class="sourceLineNo">201</span> private void accessFile(FileAccessor
accessor, ByteBuffer buffer,<a name="line.201"></a>
+<span class="sourceLineNo">202</span> long globalOffset) throws
IOException {<a name="line.202"></a>
+<span class="sourceLineNo">203</span> int startFileNum =
getFileNum(globalOffset);<a name="line.203"></a>
+<span class="sourceLineNo">204</span> int remainingAccessDataLen =
buffer.remaining();<a name="line.204"></a>
+<span class="sourceLineNo">205</span> int endFileNum =
getFileNum(globalOffset + remainingAccessDataLen - 1);<a name="line.205"></a>
+<span class="sourceLineNo">206</span> int accessFileNum = startFileNum;<a
name="line.206"></a>
+<span class="sourceLineNo">207</span> long accessOffset =
getAbsoluteOffsetInFile(accessFileNum, globalOffset);<a name="line.207"></a>
+<span class="sourceLineNo">208</span> int bufLimit = buffer.limit();<a
name="line.208"></a>
+<span class="sourceLineNo">209</span> while (true) {<a name="line.209"></a>
+<span class="sourceLineNo">210</span> FileChannel fileChannel =
fileChannels[accessFileNum];<a name="line.210"></a>
+<span class="sourceLineNo">211</span> if (endFileNum > accessFileNum)
{<a name="line.211"></a>
+<span class="sourceLineNo">212</span> // short the limit;<a
name="line.212"></a>
+<span class="sourceLineNo">213</span> buffer.limit((int)
(buffer.limit() - remainingAccessDataLen<a name="line.213"></a>
+<span class="sourceLineNo">214</span> + sizePerFile -
accessOffset));<a name="line.214"></a>
+<span class="sourceLineNo">215</span> }<a name="line.215"></a>
+<span class="sourceLineNo">216</span> int accessLen =
accessor.access(fileChannel, buffer, accessOffset);<a name="line.216"></a>
+<span class="sourceLineNo">217</span> // recover the limit<a
name="line.217"></a>
+<span class="sourceLineNo">218</span> buffer.limit(bufLimit);<a
name="line.218"></a>
+<span class="sourceLineNo">219</span> if (accessLen <
remainingAccessDataLen) {<a name="line.219"></a>
+<span class="sourceLineNo">220</span> remainingAccessDataLen -=
accessLen;<a name="line.220"></a>
+<span class="sourceLineNo">221</span> accessFileNum++;<a
name="line.221"></a>
+<span class="sourceLineNo">222</span> accessOffset = 0;<a
name="line.222"></a>
+<span class="sourceLineNo">223</span> } else {<a name="line.223"></a>
+<span class="sourceLineNo">224</span> break;<a name="line.224"></a>
+<span class="sourceLineNo">225</span> }<a name="line.225"></a>
+<span class="sourceLineNo">226</span> if (accessFileNum >=
fileChannels.length) {<a name="line.226"></a>
+<span class="sourceLineNo">227</span> throw new IOException("Required
data len "<a name="line.227"></a>
+<span class="sourceLineNo">228</span> +
StringUtils.byteDesc(buffer.remaining())<a name="line.228"></a>
+<span class="sourceLineNo">229</span> + " exceed the engine's
capacity " + StringUtils.byteDesc(capacity)<a name="line.229"></a>
+<span class="sourceLineNo">230</span> + " where offset=" +
globalOffset);<a name="line.230"></a>
+<span class="sourceLineNo">231</span> }<a name="line.231"></a>
+<span class="sourceLineNo">232</span> }<a name="line.232"></a>
+<span class="sourceLineNo">233</span> }<a name="line.233"></a>
+<span class="sourceLineNo">234</span><a name="line.234"></a>
+<span class="sourceLineNo">235</span> /**<a name="line.235"></a>
+<span class="sourceLineNo">236</span> * Get the absolute offset in given
file with the relative global offset.<a name="line.236"></a>
+<span class="sourceLineNo">237</span> * @param fileNum<a name="line.237"></a>
+<span class="sourceLineNo">238</span> * @param globalOffset<a
name="line.238"></a>
+<span class="sourceLineNo">239</span> * @return the absolute offset<a
name="line.239"></a>
+<span class="sourceLineNo">240</span> */<a name="line.240"></a>
+<span class="sourceLineNo">241</span> private long
getAbsoluteOffsetInFile(int fileNum, long globalOffset) {<a name="line.241"></a>
+<span class="sourceLineNo">242</span> return globalOffset - fileNum *
sizePerFile;<a name="line.242"></a>
+<span class="sourceLineNo">243</span> }<a name="line.243"></a>
+<span class="sourceLineNo">244</span><a name="line.244"></a>
+<span class="sourceLineNo">245</span> private int getFileNum(long offset) {<a
name="line.245"></a>
+<span class="sourceLineNo">246</span> if (offset < 0) {<a
name="line.246"></a>
+<span class="sourceLineNo">247</span> throw new
IllegalArgumentException("Unexpected offset " + offset);<a name="line.247"></a>
+<span class="sourceLineNo">248</span> }<a name="line.248"></a>
+<span class="sourceLineNo">249</span> int fileNum = (int) (offset /
sizePerFile);<a name="line.249"></a>
+<span class="sourceLineNo">250</span> if (fileNum >=
fileChannels.length) {<a name="line.250"></a>
+<span class="sourceLineNo">251</span> throw new RuntimeException("Not
expected offset " + offset<a name="line.251"></a>
+<span class="sourceLineNo">252</span> + " where capacity=" +
capacity);<a name="line.252"></a>
+<span class="sourceLineNo">253</span> }<a name="line.253"></a>
+<span class="sourceLineNo">254</span> return fileNum;<a name="line.254"></a>
+<span class="sourceLineNo">255</span> }<a name="line.255"></a>
+<span class="sourceLineNo">256</span><a name="line.256"></a>
+<span class="sourceLineNo">257</span> private static interface FileAccessor
{<a name="line.257"></a>
+<span class="sourceLineNo">258</span> int access(FileChannel fileChannel,
ByteBuffer byteBuffer, long accessOffset)<a name="line.258"></a>
+<span class="sourceLineNo">259</span> throws IOException;<a
name="line.259"></a>
+<span class="sourceLineNo">260</span> }<a name="line.260"></a>
+<span class="sourceLineNo">261</span><a name="line.261"></a>
+<span class="sourceLineNo">262</span> private static class FileReadAccessor
implements FileAccessor {<a name="line.262"></a>
+<span class="sourceLineNo">263</span> @Override<a name="line.263"></a>
+<span class="sourceLineNo">264</span> public int access(FileChannel
fileChannel, ByteBuffer byteBuffer,<a name="line.264"></a>
+<span class="sourceLineNo">265</span> long accessOffset) throws
IOException {<a name="line.265"></a>
+<span class="sourceLineNo">266</span> return fileChannel.read(byteBuffer,
accessOffset);<a name="line.266"></a>
+<span class="sourceLineNo">267</span> }<a name="line.267"></a>
+<span class="sourceLineNo">268</span> }<a name="line.268"></a>
+<span class="sourceLineNo">269</span><a name="line.269"></a>
+<span class="sourceLineNo">270</span> private static class FileWriteAccessor
implements FileAccessor {<a name="line.270"></a>
+<span class="sourceLineNo">271</span> @Override<a name="line.271"></a>
+<span class="sourceLineNo">272</span> public int access(FileChannel
fileChannel, ByteBuffer byteBuffer,<a name="line.272"></a>
+<span class="sourceLineNo">273</span> long accessOffset) throws
IOException {<a name="line.273"></a>
+<span class="sourceLineNo">274</span> return
fileChannel.write(byteBuffer, accessOffset);<a name="line.274"></a>
+<span class="sourceLineNo">275</span> }<a name="line.275"></a>
+<span class="sourceLineNo">276</span> }<a name="line.276"></a>
+<span class="sourceLineNo">277</span>}<a name="line.277"></a>
