opendaylight/md-sal/sal-akka-segmented-journal/src/main/java/org/opendaylight/controller/akka/segjournal/SegmentedJournalActor.java

   1 /*
   2  * Copyright (c) 2019 Pantheon Technologies, s.r.o. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.akka.segjournal;
   9
  10 import static com.google.common.base.Verify.verifyNotNull;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import akka.actor.AbstractActor;
  14 import akka.actor.Props;
  15 import akka.persistence.AtomicWrite;
  16 import akka.persistence.PersistentRepr;
  17 import com.codahale.metrics.Histogram;
  18 import com.codahale.metrics.Meter;
  19 import com.codahale.metrics.MetricRegistry;
  20 import com.codahale.metrics.Timer;
  21 import com.google.common.base.MoreObjects;
  22 import com.google.common.base.Stopwatch;
  23 import io.atomix.storage.journal.Indexed;
  24 import io.atomix.storage.journal.JournalSerdes;
  25 import io.atomix.storage.journal.SegmentedJournal;
  26 import io.atomix.storage.journal.StorageLevel;
  27 import java.io.File;
  28 import java.util.ArrayList;
  29 import java.util.List;
  30 import java.util.Optional;
  31 import java.util.concurrent.TimeUnit;
  32 import java.util.function.Consumer;
  33 import org.opendaylight.controller.cluster.common.actor.MeteringBehavior;
  34 import org.opendaylight.controller.cluster.reporting.MetricsReporter;
  35 import org.slf4j.Logger;
  36 import org.slf4j.LoggerFactory;
  37 import scala.concurrent.Future;
  38 import scala.concurrent.Promise;
  39
  40 /**
  41  * This actor handles a single PersistentActor's journal. The journal is split into two {@link SegmentedJournal}s:
  42  * <ul>
  43  *     <li>A memory-mapped data journal, containing actual data entries</li>
  44  *     <li>A simple file journal, containing sequence numbers of last deleted entry</li>
  45  * </ul>
  46  *
  47  * <p>
  48  * This is a conscious design decision to minimize the amount of data that is being stored in the data journal while
  49  * speeding up normal operations. Since the SegmentedJournal is an append-only linear log and Akka requires the ability
  50  * to delete persistence entries, we need ability to mark a subset of a SegmentedJournal as deleted. While we could
  51  * treat such delete requests as normal events, this leads to a mismatch between SegmentedJournal indices (as exposed by
  52  * {@link Indexed}) and Akka sequence numbers -- requiring us to potentially perform costly deserialization to find the
  53  * index corresponding to a particular sequence number, or maintain moderately-complex logic and data structures to
  54  * perform that mapping in sub-linear time complexity.
  55  *
  56  * <p>
  57  * Split-file approach allows us to treat sequence numbers and indices as equivalent, without maintaining any explicit
  58  * mapping information. The only additional information we need to maintain is the last deleted sequence number.
  59  */
  60 final class SegmentedJournalActor extends AbstractActor {
  61     abstract static class AsyncMessage<T> {
  62         final Promise<T> promise = Promise.apply();
  63     }
  64
  65     private static final class ReadHighestSequenceNr extends AsyncMessage<Long> {
  66         private final long fromSequenceNr;
  67
  68         ReadHighestSequenceNr(final long fromSequenceNr) {
  69             this.fromSequenceNr = fromSequenceNr;
  70         }
  71
  72         @Override
  73         public String toString() {
  74             return MoreObjects.toStringHelper(this).add("fromSequenceNr", fromSequenceNr).toString();
  75         }
  76     }
  77
  78     static final class ReplayMessages extends AsyncMessage<Void> {
  79         private final long fromSequenceNr;
  80         final long toSequenceNr;
  81         final long max;
  82         final Consumer<PersistentRepr> replayCallback;
  83
  84         ReplayMessages(final long fromSequenceNr,
  85                 final long toSequenceNr, final long max, final Consumer<PersistentRepr> replayCallback) {
  86             this.fromSequenceNr = fromSequenceNr;
  87             this.toSequenceNr = toSequenceNr;
  88             this.max = max;
  89             this.replayCallback = requireNonNull(replayCallback);
  90         }
  91
  92         @Override
  93         public String toString() {
  94             return MoreObjects.toStringHelper(this).add("fromSequenceNr", fromSequenceNr)
  95                     .add("toSequenceNr", toSequenceNr).add("max", max).toString();
  96         }
  97     }
  98
  99     static final class WriteMessages {
 100         private final List<AtomicWrite> requests = new ArrayList<>();
 101         private final List<Promise<Optional<Exception>>> results = new ArrayList<>();
 102
 103         Future<Optional<Exception>> add(final AtomicWrite write) {
 104             final var promise = Promise.<Optional<Exception>>apply();
 105             requests.add(write);
 106             results.add(promise);
 107             return promise.future();
 108         }
 109
 110         int size() {
 111             return requests.size();
 112         }
 113
 114         AtomicWrite getRequest(final int index) {
 115             return requests.get(index);
 116         }
 117
 118         void setFailure(final int index, final Exception cause) {
 119             results.get(index).success(Optional.of(cause));
 120
 121         }
 122
 123         void setSuccess(final int index) {
 124             results.get(index).success(Optional.empty());
 125         }
 126
 127         @Override
 128         public String toString() {
 129             return MoreObjects.toStringHelper(this).add("requests", requests).toString();
 130         }
 131     }
 132
 133     private static final class DeleteMessagesTo extends AsyncMessage<Void> {
 134         final long toSequenceNr;
 135
 136         DeleteMessagesTo(final long toSequenceNr) {
 137             this.toSequenceNr = toSequenceNr;
 138         }
 139
 140         @Override
 141         public String toString() {
 142             return MoreObjects.toStringHelper(this).add("toSequenceNr", toSequenceNr).toString();
 143         }
 144     }
 145
 146     private static final Logger LOG = LoggerFactory.getLogger(SegmentedJournalActor.class);
 147     private static final JournalSerdes DELETE_NAMESPACE = JournalSerdes.builder()
 148         .register(new LongSerdes(), Long.class)
 149         .build();
 150     private static final int DELETE_SEGMENT_SIZE = 64 * 1024;
 151
 152     private final String persistenceId;
 153     private final StorageLevel storage;
 154     private final int maxSegmentSize;
 155     private final int maxEntrySize;
 156     private final File directory;
 157
 158     // Tracks the time it took us to write a batch of messages
 159     private Timer batchWriteTime;
 160     // Tracks the number of individual messages written
 161     private Meter messageWriteCount;
 162     // Tracks the size distribution of messages
 163     private Histogram messageSize;
 164
 165     private DataJournal dataJournal;
 166     private SegmentedJournal<Long> deleteJournal;
 167     private long lastDelete;
 168
 169     SegmentedJournalActor(final String persistenceId, final File directory, final StorageLevel storage,
 170             final int maxEntrySize, final int maxSegmentSize) {
 171         this.persistenceId = requireNonNull(persistenceId);
 172         this.directory = requireNonNull(directory);
 173         this.storage = requireNonNull(storage);
 174         this.maxEntrySize = maxEntrySize;
 175         this.maxSegmentSize = maxSegmentSize;
 176     }
 177
 178     static Props props(final String persistenceId, final File directory, final StorageLevel storage,
 179             final int maxEntrySize, final int maxSegmentSize) {
 180         return Props.create(SegmentedJournalActor.class, requireNonNull(persistenceId), directory, storage,
 181             maxEntrySize, maxSegmentSize);
 182     }
 183
 184     @Override
 185     public Receive createReceive() {
 186         return receiveBuilder()
 187                 .match(DeleteMessagesTo.class, this::handleDeleteMessagesTo)
 188                 .match(ReadHighestSequenceNr.class, this::handleReadHighestSequenceNr)
 189                 .match(ReplayMessages.class, this::handleReplayMessages)
 190                 .match(WriteMessages.class, this::handleWriteMessages)
 191                 .matchAny(this::handleUnknown)
 192                 .build();
 193     }
 194
 195     @Override
 196     public void preStart() throws Exception {
 197         LOG.debug("{}: actor starting", persistenceId);
 198         super.preStart();
 199
 200         final var registry = MetricsReporter.getInstance(MeteringBehavior.DOMAIN).getMetricsRegistry();
 201         final var actorName = self().path().parent().toStringWithoutAddress() + '/' + directory.getName();
 202
 203         batchWriteTime = registry.timer(MetricRegistry.name(actorName, "batchWriteTime"));
 204         messageWriteCount = registry.meter(MetricRegistry.name(actorName, "messageWriteCount"));
 205         messageSize = registry.histogram(MetricRegistry.name(actorName, "messageSize"));
 206     }
 207
 208     @Override
 209     public void postStop() throws Exception {
 210         LOG.debug("{}: actor stopping", persistenceId);
 211         if (dataJournal != null) {
 212             dataJournal.close();
 213             LOG.debug("{}: data journal closed", persistenceId);
 214             dataJournal = null;
 215         }
 216         if (deleteJournal != null) {
 217             deleteJournal.close();
 218             LOG.debug("{}: delete journal closed", persistenceId);
 219             deleteJournal = null;
 220         }
 221         LOG.debug("{}: actor stopped", persistenceId);
 222         super.postStop();
 223     }
 224
 225     static AsyncMessage<Void> deleteMessagesTo(final long toSequenceNr) {
 226         return new DeleteMessagesTo(toSequenceNr);
 227     }
 228
 229     static AsyncMessage<Long> readHighestSequenceNr(final long fromSequenceNr) {
 230         return new ReadHighestSequenceNr(fromSequenceNr);
 231     }
 232
 233     static AsyncMessage<Void> replayMessages(final long fromSequenceNr, final long toSequenceNr, final long max,
 234             final Consumer<PersistentRepr> replayCallback) {
 235         return new ReplayMessages(fromSequenceNr, toSequenceNr, max, replayCallback);
 236     }
 237
 238     private void handleDeleteMessagesTo(final DeleteMessagesTo message) {
 239         ensureOpen();
 240
 241         LOG.debug("{}: delete messages {}", persistenceId, message);
 242         final long to = Long.min(dataJournal.lastWrittenSequenceNr(), message.toSequenceNr);
 243         LOG.debug("{}: adjusted delete to {}", persistenceId, to);
 244
 245         if (lastDelete < to) {
 246             LOG.debug("{}: deleting entries up to {}", persistenceId, to);
 247
 248             lastDelete = to;
 249             final var deleteWriter = deleteJournal.writer();
 250             final var entry = deleteWriter.append(lastDelete);
 251             deleteWriter.commit(entry.index());
 252             dataJournal.deleteTo(lastDelete);
 253
 254             LOG.debug("{}: compaction started", persistenceId);
 255             dataJournal.compactTo(lastDelete);
 256             deleteJournal.compact(entry.index());
 257             LOG.debug("{}: compaction finished", persistenceId);
 258         } else {
 259             LOG.debug("{}: entries up to {} already deleted", persistenceId, lastDelete);
 260         }
 261
 262         message.promise.success(null);
 263     }
 264
 265     private void handleReadHighestSequenceNr(final ReadHighestSequenceNr message) {
 266         LOG.debug("{}: looking for highest sequence on {}", persistenceId, message);
 267         final Long sequence;
 268         if (directory.isDirectory()) {
 269             ensureOpen();
 270             sequence = dataJournal.lastWrittenSequenceNr();
 271         } else {
 272             sequence = 0L;
 273         }
 274
 275         LOG.debug("{}: highest sequence is {}", message, sequence);
 276         message.promise.success(sequence);
 277     }
 278
 279     private void handleReplayMessages(final ReplayMessages message) {
 280         LOG.debug("{}: replaying messages {}", persistenceId, message);
 281         ensureOpen();
 282
 283         final long from = Long.max(lastDelete + 1, message.fromSequenceNr);
 284         LOG.debug("{}: adjusted fromSequenceNr to {}", persistenceId, from);
 285
 286         dataJournal.handleReplayMessages(message, from);
 287     }
 288
 289     private void handleWriteMessages(final WriteMessages message) {
 290         ensureOpen();
 291
 292         final var sw = Stopwatch.createStarted();
 293         final long start = dataJournal.lastWrittenSequenceNr();
 294         final long bytes = dataJournal.handleWriteMessages(message);
 295         sw.stop();
 296
 297         batchWriteTime.update(sw.elapsed(TimeUnit.NANOSECONDS), TimeUnit.NANOSECONDS);
 298         messageWriteCount.mark(dataJournal.lastWrittenSequenceNr() - start);
 299
 300         // log message after statistics are updated
 301         LOG.debug("{}: write of {} bytes completed in {}", persistenceId, bytes, sw);
 302     }
 303
 304     private void handleUnknown(final Object message) {
 305         LOG.error("{}: Received unknown message {}", persistenceId, message);
 306     }
 307
 308     private void ensureOpen() {
 309         if (dataJournal != null) {
 310             verifyNotNull(deleteJournal);
 311             return;
 312         }
 313
 314         final var sw = Stopwatch.createStarted();
 315         deleteJournal = SegmentedJournal.<Long>builder().withDirectory(directory).withName("delete")
 316                 .withNamespace(DELETE_NAMESPACE).withMaxSegmentSize(DELETE_SEGMENT_SIZE).build();
 317         final var lastEntry = deleteJournal.writer().getLastEntry();
 318         lastDelete = lastEntry == null ? 0 : lastEntry.entry();
 319
 320         dataJournal = new DataJournalV0(persistenceId, messageSize, context().system(), storage, directory,
 321             maxEntrySize, maxSegmentSize);
 322         dataJournal.deleteTo(lastDelete);
 323         LOG.debug("{}: journal open in {} with last index {}, deleted to {}", persistenceId, sw,
 324             dataJournal.lastWrittenSequenceNr(), lastDelete);
 325     }
 326 }