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

   1 /*
   2  * Copyright 2017-2022 Open Networking Foundation and others.  All rights reserved.
   3  * Copyright (c) 2024 PANTHEON.tech, s.r.o. and others.
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  * http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17 package io.atomix.storage.journal;
  18
  19 import static java.util.Objects.requireNonNull;
  20
  21 import java.io.File;
  22
  23 /**
  24  * Segmented journal.
  25  */
  26 public final class SegmentedJournal<E> implements Journal<E> {
  27     private final SegmentedByteBufJournal journal;
  28     private final SegmentedJournalWriter<E> writer;
  29     private final ByteBufMapper<E> mapper;
  30
  31     public SegmentedJournal(final SegmentedByteBufJournal journal, final ByteBufMapper<E> mapper) {
  32         this.journal = requireNonNull(journal, "journal is required");
  33         this.mapper = requireNonNull(mapper, "mapper cannot be null");
  34         writer = new SegmentedJournalWriter<>(journal.writer(), mapper);
  35     }
  36
  37     @Override
  38     public long lastIndex() {
  39         return journal.lastIndex();
  40     }
  41
  42     @Override
  43     public JournalWriter<E> writer() {
  44         return writer;
  45     }
  46
  47     @Override
  48     public JournalReader<E> openReader(final long index) {
  49         return openReader(index, JournalReader.Mode.ALL);
  50     }
  51
  52     /**
  53      * Opens a new journal reader with the given reader mode.
  54      *
  55      * @param index The index from which to begin reading entries.
  56      * @param mode The mode in which to read entries.
  57      * @return The journal reader.
  58      */
  59     @Override
  60     public JournalReader<E> openReader(final long index, final JournalReader.Mode mode) {
  61         final var byteReader = switch (mode) {
  62             case ALL -> journal.openReader(index);
  63             case COMMITS -> journal.openCommitsReader(index);
  64         };
  65         return new SegmentedJournalReader<>(byteReader, mapper);
  66     }
  67
  68     @Override
  69     public void close() {
  70         journal.close();
  71     }
  72
  73     /**
  74      * Compacts the journal up to the given index.
  75      * <p>
  76      * The semantics of compaction are not specified by this interface.
  77      *
  78      * @param index The index up to which to compact the journal.
  79      */
  80     public void compact(final long index) {
  81         journal.compact(index);
  82     }
  83
  84     /**
  85      * Returns a new segmented journal builder.
  86      *
  87      * @return A new segmented journal builder.
  88      */
  89     public static <E> Builder<E> builder() {
  90         return new Builder<>();
  91     }
  92
  93     public static final class Builder<E> {
  94         private final SegmentedByteBufJournal.Builder byteJournalBuilder = SegmentedByteBufJournal.builder();
  95         private ByteBufMapper<E> mapper;
  96
  97         private Builder() {
  98             // on purpose
  99         }
 100
 101         /**
 102          * Sets the journal name.
 103          *
 104          * @param name The journal name.
 105          * @return The journal builder.
 106          */
 107         public Builder<E> withName(final String name) {
 108             byteJournalBuilder.withName(name);
 109             return this;
 110         }
 111
 112         /**
 113          * Sets the journal storage level.
 114          * <p>
 115          * The storage level indicates how individual entries will be persisted in the journal.
 116          *
 117          * @param storageLevel The log storage level.
 118          * @return The journal builder.
 119          */
 120         public Builder<E> withStorageLevel(final StorageLevel storageLevel) {
 121             byteJournalBuilder.withStorageLevel(storageLevel);
 122             return this;
 123         }
 124
 125         /**
 126          * Sets the journal storage directory.
 127          * <p>
 128          * The journal will write segment files into the provided directory.
 129          *
 130          * @param directory The journal storage directory.
 131          * @return The journal builder.
 132          * @throws NullPointerException If the {@code directory} is {@code null}
 133          */
 134         public Builder<E> withDirectory(final String directory) {
 135             byteJournalBuilder.withDirectory(directory);
 136             return this;
 137         }
 138
 139         /**
 140          * Sets the journal storage directory.
 141          * <p>
 142          * The journal will write segment files into the provided directory.
 143          *
 144          * @param directory The journal storage directory.
 145          * @return The journal builder.
 146          * @throws NullPointerException If the {@code directory} is {@code null}
 147          */
 148         public Builder<E> withDirectory(final File directory) {
 149              byteJournalBuilder.withDirectory(directory);
 150             return this;
 151         }
 152
 153         /**
 154          * Sets the journal namespace.
 155          *
 156          * @param namespace The journal serializer.
 157          * @return The journal builder.
 158          * @deprecated due to serialization refactoring, use {@link Builder#withMapper(ByteBufMapper)} instead
 159          */
 160         @Deprecated(forRemoval = true, since="9.0.3")
 161         public Builder<E> withNamespace(final JournalSerdes namespace) {
 162             return withMapper(requireNonNull(namespace, "namespace cannot be null").toMapper());
 163         }
 164
 165         /**
 166          * Sets journal serializer.
 167          *
 168          * @param mapper Journal serializer
 169          * @return The journal builder
 170          */
 171         public Builder<E> withMapper(final ByteBufMapper<E> mapper) {
 172             this.mapper = requireNonNull(mapper);
 173             return this;
 174         }
 175
 176         /**
 177          * Sets the maximum segment size in bytes.
 178          * <p>
 179          * The maximum segment size dictates when journal should roll over to new segments. As entries are written
 180          * to a journal segment, once the size of the segment surpasses the configured maximum segment size, the
 181          * journal will create a new segment and append new entries to that segment.
 182          * <p>
 183          * By default, the maximum segment size is 32M.
 184          *
 185          * @param maxSegmentSize The maximum segment size in bytes.
 186          * @return The storage builder.
 187          * @throws IllegalArgumentException If the {@code maxSegmentSize} is not positive
 188          */
 189         public Builder<E> withMaxSegmentSize(final int maxSegmentSize) {
 190             byteJournalBuilder.withMaxSegmentSize(maxSegmentSize);
 191             return this;
 192         }
 193
 194         /**
 195          * Sets the maximum entry size in bytes.
 196          *
 197          * @param maxEntrySize the maximum entry size in bytes
 198          * @return the storage builder
 199          * @throws IllegalArgumentException if the {@code maxEntrySize} is not positive
 200          */
 201         public Builder<E> withMaxEntrySize(final int maxEntrySize) {
 202             byteJournalBuilder.withMaxEntrySize(maxEntrySize);
 203             return this;
 204         }
 205
 206         /**
 207          * Sets the maximum number of entries per segment.
 208          *
 209          * @param maxEntriesPerSegment The maximum number of entries allowed per segment.
 210          * @return The journal builder.
 211          * @deprecated since 3.0.2, no longer used
 212          */
 213         @Deprecated
 214         public Builder<E> withMaxEntriesPerSegment(final int maxEntriesPerSegment) {
 215             // ignore
 216             return this;
 217         }
 218
 219         /**
 220          * Sets the journal index density.
 221          * <p>
 222          * The index density is the frequency at which the position of entries written to the journal will be recorded
 223          * in an in-memory index for faster seeking.
 224          *
 225          * @param indexDensity the index density
 226          * @return the journal builder
 227          * @throws IllegalArgumentException if the density is not between 0 and 1
 228          */
 229         public Builder<E> withIndexDensity(final double indexDensity) {
 230             byteJournalBuilder.withIndexDensity(indexDensity);
 231             return this;
 232         }
 233
 234         /**
 235          * Enables flushing buffers to disk when entries are committed to a segment.
 236          * <p>
 237          * When flush-on-commit is enabled, log entry buffers will be automatically flushed to disk each time an
 238          * entry is committed in a given segment.
 239          *
 240          * @return The journal builder.
 241          */
 242         public Builder<E> withFlushOnCommit() {
 243             return withFlushOnCommit(true);
 244         }
 245
 246         /**
 247          * Enables flushing buffers to disk when entries are committed to a segment.
 248          * <p>
 249          * When flush-on-commit is enabled, log entry buffers will be automatically flushed to disk each time an
 250          * entry is committed in a given segment.
 251          *
 252          * @param flushOnCommit Whether to flush buffers to disk when entries are committed to a segment.
 253          * @return The journal builder.
 254          */
 255         public Builder<E> withFlushOnCommit(final boolean flushOnCommit) {
 256             byteJournalBuilder.withFlushOnCommit(flushOnCommit);
 257             return this;
 258         }
 259
 260         /**
 261          * Build the {@link SegmentedJournal}.
 262          *
 263          * @return {@link SegmentedJournal} instance.
 264          */
 265         public SegmentedJournal<E> build() {
 266             return new SegmentedJournal<>(byteJournalBuilder.build(), mapper);
 267         }
 268     }
 269 }