atomix-storage/src/main/java/io/atomix/storage/journal/DiskFileReader.java

   1 /*
   2  * Copyright (c) 2024 PANTHEON.tech, s.r.o. and others.  All rights reserved.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package io.atomix.storage.journal;
  17
  18 import static com.google.common.base.Verify.verify;
  19 import static java.util.Objects.requireNonNull;
  20
  21 import java.io.IOException;
  22 import java.nio.ByteBuffer;
  23 import java.nio.channels.FileChannel;
  24 import java.nio.file.Path;
  25 import org.checkerframework.checker.nullness.qual.NonNull;
  26
  27 /**
  28  * A {@link StorageLevel#DISK} implementation of {@link FileReader}. Maintains an internal buffer.
  29  */
  30 final class DiskFileReader extends FileReader {
  31     /**
  32      * Just do not bother with IO smaller than this many bytes.
  33      */
  34     private static final int MIN_IO_SIZE = 8192;
  35
  36     private final FileChannel channel;
  37     private final ByteBuffer buffer;
  38
  39     // tracks where memory's first available byte maps to in terms of FileChannel.position()
  40     private int bufferPosition;
  41
  42     DiskFileReader(final Path path, final FileChannel channel, final int maxSegmentSize, final int maxEntrySize) {
  43         super(path);
  44         this.channel = requireNonNull(channel);
  45         buffer = ByteBuffer.allocate(chooseBufferSize(maxSegmentSize, maxEntrySize)).flip();
  46         bufferPosition = 0;
  47     }
  48
  49     private static int chooseBufferSize(final int maxSegmentSize, final int maxEntrySize) {
  50         if (maxSegmentSize <= MIN_IO_SIZE) {
  51             // just buffer the entire segment
  52             return maxSegmentSize;
  53         }
  54
  55         // one full entry plus its header, or MIN_IO_SIZE, which benefits the read of many small entries
  56         final int minBufferSize = maxEntrySize + SegmentEntry.HEADER_BYTES;
  57         return minBufferSize <= MIN_IO_SIZE ? MIN_IO_SIZE : minBufferSize;
  58     }
  59
  60     @Override
  61     void invalidateCache() {
  62         buffer.clear().flip();
  63         bufferPosition = 0;
  64     }
  65
  66     @Override
  67     ByteBuffer read(final int position, final int size) {
  68         // calculate logical seek distance between buffer's first byte and position and split flow between
  69         // forward-moving and backwards-moving code paths.
  70         final int seek = bufferPosition - position;
  71         return seek >= 0 ? forwardAndRead(seek, position, size) : rewindAndRead(-seek, position, size);
  72     }
  73
  74     private @NonNull ByteBuffer forwardAndRead(final int seek, final int position, final int size) {
  75         final int missing = buffer.limit() - seek - size;
  76         if (missing <= 0) {
  77             // fast path: we have the requested region
  78             return buffer.slice(seek, size).asReadOnlyBuffer();
  79         }
  80
  81         // We need to read more data, but let's salvage what we can:
  82         // - set buffer position to seek, which means it points to the same as position
  83         // - run compact, which moves everything between position and limit onto the beginning of buffer and
  84         //   sets it up to receive more bytes
  85         // - start the read accounting for the seek
  86         buffer.position(seek).compact();
  87         readAtLeast(position + seek, missing);
  88         return setAndSlice(position, size);
  89     }
  90
  91     private @NonNull ByteBuffer rewindAndRead(final int rewindBy, final int position, final int size) {
  92         // TODO: Lazy solution. To be super crisp, we want to find out how much of the buffer we can salvage and
  93         //       do all the limit/position fiddling before and after read. Right now let's just flow the buffer up and
  94         //       read it.
  95         buffer.clear();
  96         readAtLeast(position, size);
  97         return setAndSlice(position, size);
  98     }
  99
 100     private void readAtLeast(final int readPosition, final int readAtLeast) {
 101         final int bytesRead;
 102         try {
 103             bytesRead = channel.read(buffer, readPosition);
 104         } catch (IOException e) {
 105             throw new StorageException(e);
 106         }
 107         verify(bytesRead >= readAtLeast, "Short read %s, expected %s", bytesRead, readAtLeast);
 108         buffer.flip();
 109     }
 110
 111     private @NonNull ByteBuffer setAndSlice(final int position, final int size) {
 112         bufferPosition = position;
 113         return buffer.slice(0, size).asReadOnlyBuffer();
 114     }
 115 }