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