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