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 javax.annotation.Nullable;
  15 import javax.annotation.concurrent.NotThreadSafe;
  16 import org.opendaylight.controller.cluster.access.commands.CommitLocalTransactionRequest;
  17 import org.opendaylight.controller.cluster.access.commands.ExistsTransactionRequest;
  18 import org.opendaylight.controller.cluster.access.commands.ExistsTransactionSuccess;
  19 import org.opendaylight.controller.cluster.access.commands.ModifyTransactionRequest;
  20 import org.opendaylight.controller.cluster.access.commands.ModifyTransactionSuccess;
  21 import org.opendaylight.controller.cluster.access.commands.PersistenceProtocol;
  22 import org.opendaylight.controller.cluster.access.commands.ReadTransactionRequest;
  23 import org.opendaylight.controller.cluster.access.commands.ReadTransactionSuccess;
  24 import org.opendaylight.controller.cluster.access.commands.TransactionAbortRequest;
  25 import org.opendaylight.controller.cluster.access.commands.TransactionAbortSuccess;
  26 import org.opendaylight.controller.cluster.access.commands.TransactionCanCommitSuccess;
  27 import org.opendaylight.controller.cluster.access.commands.TransactionCommitSuccess;
  28 import org.opendaylight.controller.cluster.access.commands.TransactionDelete;
  29 import org.opendaylight.controller.cluster.access.commands.TransactionDoCommitRequest;
  30 import org.opendaylight.controller.cluster.access.commands.TransactionMerge;
  31 import org.opendaylight.controller.cluster.access.commands.TransactionModification;
  32 import org.opendaylight.controller.cluster.access.commands.TransactionPreCommitRequest;
  33 import org.opendaylight.controller.cluster.access.commands.TransactionPreCommitSuccess;
  34 import org.opendaylight.controller.cluster.access.commands.TransactionRequest;
  35 import org.opendaylight.controller.cluster.access.commands.TransactionSuccess;
  36 import org.opendaylight.controller.cluster.access.commands.TransactionWrite;
  37 import org.opendaylight.controller.cluster.access.concepts.RequestEnvelope;
  38 import org.opendaylight.controller.cluster.access.concepts.RequestException;
  39 import org.opendaylight.controller.cluster.access.concepts.RuntimeRequestException;
  40 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
  41 import org.opendaylight.controller.cluster.access.concepts.UnsupportedRequestException;
  42 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  43 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
  44 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
  45 import org.slf4j.Logger;
  46 import org.slf4j.LoggerFactory;
  47
  48 /**
  49  * Frontend read-write transaction state as observed by the shard leader.
  50  *
  51  * @author Robert Varga
  52  */
  53 @NotThreadSafe
  54 final class FrontendReadWriteTransaction extends FrontendTransaction {
  55     private static final Logger LOG = LoggerFactory.getLogger(FrontendReadWriteTransaction.class);
  56
  57     private ReadWriteShardDataTreeTransaction openTransaction;
  58     private DataTreeModification sealedModification;
  59     private ShardDataTreeCohort readyCohort;
  60
  61     private FrontendReadWriteTransaction(final AbstractFrontendHistory history, final TransactionIdentifier id,
  62             final ReadWriteShardDataTreeTransaction transaction) {
  63         super(history, id);
  64         this.openTransaction = Preconditions.checkNotNull(transaction);
  65     }
  66
  67     private FrontendReadWriteTransaction(final AbstractFrontendHistory history, final TransactionIdentifier id,
  68             final DataTreeModification mod) {
  69         super(history, id);
  70         this.sealedModification = Preconditions.checkNotNull(mod);
  71     }
  72
  73     static FrontendReadWriteTransaction createOpen(final AbstractFrontendHistory history,
  74             final ReadWriteShardDataTreeTransaction transaction) {
  75         return new FrontendReadWriteTransaction(history, transaction.getIdentifier(), transaction);
  76     }
  77
  78     static FrontendReadWriteTransaction createReady(final AbstractFrontendHistory history,
  79             final TransactionIdentifier id, final DataTreeModification mod) {
  80         return new FrontendReadWriteTransaction(history, id, mod);
  81     }
  82
  83     // Sequence has already been checked
  84     @Override
  85     @Nullable TransactionSuccess<?> handleRequest(final TransactionRequest<?> request, final RequestEnvelope envelope,
  86             final long now) throws RequestException {
  87         if (request instanceof ModifyTransactionRequest) {
  88             return handleModifyTransaction((ModifyTransactionRequest) request, envelope, now);
  89         } else if (request instanceof CommitLocalTransactionRequest) {
  90             handleCommitLocalTransaction((CommitLocalTransactionRequest) request, envelope, now);
  91             return null;
  92         } else if (request instanceof ExistsTransactionRequest) {
  93             return handleExistsTransaction((ExistsTransactionRequest) request);
  94         } else if (request instanceof ReadTransactionRequest) {
  95             return handleReadTransaction((ReadTransactionRequest) request);
  96         } else if (request instanceof TransactionPreCommitRequest) {
  97             handleTransactionPreCommit((TransactionPreCommitRequest) request, envelope, now);
  98             return null;
  99         } else if (request instanceof TransactionDoCommitRequest) {
 100             handleTransactionDoCommit((TransactionDoCommitRequest) request, envelope, now);
 101             return null;
 102         } else if (request instanceof TransactionAbortRequest) {
 103             return handleTransactionAbort((TransactionAbortRequest) request, envelope, now);
 104         } else {
 105             throw new UnsupportedRequestException(request);
 106         }
 107     }
 108
 109     private void handleTransactionPreCommit(final TransactionPreCommitRequest request,
 110             final RequestEnvelope envelope, final long now) throws RequestException {
 111         readyCohort.preCommit(new FutureCallback<DataTreeCandidate>() {
 112             @Override
 113             public void onSuccess(final DataTreeCandidate result) {
 114                 recordAndSendSuccess(envelope, now, new TransactionPreCommitSuccess(readyCohort.getIdentifier(),
 115                     request.getSequence()));
 116             }
 117
 118             @Override
 119             public void onFailure(final Throwable failure) {
 120                 recordAndSendFailure(envelope, now, new RuntimeRequestException("Precommit failed", failure));
 121                 readyCohort = null;
 122             }
 123         });
 124     }
 125
 126     private void handleTransactionDoCommit(final TransactionDoCommitRequest request, final RequestEnvelope envelope,
 127             final long now) throws RequestException {
 128         readyCohort.commit(new FutureCallback<UnsignedLong>() {
 129             @Override
 130             public void onSuccess(final UnsignedLong result) {
 131                 successfulCommit(envelope, now);
 132             }
 133
 134             @Override
 135             public void onFailure(final Throwable failure) {
 136                 recordAndSendFailure(envelope, now, new RuntimeRequestException("Commit failed", failure));
 137                 readyCohort = null;
 138             }
 139         });
 140     }
 141
 142     private TransactionSuccess<?> handleTransactionAbort(final TransactionAbortRequest request,
 143             final RequestEnvelope envelope, final long now) throws RequestException {
 144         if (readyCohort == null) {
 145             openTransaction.abort();
 146             return new TransactionAbortSuccess(getIdentifier(), request.getSequence());
 147         }
 148
 149         readyCohort.abort(new FutureCallback<Void>() {
 150             @Override
 151             public void onSuccess(final Void result) {
 152                 readyCohort = null;
 153                 recordAndSendSuccess(envelope, now, new TransactionAbortSuccess(getIdentifier(),
 154                     request.getSequence()));
 155                 LOG.debug("Transaction {} aborted", getIdentifier());
 156             }
 157
 158             @Override
 159             public void onFailure(final Throwable failure) {
 160                 readyCohort = null;
 161                 LOG.warn("Transaction {} abort failed", getIdentifier(), failure);
 162                 recordAndSendFailure(envelope, now, new RuntimeRequestException("Abort failed", failure));
 163             }
 164         });
 165         return null;
 166     }
 167
 168     private void coordinatedCommit(final RequestEnvelope envelope, final long now) {
 169         readyCohort.canCommit(new FutureCallback<Void>() {
 170             @Override
 171             public void onSuccess(final Void result) {
 172                 recordAndSendSuccess(envelope, now, new TransactionCanCommitSuccess(readyCohort.getIdentifier(),
 173                     envelope.getMessage().getSequence()));
 174             }
 175
 176             @Override
 177             public void onFailure(final Throwable failure) {
 178                 recordAndSendFailure(envelope, now, new RuntimeRequestException("CanCommit failed", failure));
 179                 readyCohort = null;
 180             }
 181         });
 182     }
 183
 184     private void directCommit(final RequestEnvelope envelope, final long now) {
 185         readyCohort.canCommit(new FutureCallback<Void>() {
 186             @Override
 187             public void onSuccess(final Void result) {
 188                 successfulDirectCanCommit(envelope, now);
 189             }
 190
 191             @Override
 192             public void onFailure(final Throwable failure) {
 193                 recordAndSendFailure(envelope, now, new RuntimeRequestException("CanCommit failed", failure));
 194                 readyCohort = null;
 195             }
 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 DataTreeModification modification = openTransaction.getSnapshot();
 274         for (TransactionModification m : request.getModifications()) {
 275             if (m instanceof TransactionDelete) {
 276                 modification.delete(m.getPath());
 277             } else if (m instanceof TransactionWrite) {
 278                 modification.write(m.getPath(), ((TransactionWrite) m).getData());
 279             } else if (m instanceof TransactionMerge) {
 280                 modification.merge(m.getPath(), ((TransactionMerge) m).getData());
 281             } else {
 282                 LOG.warn("{}: ignoring unhandled modification {}", history().persistenceId(), m);
 283             }
 284         }
 285
 286         final java.util.Optional<PersistenceProtocol> maybeProto = request.getPersistenceProtocol();
 287         if (!maybeProto.isPresent()) {
 288             return replyModifySuccess(request.getSequence());
 289         }
 290
 291         switch (maybeProto.get()) {
 292             case ABORT:
 293                 openTransaction.abort();
 294                 openTransaction = null;
 295                 return replyModifySuccess(request.getSequence());
 296             case SIMPLE:
 297                 readyCohort = openTransaction.ready();
 298                 openTransaction = null;
 299                 directCommit(envelope, now);
 300                 return null;
 301             case THREE_PHASE:
 302                 readyCohort = openTransaction.ready();
 303                 openTransaction = null;
 304                 coordinatedCommit(envelope, now);
 305                 return null;
 306             default:
 307                 throw new UnsupportedRequestException(request);
 308         }
 309     }
 310 }