opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/FrontendReadWriteTransaction.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. 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.cluster.datastore;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.primitives.UnsignedLong;
  13 import com.google.common.util.concurrent.FutureCallback;
  14 import java.util.Collection;
  15 import javax.annotation.Nullable;
  16 import javax.annotation.concurrent.NotThreadSafe;
  17 import org.opendaylight.controller.cluster.access.commands.CommitLocalTransactionRequest;
  18 import org.opendaylight.controller.cluster.access.commands.ExistsTransactionRequest;
  19 import org.opendaylight.controller.cluster.access.commands.ExistsTransactionSuccess;
  20 import org.opendaylight.controller.cluster.access.commands.ModifyTransactionRequest;
  21 import org.opendaylight.controller.cluster.access.commands.ModifyTransactionSuccess;
  22 import org.opendaylight.controller.cluster.access.commands.PersistenceProtocol;
  23 import org.opendaylight.controller.cluster.access.commands.ReadTransactionRequest;
  24 import org.opendaylight.controller.cluster.access.commands.ReadTransactionSuccess;
  25 import org.opendaylight.controller.cluster.access.commands.TransactionAbortRequest;
  26 import org.opendaylight.controller.cluster.access.commands.TransactionAbortSuccess;
  27 import org.opendaylight.controller.cluster.access.commands.TransactionCanCommitSuccess;
  28 import org.opendaylight.controller.cluster.access.commands.TransactionCommitSuccess;
  29 import org.opendaylight.controller.cluster.access.commands.TransactionDelete;
  30 import org.opendaylight.controller.cluster.access.commands.TransactionDoCommitRequest;
  31 import org.opendaylight.controller.cluster.access.commands.TransactionMerge;
  32 import org.opendaylight.controller.cluster.access.commands.TransactionModification;
  33 import org.opendaylight.controller.cluster.access.commands.TransactionPreCommitRequest;
  34 import org.opendaylight.controller.cluster.access.commands.TransactionPreCommitSuccess;
  35 import org.opendaylight.controller.cluster.access.commands.TransactionRequest;
  36 import org.opendaylight.controller.cluster.access.commands.TransactionSuccess;
  37 import org.opendaylight.controller.cluster.access.commands.TransactionWrite;
  38 import org.opendaylight.controller.cluster.access.concepts.RequestEnvelope;
  39 import org.opendaylight.controller.cluster.access.concepts.RequestException;
  40 import org.opendaylight.controller.cluster.access.concepts.RuntimeRequestException;
  41 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
  42 import org.opendaylight.controller.cluster.access.concepts.UnsupportedRequestException;
  43 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  44 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
  45 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
  46 import org.slf4j.Logger;
  47 import org.slf4j.LoggerFactory;
  48
  49 /**
  50  * Frontend read-write transaction state as observed by the shard leader.
  51  *
  52  * @author Robert Varga
  53  */
  54 @NotThreadSafe
  55 final class FrontendReadWriteTransaction extends FrontendTransaction {
  56     private static final Logger LOG = LoggerFactory.getLogger(FrontendReadWriteTransaction.class);
  57
  58     private ReadWriteShardDataTreeTransaction openTransaction;
  59     private DataTreeModification sealedModification;
  60     private ShardDataTreeCohort readyCohort;
  61
  62     private FrontendReadWriteTransaction(final AbstractFrontendHistory history, final TransactionIdentifier id,
  63             final ReadWriteShardDataTreeTransaction transaction) {
  64         super(history, id);
  65         this.openTransaction = Preconditions.checkNotNull(transaction);
  66     }
  67
  68     private FrontendReadWriteTransaction(final AbstractFrontendHistory history, final TransactionIdentifier id,
  69             final DataTreeModification mod) {
  70         super(history, id);
  71         this.sealedModification = Preconditions.checkNotNull(mod);
  72     }
  73
  74     static FrontendReadWriteTransaction createOpen(final AbstractFrontendHistory history,
  75             final ReadWriteShardDataTreeTransaction transaction) {
  76         return new FrontendReadWriteTransaction(history, transaction.getIdentifier(), transaction);
  77     }
  78
  79     static FrontendReadWriteTransaction createReady(final AbstractFrontendHistory history,
  80             final TransactionIdentifier id, final DataTreeModification mod) {
  81         return new FrontendReadWriteTransaction(history, id, mod);
  82     }
  83
  84     // Sequence has already been checked
  85     @Override
  86     @Nullable TransactionSuccess<?> handleRequest(final TransactionRequest<?> request, final RequestEnvelope envelope,
  87             final long now) throws RequestException {
  88         if (request instanceof ModifyTransactionRequest) {
  89             return handleModifyTransaction((ModifyTransactionRequest) request, envelope, now);
  90         } else if (request instanceof CommitLocalTransactionRequest) {
  91             handleCommitLocalTransaction((CommitLocalTransactionRequest) request, envelope, now);
  92             return null;
  93         } else if (request instanceof ExistsTransactionRequest) {
  94             return handleExistsTransaction((ExistsTransactionRequest) request);
  95         } else if (request instanceof ReadTransactionRequest) {
  96             return handleReadTransaction((ReadTransactionRequest) request);
  97         } else if (request instanceof TransactionPreCommitRequest) {
  98             handleTransactionPreCommit((TransactionPreCommitRequest) request, envelope, now);
  99             return null;
 100         } else if (request instanceof TransactionDoCommitRequest) {
 101             handleTransactionDoCommit((TransactionDoCommitRequest) request, envelope, now);
 102             return null;
 103         } else if (request instanceof TransactionAbortRequest) {
 104             return handleTransactionAbort((TransactionAbortRequest) request, envelope, now);
 105         } else {
 106             throw new UnsupportedRequestException(request);
 107         }
 108     }
 109
 110     private void handleTransactionPreCommit(final TransactionPreCommitRequest request,
 111             final RequestEnvelope envelope, final long now) throws RequestException {
 112         readyCohort.preCommit(new FutureCallback<DataTreeCandidate>() {
 113             @Override
 114             public void onSuccess(final DataTreeCandidate result) {
 115                 recordAndSendSuccess(envelope, now, new TransactionPreCommitSuccess(readyCohort.getIdentifier(),
 116                     request.getSequence()));
 117             }
 118
 119             @Override
 120             public void onFailure(final Throwable failure) {
 121                 recordAndSendFailure(envelope, now, new RuntimeRequestException("Precommit failed", failure));
 122                 readyCohort = null;
 123             }
 124         });
 125     }
 126
 127     private void handleTransactionDoCommit(final TransactionDoCommitRequest request, final RequestEnvelope envelope,
 128             final long now) throws RequestException {
 129         readyCohort.commit(new FutureCallback<UnsignedLong>() {
 130             @Override
 131             public void onSuccess(final UnsignedLong result) {
 132                 successfulCommit(envelope, now);
 133             }
 134
 135             @Override
 136             public void onFailure(final Throwable failure) {
 137                 recordAndSendFailure(envelope, now, new RuntimeRequestException("Commit failed", failure));
 138                 readyCohort = null;
 139             }
 140         });
 141     }
 142
 143     private TransactionSuccess<?> handleTransactionAbort(final TransactionAbortRequest request,
 144             final RequestEnvelope envelope, final long now) throws RequestException {
 145         if (readyCohort == null) {
 146             openTransaction.abort();
 147             return new TransactionAbortSuccess(getIdentifier(), request.getSequence());
 148         }
 149
 150         readyCohort.abort(new FutureCallback<Void>() {
 151             @Override
 152             public void onSuccess(final Void result) {
 153                 readyCohort = null;
 154                 recordAndSendSuccess(envelope, now, new TransactionAbortSuccess(getIdentifier(),
 155                     request.getSequence()));
 156                 LOG.debug("Transaction {} aborted", getIdentifier());
 157             }
 158
 159             @Override
 160             public void onFailure(final Throwable failure) {
 161                 readyCohort = null;
 162                 LOG.warn("Transaction {} abort failed", getIdentifier(), failure);
 163                 recordAndSendFailure(envelope, now, new RuntimeRequestException("Abort failed", failure));
 164             }
 165         });
 166         return null;
 167     }
 168
 169     private void coordinatedCommit(final RequestEnvelope envelope, final long now) {
 170         readyCohort.canCommit(new FutureCallback<Void>() {
 171             @Override
 172             public void onSuccess(final Void result) {
 173                 recordAndSendSuccess(envelope, now, new TransactionCanCommitSuccess(readyCohort.getIdentifier(),
 174                     envelope.getMessage().getSequence()));
 175             }
 176
 177             @Override
 178             public void onFailure(final Throwable failure) {
 179                 recordAndSendFailure(envelope, now, new RuntimeRequestException("CanCommit failed", failure));
 180                 readyCohort = null;
 181             }
 182         });
 183     }
 184
 185     private void directCommit(final RequestEnvelope envelope, final long now) {
 186         readyCohort.canCommit(new FutureCallback<Void>() {
 187             @Override
 188             public void onSuccess(final Void result) {
 189                 successfulDirectCanCommit(envelope, now);
 190             }
 191
 192             @Override
 193             public void onFailure(final Throwable failure) {
 194                 recordAndSendFailure(envelope, now, new RuntimeRequestException("CanCommit failed", failure));
 195                 readyCohort = null;
 196             }
 197         });
 198     }
 199
 200     private void successfulDirectCanCommit(final RequestEnvelope envelope, final long startTime) {
 201         readyCohort.preCommit(new FutureCallback<DataTreeCandidate>() {
 202             @Override
 203             public void onSuccess(final DataTreeCandidate result) {
 204                 successfulDirectPreCommit(envelope, startTime);
 205             }
 206
 207             @Override
 208             public void onFailure(final Throwable failure) {
 209                 recordAndSendFailure(envelope, startTime, new RuntimeRequestException("PreCommit failed", failure));
 210                 readyCohort = null;
 211             }
 212         });
 213     }
 214
 215     private void successfulDirectPreCommit(final RequestEnvelope envelope, final long startTime) {
 216         readyCohort.commit(new FutureCallback<UnsignedLong>() {
 217
 218             @Override
 219             public void onSuccess(final UnsignedLong result) {
 220                 successfulCommit(envelope, startTime);
 221             }
 222
 223             @Override
 224             public void onFailure(final Throwable failure) {
 225                 recordAndSendFailure(envelope, startTime, new RuntimeRequestException("DoCommit failed", failure));
 226                 readyCohort = null;
 227             }
 228         });
 229     }
 230
 231     private void successfulCommit(final RequestEnvelope envelope, final long startTime) {
 232         recordAndSendSuccess(envelope, startTime, new TransactionCommitSuccess(readyCohort.getIdentifier(),
 233             envelope.getMessage().getSequence()));
 234         readyCohort = null;
 235     }
 236
 237     private void handleCommitLocalTransaction(final CommitLocalTransactionRequest request,
 238             final RequestEnvelope envelope, final long now) throws RequestException {
 239         if (sealedModification.equals(request.getModification())) {
 240             readyCohort = history().createReadyCohort(getIdentifier(), sealedModification);
 241
 242             if (request.isCoordinated()) {
 243                 coordinatedCommit(envelope, now);
 244             } else {
 245                 directCommit(envelope, now);
 246             }
 247         } else {
 248             throw new UnsupportedRequestException(request);
 249         }
 250     }
 251
 252     private ExistsTransactionSuccess handleExistsTransaction(final ExistsTransactionRequest request)
 253             throws RequestException {
 254         final Optional<NormalizedNode<?, ?>> data = openTransaction.getSnapshot().readNode(request.getPath());
 255         return recordSuccess(request.getSequence(), new ExistsTransactionSuccess(getIdentifier(), request.getSequence(),
 256             data.isPresent()));
 257     }
 258
 259     private ReadTransactionSuccess handleReadTransaction(final ReadTransactionRequest request)
 260             throws RequestException {
 261         final Optional<NormalizedNode<?, ?>> data = openTransaction.getSnapshot().readNode(request.getPath());
 262         return recordSuccess(request.getSequence(), new ReadTransactionSuccess(getIdentifier(), request.getSequence(),
 263             data));
 264     }
 265
 266     private ModifyTransactionSuccess replyModifySuccess(final long sequence) {
 267         return recordSuccess(sequence, new ModifyTransactionSuccess(getIdentifier(), sequence));
 268     }
 269
 270     private @Nullable TransactionSuccess<?> handleModifyTransaction(final ModifyTransactionRequest request,
 271             final RequestEnvelope envelope, final long now) throws RequestException {
 272
 273         final Collection<TransactionModification> mods = request.getModifications();
 274         if (!mods.isEmpty()) {
 275             final DataTreeModification modification = openTransaction.getSnapshot();
 276             for (TransactionModification m : mods) {
 277                 if (m instanceof TransactionDelete) {
 278                     modification.delete(m.getPath());
 279                 } else if (m instanceof TransactionWrite) {
 280                     modification.write(m.getPath(), ((TransactionWrite) m).getData());
 281                 } else if (m instanceof TransactionMerge) {
 282                     modification.merge(m.getPath(), ((TransactionMerge) m).getData());
 283                 } else {
 284                     LOG.warn("{}: ignoring unhandled modification {}", history().persistenceId(), m);
 285                 }
 286             }
 287         }
 288
 289         final java.util.Optional<PersistenceProtocol> maybeProto = request.getPersistenceProtocol();
 290         if (!maybeProto.isPresent()) {
 291             return replyModifySuccess(request.getSequence());
 292         }
 293
 294         switch (maybeProto.get()) {
 295             case ABORT:
 296                 openTransaction.abort();
 297                 openTransaction = null;
 298                 return replyModifySuccess(request.getSequence());
 299             case READY:
 300                 ensureReady();
 301                 return replyModifySuccess(request.getSequence());
 302             case SIMPLE:
 303                 ensureReady();
 304                 directCommit(envelope, now);
 305                 return null;
 306             case THREE_PHASE:
 307                 ensureReady();
 308                 coordinatedCommit(envelope, now);
 309                 return null;
 310             default:
 311                 throw new UnsupportedRequestException(request);
 312         }
 313     }
 314
 315     private void ensureReady() {
 316         // We may have a combination of READY + SIMPLE/THREE_PHASE , in which case we want to ready the transaction
 317         // only once.
 318         if (readyCohort == null) {
 319             readyCohort = openTransaction.ready();
 320             LOG.debug("{}: transitioned {} to ready", history().persistenceId(), openTransaction.getIdentifier());
 321             openTransaction = null;
 322         }
 323     }
 324 }