| <!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.regionserver, class: CellChunkMap"> |
| <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.regionserver;</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.nio.ByteBuffer;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.util.Comparator;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.hbase.Cell;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.util.ByteBufferUtils;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.util.Bytes;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.util.ClassSize;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">027</span><span id="line-27"></span> |
| <span class="source-line-no">028</span><span id="line-28">/**</span> |
| <span class="source-line-no">029</span><span id="line-29"> * CellChunkMap is an array of serialized representations of Cell (pointing to Chunks with full Cell</span> |
| <span class="source-line-no">030</span><span id="line-30"> * data) and can be allocated both off-heap and on-heap.</span> |
| <span class="source-line-no">031</span><span id="line-31"> * <p></span> |
| <span class="source-line-no">032</span><span id="line-32"> * CellChunkMap is a byte array (chunk) holding all that is needed to access a Cell, which is</span> |
| <span class="source-line-no">033</span><span id="line-33"> * actually saved on another deeper chunk. Per Cell we have a reference to this deeper byte array B</span> |
| <span class="source-line-no">034</span><span id="line-34"> * (chunk ID, integer), offset in bytes in B (integer), length in bytes in B (integer) and seqID of</span> |
| <span class="source-line-no">035</span><span id="line-35"> * the cell (long). In order to save reference to byte array we use the Chunk's ID given by</span> |
| <span class="source-line-no">036</span><span id="line-36"> * ChunkCreator.</span> |
| <span class="source-line-no">037</span><span id="line-37"> * <p></span> |
| <span class="source-line-no">038</span><span id="line-38"> * The CellChunkMap memory layout on chunk A relevant to a deeper byte array B, holding the actual</span> |
| <span class="source-line-no">039</span><span id="line-39"> * cell data:</span> |
| <span class="source-line-no">040</span><span id="line-40"> *</span> |
| <span class="source-line-no">041</span><span id="line-41"> * <pre></span> |
| <span class="source-line-no">042</span><span id="line-42"> *</span> |
| <span class="source-line-no">043</span><span id="line-43"> * < header > <--------------- first Cell -----------------> <-- second Cell ...</span> |
| <span class="source-line-no">044</span><span id="line-44"> * --------------------------------------------------------------------------------------- ...</span> |
| <span class="source-line-no">045</span><span id="line-45"> * integer | integer | integer | integer | long |</span> |
| <span class="source-line-no">046</span><span id="line-46"> * 4 bytes | 4 bytes | 4 bytes | 4 bytes | 8 bytes |</span> |
| <span class="source-line-no">047</span><span id="line-47"> * ChunkID | chunkID of | offset in B | length of | sequence | ...</span> |
| <span class="source-line-no">048</span><span id="line-48"> * of this | chunk B with | where Cell's | Cell's | ID of |</span> |
| <span class="source-line-no">049</span><span id="line-49"> * chunk A | Cell data | data starts | data in B | the Cell |</span> |
| <span class="source-line-no">050</span><span id="line-50"> * --------------------------------------------------------------------------------------- ...</span> |
| <span class="source-line-no">051</span><span id="line-51"> * </pre></span> |
| <span class="source-line-no">052</span><span id="line-52"> */</span> |
| <span class="source-line-no">053</span><span id="line-53">@InterfaceAudience.Private</span> |
| <span class="source-line-no">054</span><span id="line-54">public class CellChunkMap<T extends Cell> extends CellFlatMap<T> {</span> |
| <span class="source-line-no">055</span><span id="line-55"></span> |
| <span class="source-line-no">056</span><span id="line-56"> private final Chunk[] chunks; // the array of chunks, on which the index is based</span> |
| <span class="source-line-no">057</span><span id="line-57"></span> |
| <span class="source-line-no">058</span><span id="line-58"> // number of cell-representations in a chunk</span> |
| <span class="source-line-no">059</span><span id="line-59"> // depends on the size of the chunks (may be index chunks or regular data chunks)</span> |
| <span class="source-line-no">060</span><span id="line-60"> // each chunk starts with its own ID following the cells data</span> |
| <span class="source-line-no">061</span><span id="line-61"> private final int numOfCellRepsInChunk;</span> |
| <span class="source-line-no">062</span><span id="line-62"></span> |
| <span class="source-line-no">063</span><span id="line-63"> /**</span> |
| <span class="source-line-no">064</span><span id="line-64"> * C-tor for creating CellChunkMap from existing Chunk array, which must be ordered (decreasingly</span> |
| <span class="source-line-no">065</span><span id="line-65"> * or increasingly according to parameter "descending")</span> |
| <span class="source-line-no">066</span><span id="line-66"> * @param comparator a tool for comparing cells</span> |
| <span class="source-line-no">067</span><span id="line-67"> * @param chunks ordered array of index chunk with cell representations</span> |
| <span class="source-line-no">068</span><span id="line-68"> * @param min the index of the first cell (usually 0)</span> |
| <span class="source-line-no">069</span><span id="line-69"> * @param max number of Cells or the index of the cell after the maximal cell</span> |
| <span class="source-line-no">070</span><span id="line-70"> * @param descending the order of the given array</span> |
| <span class="source-line-no">071</span><span id="line-71"> */</span> |
| <span class="source-line-no">072</span><span id="line-72"> public CellChunkMap(Comparator<? super T> comparator, Chunk[] chunks, int min, int max,</span> |
| <span class="source-line-no">073</span><span id="line-73"> boolean descending) {</span> |
| <span class="source-line-no">074</span><span id="line-74"> super(comparator, min, max, descending);</span> |
| <span class="source-line-no">075</span><span id="line-75"> this.chunks = chunks;</span> |
| <span class="source-line-no">076</span><span id="line-76"> if (chunks != null && chunks.length != 0 && chunks[0] != null) {</span> |
| <span class="source-line-no">077</span><span id="line-77"> this.numOfCellRepsInChunk =</span> |
| <span class="source-line-no">078</span><span id="line-78"> (chunks[0].size - ChunkCreator.SIZEOF_CHUNK_HEADER) / ClassSize.CELL_CHUNK_MAP_ENTRY;</span> |
| <span class="source-line-no">079</span><span id="line-79"> } else { // In case the chunks array was not allocated</span> |
| <span class="source-line-no">080</span><span id="line-80"> this.numOfCellRepsInChunk = 0;</span> |
| <span class="source-line-no">081</span><span id="line-81"> }</span> |
| <span class="source-line-no">082</span><span id="line-82"> }</span> |
| <span class="source-line-no">083</span><span id="line-83"></span> |
| <span class="source-line-no">084</span><span id="line-84"> /**</span> |
| <span class="source-line-no">085</span><span id="line-85"> * To be used by base (CellFlatMap) class only to create a sub-CellFlatMap Should be used only to</span> |
| <span class="source-line-no">086</span><span id="line-86"> * create only CellChunkMap from CellChunkMap</span> |
| <span class="source-line-no">087</span><span id="line-87"> */</span> |
| <span class="source-line-no">088</span><span id="line-88"> @Override</span> |
| <span class="source-line-no">089</span><span id="line-89"> protected CellFlatMap<T> createSubCellFlatMap(int min, int max, boolean descending) {</span> |
| <span class="source-line-no">090</span><span id="line-90"> return new CellChunkMap<>(this.comparator(), this.chunks, min, max, descending);</span> |
| <span class="source-line-no">091</span><span id="line-91"> }</span> |
| <span class="source-line-no">092</span><span id="line-92"></span> |
| <span class="source-line-no">093</span><span id="line-93"> @Override</span> |
| <span class="source-line-no">094</span><span id="line-94"> protected T getCell(int i) {</span> |
| <span class="source-line-no">095</span><span id="line-95"> // get the index of the relevant chunk inside chunk array</span> |
| <span class="source-line-no">096</span><span id="line-96"> int chunkIndex = (i / numOfCellRepsInChunk);</span> |
| <span class="source-line-no">097</span><span id="line-97"> ByteBuffer block = chunks[chunkIndex].getData();// get the ByteBuffer of the relevant chunk</span> |
| <span class="source-line-no">098</span><span id="line-98"> int j = i - chunkIndex * numOfCellRepsInChunk; // get the index of the cell-representation</span> |
| <span class="source-line-no">099</span><span id="line-99"></span> |
| <span class="source-line-no">100</span><span id="line-100"> // find inside the offset inside the chunk holding the index, skip bytes for chunk id</span> |
| <span class="source-line-no">101</span><span id="line-101"> int offsetInBytes = ChunkCreator.SIZEOF_CHUNK_HEADER + j * ClassSize.CELL_CHUNK_MAP_ENTRY;</span> |
| <span class="source-line-no">102</span><span id="line-102"></span> |
| <span class="source-line-no">103</span><span id="line-103"> // find the chunk holding the data of the cell, the chunkID is stored first</span> |
| <span class="source-line-no">104</span><span id="line-104"> int chunkId = ByteBufferUtils.toInt(block, offsetInBytes);</span> |
| <span class="source-line-no">105</span><span id="line-105"> Chunk chunk = ChunkCreator.getInstance().getChunk(chunkId);</span> |
| <span class="source-line-no">106</span><span id="line-106"> if (chunk == null) {</span> |
| <span class="source-line-no">107</span><span id="line-107"> // this should not happen</span> |
| <span class="source-line-no">108</span><span id="line-108"> throw new IllegalArgumentException("In CellChunkMap, cell must be associated with chunk."</span> |
| <span class="source-line-no">109</span><span id="line-109"> + ". We were looking for a cell at index " + i);</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"> // find the offset of the data of the cell, skip integer for chunkID, offset is stored second</span> |
| <span class="source-line-no">113</span><span id="line-113"> int offsetOfCell = ByteBufferUtils.toInt(block, offsetInBytes + Bytes.SIZEOF_INT);</span> |
| <span class="source-line-no">114</span><span id="line-114"> // find the length of the data of the cell, skip two integers for chunkID and offset,</span> |
| <span class="source-line-no">115</span><span id="line-115"> // length is stored third</span> |
| <span class="source-line-no">116</span><span id="line-116"> int lengthOfCell = ByteBufferUtils.toInt(block, offsetInBytes + 2 * Bytes.SIZEOF_INT);</span> |
| <span class="source-line-no">117</span><span id="line-117"> // find the seqID of the cell, skip three integers for chunkID, offset, and length</span> |
| <span class="source-line-no">118</span><span id="line-118"> // the seqID is plain written as part of the cell representation</span> |
| <span class="source-line-no">119</span><span id="line-119"> long cellSeqID = ByteBufferUtils.toLong(block, offsetInBytes + 3 * Bytes.SIZEOF_INT);</span> |
| <span class="source-line-no">120</span><span id="line-120"></span> |
| <span class="source-line-no">121</span><span id="line-121"> ByteBuffer buf = chunk.getData(); // get the ByteBuffer where the cell data is stored</span> |
| <span class="source-line-no">122</span><span id="line-122"> if (buf == null) {</span> |
| <span class="source-line-no">123</span><span id="line-123"> // this should not happen</span> |
| <span class="source-line-no">124</span><span id="line-124"> throw new IllegalArgumentException(</span> |
| <span class="source-line-no">125</span><span id="line-125"> "In CellChunkMap, chunk must be associated with ByteBuffer." + " Chunk: " + chunk</span> |
| <span class="source-line-no">126</span><span id="line-126"> + " Chunk ID: " + chunk.getId() + ", is from pool: " + chunk.isFromPool()</span> |
| <span class="source-line-no">127</span><span id="line-127"> + ". We were looking for a cell at index " + i);</span> |
| <span class="source-line-no">128</span><span id="line-128"> }</span> |
| <span class="source-line-no">129</span><span id="line-129"></span> |
| <span class="source-line-no">130</span><span id="line-130"> @SuppressWarnings("unchecked")</span> |
| <span class="source-line-no">131</span><span id="line-131"> T cell = (T) new ByteBufferChunkKeyValue(buf, offsetOfCell, lengthOfCell, cellSeqID);</span> |
| <span class="source-line-no">132</span><span id="line-132"></span> |
| <span class="source-line-no">133</span><span id="line-133"> return cell;</span> |
| <span class="source-line-no">134</span><span id="line-134"> }</span> |
| <span class="source-line-no">135</span><span id="line-135">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
