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 org.eclipse.jdt.annotation.NonNull;
  25
  26 /**
  27  * A {@link StorageLevel#DISK} implementation of {@link FileReader}. Maintains an internal buffer.
  28  */
  29 final class DiskFileReader extends FileReader {
  30     /**
  31      * Just do not bother with IO smaller than this many bytes.
  32      */
  33     private static final int MIN_IO_SIZE = 8192;
  34
  35     private final FileChannel channel;
  36     private final ByteBuffer buffer;
  37
  38     // tracks where memory's first available byte maps to in terms of FileChannel.position()
  39     private int bufferPosition;
  40
  41     DiskFileReader(final JournalSegmentFile file, final FileChannel channel, final int maxEntrySize) {
  42         this(file, channel, allocateBuffer(file.maxSize(), maxEntrySize));
  43     }
  44
  45     // Note: take ownership of the buffer
  46     DiskFileReader(final JournalSegmentFile file, final FileChannel channel, final ByteBuffer buffer) {
  47         super(file);
  48         this.channel = requireNonNull(channel);
  49         this.buffer = buffer.flip();
  50         bufferPosition = 0;
  51     }
  52
  53     static ByteBuffer allocateBuffer(final int maxSegmentSize, final int maxEntrySize) {
  54         return ByteBuffer.allocate(chooseBufferSize(maxSegmentSize, maxEntrySize));
  55     }
  56
  57     private static int chooseBufferSize(final int maxSegmentSize, final int maxEntrySize) {
  58         if (maxSegmentSize <= MIN_IO_SIZE) {
  59             // just buffer the entire segment
  60             return maxSegmentSize;
  61         }
  62
  63         // one full entry plus its header, or MIN_IO_SIZE, which benefits the read of many small entries
  64         final int minBufferSize = maxEntrySize + SegmentEntry.HEADER_BYTES;
  65         return minBufferSize <= MIN_IO_SIZE ? MIN_IO_SIZE : minBufferSize;
  66     }
  67
  68     @Override
  69     void invalidateCache() {
  70         buffer.clear().flip();
  71         bufferPosition = 0;
  72     }
  73
  74     @Override
  75     ByteBuffer read(final int position, final int size) {
  76         // calculate logical seek distance between buffer's first byte and position and split flow between
  77         // forward-moving and backwards-moving code paths.
  78         final int seek = bufferPosition - position;
  79         return seek >= 0 ? forwardAndRead(seek, position, size) : rewindAndRead(-seek, position, size);
  80     }
  81
  82     private @NonNull ByteBuffer forwardAndRead(final int seek, final int position, final int size) {
  83         final int missing = buffer.limit() - seek - size;
  84         if (missing <= 0) {
  85             // fast path: we have the requested region
  86             return buffer.slice(seek, size).asReadOnlyBuffer();
  87         }
  88
  89         // We need to read more data, but let's salvage what we can:
  90         // - set buffer position to seek, which means it points to the same as position
  91         // - run compact, which moves everything between position and limit onto the beginning of buffer and
  92         //   sets it up to receive more bytes
  93         // - start the read accounting for the seek
  94         buffer.position(seek).compact();
  95         readAtLeast(position + seek, missing);
  96         return setAndSlice(position, size);
  97     }
  98
  99     private @NonNull ByteBuffer rewindAndRead(final int rewindBy, final int position, final int size) {
 100         // TODO: Lazy solution. To be super crisp, we want to find out how much of the buffer we can salvage and
 101         //       do all the limit/position fiddling before and after read. Right now let's just flow the buffer up and
 102         //       read it.
 103         buffer.clear();
 104         readAtLeast(position, size);
 105         return setAndSlice(position, size);
 106     }
 107
 108     private void readAtLeast(final int readPosition, final int readAtLeast) {
 109         final int bytesRead;
 110         try {
 111             bytesRead = channel.read(buffer, readPosition);
 112         } catch (IOException e) {
 113             throw new StorageException(e);
 114         }
 115         verify(bytesRead >= readAtLeast, "Short read %s, expected %s", bytesRead, readAtLeast);
 116         buffer.flip();
 117     }
 118
 119     private @NonNull ByteBuffer setAndSlice(final int position, final int size) {
 120         bufferPosition = position;
 121         return buffer.slice(0, size).asReadOnlyBuffer();
 122     }
 123 }