| package org.apache.hadoop.ozone.container.keyvalue.interfaces; |
| |
| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| import org.apache.hadoop.hdds.client.BlockID; |
| import org.apache.hadoop.hdds.protocol.datanode.proto.ContainerProtos; |
| import org.apache.hadoop.hdds.scm.container.common.helpers.StorageContainerException; |
| import org.apache.hadoop.ozone.common.ChecksumData; |
| import org.apache.hadoop.ozone.common.ChunkBuffer; |
| import org.apache.hadoop.ozone.container.common.helpers.BlockData; |
| import org.apache.hadoop.ozone.container.common.helpers.ChunkInfo; |
| import org.apache.hadoop.ozone.container.common.interfaces.Container; |
| import org.apache.hadoop.ozone.container.common.transport.server.ratis.DispatcherContext; |
| import org.apache.hadoop.ozone.container.keyvalue.KeyValueContainer; |
| |
| import java.io.IOException; |
| import java.nio.ByteBuffer; |
| |
| /** |
| * Chunk Manager allows read, write, delete and listing of chunks in |
| * a container. |
| */ |
| |
| public interface ChunkManager { |
| |
| /** |
| * writes a given chunk. |
| * |
| * @param container - Container for the chunk |
| * @param blockID - ID of the block. |
| * @param info - ChunkInfo. |
| * @param data |
| * @param dispatcherContext - dispatcher context info. |
| * @throws StorageContainerException |
| */ |
| void writeChunk(Container container, BlockID blockID, ChunkInfo info, |
| ChunkBuffer data, DispatcherContext dispatcherContext) |
| throws StorageContainerException; |
| |
| default void writeChunk(Container container, BlockID blockID, ChunkInfo info, |
| ByteBuffer data, DispatcherContext dispatcherContext) |
| throws StorageContainerException { |
| ChunkBuffer wrapper = ChunkBuffer.wrap(data); |
| writeChunk(container, blockID, info, wrapper, dispatcherContext); |
| } |
| |
| /** |
| * reads the data defined by a chunk. |
| * |
| * @param container - Container for the chunk |
| * @param blockID - ID of the block. |
| * @param info - ChunkInfo. |
| * @param dispatcherContext - dispatcher context info. |
| * @return byte array |
| * @throws StorageContainerException |
| * |
| * TODO: Right now we do not support partial reads and writes of chunks. |
| * TODO: Explore if we need to do that for ozone. |
| */ |
| ChunkBuffer readChunk(Container container, BlockID blockID, ChunkInfo info, |
| DispatcherContext dispatcherContext) throws StorageContainerException; |
| |
| /** |
| * Deletes a given chunk. |
| * |
| * @param container - Container for the chunk |
| * @param blockID - ID of the block. |
| * @param info - Chunk Info |
| * @throws StorageContainerException |
| */ |
| void deleteChunk(Container container, BlockID blockID, ChunkInfo info) throws |
| StorageContainerException; |
| |
| void deleteChunks(Container container, BlockData blockData) throws |
| StorageContainerException; |
| |
| // TODO : Support list operations. |
| |
| /** |
| * Shutdown the chunkManager. |
| */ |
| default void shutdown() { |
| // if applicable |
| } |
| |
| default void finishWriteChunks(KeyValueContainer kvContainer, |
| BlockData blockData) throws IOException { |
| // no-op |
| } |
| |
| static long getBufferCapacityForChunkRead(ChunkInfo chunkInfo, |
| long defaultReadBufferCapacity) { |
| long bufferCapacity = 0; |
| if (chunkInfo.isReadDataIntoSingleBuffer()) { |
| // Older client - read all chunk data into one single buffer. |
| bufferCapacity = chunkInfo.getLen(); |
| } else { |
| // Set buffer capacity to checksum boundary size so that each buffer |
| // corresponds to one checksum. If checksum is NONE, then set buffer |
| // capacity to default (OZONE_CHUNK_READ_BUFFER_DEFAULT_SIZE_KEY = 64KB). |
| ChecksumData checksumData = chunkInfo.getChecksumData(); |
| |
| if (checksumData != null) { |
| if (checksumData.getChecksumType() == |
| ContainerProtos.ChecksumType.NONE) { |
| bufferCapacity = defaultReadBufferCapacity; |
| } else { |
| bufferCapacity = checksumData.getBytesPerChecksum(); |
| } |
| } |
| } |
| // If the buffer capacity is 0, set all the data into one ByteBuffer |
| if (bufferCapacity == 0) { |
| bufferCapacity = chunkInfo.getLen(); |
| } |
| |
| return bufferCapacity; |
| } |
| } |