opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/databroker/actors/dds/LocalProxyTransaction.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.databroker.actors.dds;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.base.Verify;
  13 import com.google.common.util.concurrent.CheckedFuture;
  14 import com.google.common.util.concurrent.Futures;
  15 import java.util.function.Consumer;
  16 import javax.annotation.Nullable;
  17 import javax.annotation.concurrent.NotThreadSafe;
  18 import org.opendaylight.controller.cluster.access.commands.AbortLocalTransactionRequest;
  19 import org.opendaylight.controller.cluster.access.commands.CommitLocalTransactionRequest;
  20 import org.opendaylight.controller.cluster.access.commands.ExistsTransactionRequest;
  21 import org.opendaylight.controller.cluster.access.commands.ExistsTransactionSuccess;
  22 import org.opendaylight.controller.cluster.access.commands.ModifyTransactionRequest;
  23 import org.opendaylight.controller.cluster.access.commands.PersistenceProtocol;
  24 import org.opendaylight.controller.cluster.access.commands.ReadTransactionRequest;
  25 import org.opendaylight.controller.cluster.access.commands.ReadTransactionSuccess;
  26 import org.opendaylight.controller.cluster.access.commands.TransactionAbortRequest;
  27 import org.opendaylight.controller.cluster.access.commands.TransactionDelete;
  28 import org.opendaylight.controller.cluster.access.commands.TransactionDoCommitRequest;
  29 import org.opendaylight.controller.cluster.access.commands.TransactionMerge;
  30 import org.opendaylight.controller.cluster.access.commands.TransactionModification;
  31 import org.opendaylight.controller.cluster.access.commands.TransactionPreCommitRequest;
  32 import org.opendaylight.controller.cluster.access.commands.TransactionRequest;
  33 import org.opendaylight.controller.cluster.access.commands.TransactionWrite;
  34 import org.opendaylight.controller.cluster.access.concepts.Response;
  35 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
  36 import org.opendaylight.controller.cluster.datastore.util.AbstractDataTreeModificationCursor;
  37 import org.opendaylight.mdsal.common.api.ReadFailedException;
  38 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  39 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  40 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  41 import org.opendaylight.yangtools.yang.data.api.schema.tree.CursorAwareDataTreeModification;
  42 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
  43 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModificationCursor;
  44 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeSnapshot;
  45 import org.slf4j.Logger;
  46 import org.slf4j.LoggerFactory;
  47
  48 /**
  49  * An {@link AbstractProxyTransaction} for dispatching a transaction towards a shard leader which is co-located with
  50  * the client instance.
  51  *
  52  * <p>
  53  * It requires a {@link DataTreeSnapshot}, which is used to instantiated a new {@link DataTreeModification}. Operations
  54  * are then performed on this modification and once the transaction is submitted, the modification is sent to the shard
  55  * leader.
  56  *
  57  * <p>
  58  * This class is not thread-safe as usual with transactions. Since it does not interact with the backend until the
  59  * transaction is submitted, at which point this class gets out of the picture, this is not a cause for concern.
  60  *
  61  * @author Robert Varga
  62  */
  63 @NotThreadSafe
  64 final class LocalProxyTransaction extends AbstractProxyTransaction {
  65     private static final Logger LOG = LoggerFactory.getLogger(LocalProxyTransaction.class);
  66
  67     private final TransactionIdentifier identifier;
  68
  69     private CursorAwareDataTreeModification modification;
  70     private CursorAwareDataTreeModification sealedModification;
  71
  72     LocalProxyTransaction(final ProxyHistory parent, final TransactionIdentifier identifier,
  73         final CursorAwareDataTreeModification modification) {
  74         super(parent);
  75         this.identifier = Preconditions.checkNotNull(identifier);
  76         this.modification = Preconditions.checkNotNull(modification);
  77     }
  78
  79     @Override
  80     public TransactionIdentifier getIdentifier() {
  81         return identifier;
  82     }
  83
  84     @Override
  85     void doDelete(final YangInstanceIdentifier path) {
  86         modification.delete(path);
  87     }
  88
  89     @Override
  90     void doMerge(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
  91         modification.merge(path, data);
  92     }
  93
  94     @Override
  95     void doWrite(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
  96         modification.write(path, data);
  97     }
  98
  99     @Override
 100     CheckedFuture<Boolean, ReadFailedException> doExists(final YangInstanceIdentifier path) {
 101         return Futures.immediateCheckedFuture(modification.readNode(path).isPresent());
 102     }
 103
 104     @Override
 105     CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> doRead(final YangInstanceIdentifier path) {
 106         return Futures.immediateCheckedFuture(modification.readNode(path));
 107     }
 108
 109     private RuntimeException abortedException() {
 110         return new IllegalStateException("Tracker " + identifier + " has been aborted");
 111     }
 112
 113     private RuntimeException submittedException() {
 114         return new IllegalStateException("Tracker " + identifier + " has been submitted");
 115     }
 116
 117     @Override
 118     void doAbort() {
 119         sendAbort(new AbortLocalTransactionRequest(identifier, localActor()), response -> {
 120             LOG.debug("Transaction {} abort completed with {}", identifier, response);
 121         });
 122     }
 123
 124     @Override
 125     CommitLocalTransactionRequest commitRequest(final boolean coordinated) {
 126         final CommitLocalTransactionRequest ret = new CommitLocalTransactionRequest(identifier, nextSequence(),
 127             localActor(), modification, coordinated);
 128         modification = new FailedDataTreeModification(this::submittedException);
 129         return ret;
 130     }
 131
 132     @Override
 133     void doSeal() {
 134         modification.ready();
 135         sealedModification = modification;
 136     }
 137
 138     @Override
 139     void flushState(final AbstractProxyTransaction successor) {
 140         sealedModification.applyToCursor(new AbstractDataTreeModificationCursor() {
 141             @Override
 142             public void write(final PathArgument child, final NormalizedNode<?, ?> data) {
 143                 successor.write(current().node(child), data);
 144             }
 145
 146             @Override
 147             public void merge(final PathArgument child, final NormalizedNode<?, ?> data) {
 148                 successor.merge(current().node(child), data);
 149             }
 150
 151             @Override
 152             public void delete(final PathArgument child) {
 153                 successor.delete(current().node(child));
 154             }
 155         });
 156     }
 157
 158     DataTreeSnapshot getSnapshot() {
 159         Preconditions.checkState(sealedModification != null, "Proxy %s is not sealed yet", identifier);
 160         return sealedModification;
 161     }
 162
 163     private void applyModifyTransactionRequest(final ModifyTransactionRequest request,
 164             final @Nullable Consumer<Response<?, ?>> callback) {
 165         for (TransactionModification mod : request.getModifications()) {
 166             if (mod instanceof TransactionWrite) {
 167                 modification.write(mod.getPath(), ((TransactionWrite)mod).getData());
 168             } else if (mod instanceof TransactionMerge) {
 169                 modification.merge(mod.getPath(), ((TransactionMerge)mod).getData());
 170             } else if (mod instanceof TransactionDelete) {
 171                 modification.delete(mod.getPath());
 172             } else {
 173                 throw new IllegalArgumentException("Unsupported modification " + mod);
 174             }
 175         }
 176
 177         final java.util.Optional<PersistenceProtocol> maybeProtocol = request.getPersistenceProtocol();
 178         if (maybeProtocol.isPresent()) {
 179             seal();
 180             Verify.verify(callback != null, "Request {} has null callback", request);
 181
 182             switch (maybeProtocol.get()) {
 183                 case ABORT:
 184                     sendAbort(callback);
 185                     break;
 186                 case SIMPLE:
 187                     sendRequest(commitRequest(false), callback);
 188                     break;
 189                 case THREE_PHASE:
 190                     sendRequest(commitRequest(true), callback);
 191                     break;
 192                 default:
 193                     throw new IllegalArgumentException("Unhandled protocol " + maybeProtocol.get());
 194             }
 195         }
 196     }
 197
 198     @Override
 199     void handleForwardedRemoteRequest(final TransactionRequest<?> request,
 200             final @Nullable Consumer<Response<?, ?>> callback) {
 201         LOG.debug("Applying forwarded request {}", request);
 202
 203         if (request instanceof ModifyTransactionRequest) {
 204             applyModifyTransactionRequest((ModifyTransactionRequest) request, callback);
 205         } else if (request instanceof ReadTransactionRequest) {
 206             final YangInstanceIdentifier path = ((ReadTransactionRequest) request).getPath();
 207             final Optional<NormalizedNode<?, ?>> result = modification.readNode(path);
 208             callback.accept(new ReadTransactionSuccess(request.getTarget(), request.getSequence(), result));
 209         } else if (request instanceof ExistsTransactionRequest) {
 210             final YangInstanceIdentifier path = ((ExistsTransactionRequest) request).getPath();
 211             final boolean result = modification.readNode(path).isPresent();
 212             callback.accept(new ExistsTransactionSuccess(request.getTarget(), request.getSequence(), result));
 213         } else if (request instanceof TransactionPreCommitRequest) {
 214             sendRequest(new TransactionPreCommitRequest(getIdentifier(), nextSequence(), localActor()), callback);
 215         } else if (request instanceof TransactionDoCommitRequest) {
 216             sendRequest(new TransactionDoCommitRequest(getIdentifier(), nextSequence(), localActor()), callback);
 217         } else if (request instanceof TransactionAbortRequest) {
 218             sendAbort(callback);
 219         } else {
 220             throw new IllegalArgumentException("Unhandled request " + request);
 221         }
 222     }
 223
 224     @Override
 225     void forwardToRemote(final RemoteProxyTransaction successor, final TransactionRequest<?> request,
 226             final Consumer<Response<?, ?>> callback) {
 227         if (request instanceof CommitLocalTransactionRequest) {
 228             final CommitLocalTransactionRequest req = (CommitLocalTransactionRequest) request;
 229             final DataTreeModification mod = req.getModification();
 230
 231             LOG.debug("Applying modification {} to successor {}", mod, successor);
 232             mod.applyToCursor(new AbstractDataTreeModificationCursor() {
 233                 @Override
 234                 public void write(final PathArgument child, final NormalizedNode<?, ?> data) {
 235                     successor.write(current().node(child), data);
 236                 }
 237
 238                 @Override
 239                 public void merge(final PathArgument child, final NormalizedNode<?, ?> data) {
 240                     successor.merge(current().node(child), data);
 241                 }
 242
 243                 @Override
 244                 public void delete(final PathArgument child) {
 245                     successor.delete(current().node(child));
 246                 }
 247             });
 248
 249             successor.seal();
 250
 251             final ModifyTransactionRequest successorReq = successor.commitRequest(req.isCoordinated());
 252             successor.sendRequest(successorReq, callback);
 253         } else if (request instanceof AbortLocalTransactionRequest) {
 254             LOG.debug("Forwarding abort {} to successor {}", request, successor);
 255             successor.abort();
 256         } else {
 257             throw new IllegalArgumentException("Unhandled request" + request);
 258         }
 259     }
 260
 261     @Override
 262     void forwardToLocal(final LocalProxyTransaction successor, final TransactionRequest<?> request,
 263             final Consumer<Response<?, ?>> callback) {
 264         if (request instanceof AbortLocalTransactionRequest) {
 265             successor.sendAbort(request, callback);
 266         } else if (request instanceof CommitLocalTransactionRequest) {
 267             successor.sendCommit((CommitLocalTransactionRequest)request, callback);
 268         } else {
 269             throw new IllegalArgumentException("Unhandled request" + request);
 270         }
 271
 272         LOG.debug("Forwarded request {} to successor {}", request, successor);
 273     }
 274
 275     private void sendAbort(final TransactionRequest<?> request, final Consumer<Response<?, ?>> callback) {
 276         sendRequest(request, callback);
 277         modification = new FailedDataTreeModification(this::abortedException);
 278     }
 279
 280     private void sendCommit(final CommitLocalTransactionRequest request, final Consumer<Response<?, ?>> callback) {
 281         // Rebase old modification on new data tree.
 282         try (DataTreeModificationCursor cursor = modification.createCursor(YangInstanceIdentifier.EMPTY)) {
 283             request.getModification().applyToCursor(cursor);
 284         }
 285
 286         seal();
 287         sendRequest(commitRequest(request.isCoordinated()), callback);
 288     }
 289 }