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