2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
3 * Copyright (c) 2015 Brocade Communications Systems, Inc. and others. All rights reserved.
5 * This program and the accompanying materials are made available under the
6 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
7 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.controller.cluster.datastore;
11 import akka.actor.ActorSelection;
12 import akka.dispatch.OnComplete;
13 import akka.util.Timeout;
14 import com.google.common.base.Preconditions;
15 import com.google.common.util.concurrent.SettableFuture;
16 import org.opendaylight.controller.cluster.datastore.identifiers.TransactionIdentifier;
17 import org.opendaylight.controller.cluster.datastore.messages.AbstractRead;
18 import org.opendaylight.controller.cluster.datastore.messages.BatchedModifications;
19 import org.opendaylight.controller.cluster.datastore.messages.CloseTransaction;
20 import org.opendaylight.controller.cluster.datastore.messages.SerializableMessage;
21 import org.opendaylight.controller.cluster.datastore.modification.AbstractModification;
22 import org.opendaylight.controller.cluster.datastore.modification.Modification;
23 import org.opendaylight.controller.cluster.datastore.utils.ActorContext;
24 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
25 import org.slf4j.Logger;
26 import org.slf4j.LoggerFactory;
27 import scala.concurrent.Future;
30 * Redirects front-end transaction operations to a shard for processing. Instances of this class are used
31 * when the destination shard is remote to the caller.
33 * @author Thomas Pantelis
35 public class RemoteTransactionContext extends AbstractTransactionContext {
36 private static final Logger LOG = LoggerFactory.getLogger(RemoteTransactionContext.class);
38 private final ActorContext actorContext;
39 private final ActorSelection actor;
40 private final OperationLimiter limiter;
42 private BatchedModifications batchedModifications;
43 private int totalBatchedModificationsSent;
45 protected RemoteTransactionContext(TransactionIdentifier identifier, ActorSelection actor,
46 ActorContext actorContext, short remoteTransactionVersion, OperationLimiter limiter) {
47 super(identifier, remoteTransactionVersion);
48 this.limiter = Preconditions.checkNotNull(limiter);
50 this.actorContext = actorContext;
53 private Future<Object> completeOperation(Future<Object> operationFuture){
54 operationFuture.onComplete(limiter, actorContext.getClientDispatcher());
55 return operationFuture;
58 private ActorSelection getActor() {
62 protected ActorContext getActorContext() {
66 protected Future<Object> executeOperationAsync(SerializableMessage msg, Timeout timeout) {
67 return completeOperation(actorContext.executeOperationAsync(getActor(), msg.toSerializable(), timeout));
71 public void closeTransaction() {
72 LOG.debug("Tx {} closeTransaction called", getIdentifier());
73 TransactionContextCleanup.untrack(this);
75 actorContext.sendOperationAsync(getActor(), new CloseTransaction(getTransactionVersion()).toSerializable());
79 public Future<Object> directCommit() {
80 LOG.debug("Tx {} directCommit called", getIdentifier());
82 // Send the remaining batched modifications, if any, with the ready flag set.
84 return sendBatchedModifications(true, true);
88 public Future<ActorSelection> readyTransaction() {
89 logModificationCount();
91 LOG.debug("Tx {} readyTransaction called", getIdentifier());
93 // Send the remaining batched modifications, if any, with the ready flag set.
95 Future<Object> lastModificationsFuture = sendBatchedModifications(true, false);
97 return transformReadyReply(lastModificationsFuture);
100 protected Future<ActorSelection> transformReadyReply(final Future<Object> readyReplyFuture) {
101 // Transform the last reply Future into a Future that returns the cohort actor path from
102 // the last reply message. That's the end result of the ready operation.
104 return TransactionReadyReplyMapper.transform(readyReplyFuture, actorContext, getIdentifier());
107 private BatchedModifications newBatchedModifications() {
108 return new BatchedModifications(getIdentifier().toString(), getTransactionVersion(),
109 getIdentifier().getChainId());
112 private void batchModification(Modification modification) {
113 incrementModificationCount();
114 if(batchedModifications == null) {
115 batchedModifications = newBatchedModifications();
118 batchedModifications.addModification(modification);
120 if(batchedModifications.getModifications().size() >=
121 actorContext.getDatastoreContext().getShardBatchedModificationCount()) {
122 sendBatchedModifications();
126 protected Future<Object> sendBatchedModifications() {
127 return sendBatchedModifications(false, false);
130 protected Future<Object> sendBatchedModifications(boolean ready, boolean doCommitOnReady) {
131 Future<Object> sent = null;
132 if(ready || (batchedModifications != null && !batchedModifications.getModifications().isEmpty())) {
133 if(batchedModifications == null) {
134 batchedModifications = newBatchedModifications();
137 if(LOG.isDebugEnabled()) {
138 LOG.debug("Tx {} sending {} batched modifications, ready: {}", getIdentifier(),
139 batchedModifications.getModifications().size(), ready);
142 batchedModifications.setReady(ready);
143 batchedModifications.setDoCommitOnReady(doCommitOnReady);
144 batchedModifications.setTotalMessagesSent(++totalBatchedModificationsSent);
145 sent = executeOperationAsync(batchedModifications, actorContext.getTransactionCommitOperationTimeout());
148 batchedModifications = null;
150 batchedModifications = newBatchedModifications();
158 public void executeModification(AbstractModification modification) {
159 if(LOG.isDebugEnabled()) {
160 LOG.debug("Tx {} executeModification {} called path = {}", getIdentifier(), modification.getClass()
161 .getSimpleName(), modification.getPath());
165 batchModification(modification);
169 public <T> void executeRead(final AbstractRead<T> readCmd, final SettableFuture<T> returnFuture) {
170 if(LOG.isDebugEnabled()) {
171 LOG.debug("Tx {} executeRead {} called path = {}", getIdentifier(), readCmd.getClass().getSimpleName(),
175 // Send any batched modifications. This is necessary to honor the read uncommitted semantics of the
176 // public API contract.
179 sendBatchedModifications();
181 OnComplete<Object> onComplete = new OnComplete<Object>() {
183 public void onComplete(Throwable failure, Object response) throws Throwable {
184 if(failure != null) {
185 if(LOG.isDebugEnabled()) {
186 LOG.debug("Tx {} {} operation failed: {}", getIdentifier(), readCmd.getClass().getSimpleName(),
189 returnFuture.setException(new ReadFailedException("Error checking " + readCmd.getClass().getSimpleName()
190 + " for path " + readCmd.getPath(), failure));
192 if(LOG.isDebugEnabled()) {
193 LOG.debug("Tx {} {} operation succeeded", getIdentifier(), readCmd.getClass().getSimpleName());
195 readCmd.processResponse(response, returnFuture);
200 Future<Object> future = executeOperationAsync(readCmd.asVersion(getTransactionVersion()),
201 actorContext.getOperationTimeout());
203 future.onComplete(onComplete, actorContext.getClientDispatcher());
207 * Acquire operation from the limiter if the hand-off has completed. If
208 * the hand-off is still ongoing, this method does nothing.
210 private final void acquireOperation() {
211 if (isOperationHandOffComplete()) {
217 public boolean usesOperationLimiting() {