X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-distributed-datastore%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fdatastore%2FShardTransaction.java;h=2421cce26c0afa6f7a7c7cc3cf6b5da5830f6fd0;hb=4639f61a41a93d6a762af97b819d164781b0f9f8;hp=75744cad5b920b942efda865d0fa6ed29c41f3d7;hpb=da6ca13e3f8ecb73a62f7e8f9ae3bdcae9d851f8;p=controller.git diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/ShardTransaction.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/ShardTransaction.java index 75744cad5b..2421cce26c 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/ShardTransaction.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/ShardTransaction.java @@ -9,179 +9,158 @@ package org.opendaylight.controller.cluster.datastore; import akka.actor.ActorRef; +import akka.actor.PoisonPill; import akka.actor.Props; -import akka.actor.UntypedActor; -import akka.event.Logging; -import akka.event.LoggingAdapter; +import akka.actor.ReceiveTimeout; import akka.japi.Creator; import com.google.common.base.Optional; -import com.google.common.util.concurrent.ListenableFuture; +import com.google.common.base.Preconditions; +import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier; +import org.opendaylight.controller.cluster.common.actor.AbstractUntypedActorWithMetering; +import org.opendaylight.controller.cluster.datastore.jmx.mbeans.shard.ShardStats; import org.opendaylight.controller.cluster.datastore.messages.CloseTransaction; import org.opendaylight.controller.cluster.datastore.messages.CloseTransactionReply; -import org.opendaylight.controller.cluster.datastore.messages.DeleteData; -import org.opendaylight.controller.cluster.datastore.messages.DeleteDataReply; -import org.opendaylight.controller.cluster.datastore.messages.MergeData; -import org.opendaylight.controller.cluster.datastore.messages.MergeDataReply; +import org.opendaylight.controller.cluster.datastore.messages.DataExists; +import org.opendaylight.controller.cluster.datastore.messages.DataExistsReply; import org.opendaylight.controller.cluster.datastore.messages.ReadData; import org.opendaylight.controller.cluster.datastore.messages.ReadDataReply; -import org.opendaylight.controller.cluster.datastore.messages.ReadyTransaction; -import org.opendaylight.controller.cluster.datastore.messages.ReadyTransactionReply; -import org.opendaylight.controller.cluster.datastore.messages.WriteData; -import org.opendaylight.controller.cluster.datastore.messages.WriteDataReply; -import org.opendaylight.controller.cluster.datastore.modification.CompositeModification; -import org.opendaylight.controller.cluster.datastore.modification.DeleteModification; -import org.opendaylight.controller.cluster.datastore.modification.ImmutableCompositeModification; -import org.opendaylight.controller.cluster.datastore.modification.MergeModification; -import org.opendaylight.controller.cluster.datastore.modification.MutableCompositeModification; -import org.opendaylight.controller.cluster.datastore.modification.WriteModification; -import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadWriteTransaction; -import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort; -import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier; +import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException; +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; -import java.util.concurrent.ExecutionException; - /** * The ShardTransaction Actor represents a remote transaction - *

+ *

* The ShardTransaction Actor delegates all actions to DOMDataReadWriteTransaction - *

- *

- * Even though the DOMStore and the DOMStoreTransactionChain implement multiple types of transactions - * the ShardTransaction Actor only works with read-write transactions. This is just to keep the logic simple. At this - * time there are no known advantages for creating a read-only or write-only transaction which may change over time - * at which point we can optimize things in the distributed store as well. - *

- *

+ *

+ *

* Handles Messages
* ----------------
*

  • {@link org.opendaylight.controller.cluster.datastore.messages.ReadData} - *
  • {@link org.opendaylight.controller.cluster.datastore.messages.WriteData} - *
  • {@link org.opendaylight.controller.cluster.datastore.messages.MergeData} - *
  • {@link org.opendaylight.controller.cluster.datastore.messages.DeleteData} - *
  • {@link org.opendaylight.controller.cluster.datastore.messages.ReadyTransaction} *
  • {@link org.opendaylight.controller.cluster.datastore.messages.CloseTransaction} *

    */ -public class ShardTransaction extends UntypedActor { - - private final ActorRef shardActor; - - private final DOMStoreReadWriteTransaction transaction; - - private final MutableCompositeModification modification = new MutableCompositeModification(); - - private final LoggingAdapter log = Logging.getLogger(getContext().system(), this); - - public ShardTransaction(DOMStoreReadWriteTransaction transaction, ActorRef shardActor) { - this.transaction = transaction; - this.shardActor = shardActor; - } - - - public static Props props(final DOMStoreReadWriteTransaction transaction, final ActorRef shardActor){ - return Props.create(new Creator(){ - - @Override - public ShardTransaction create() throws Exception { - return new ShardTransaction(transaction, shardActor); - } - }); - } - - @Override - public void onReceive(Object message) throws Exception { - if(message instanceof ReadData){ - readData((ReadData) message); - } else if(message instanceof WriteData){ - writeData((WriteData) message); - } else if(message instanceof MergeData){ - mergeData((MergeData) message); - } else if(message instanceof DeleteData){ - deleteData((DeleteData) message); - } else if(message instanceof ReadyTransaction){ - readyTransaction((ReadyTransaction) message); - } else if(message instanceof CloseTransaction){ - closeTransaction((CloseTransaction) message); - } else if(message instanceof GetCompositedModification){ - // This is here for testing only - getSender().tell(new GetCompositeModificationReply(new ImmutableCompositeModification(modification)), getSelf()); +public abstract class ShardTransaction extends AbstractUntypedActorWithMetering { + private final ActorRef shardActor; + private final ShardStats shardStats; + private final TransactionIdentifier transactionID; + + protected ShardTransaction(ActorRef shardActor, ShardStats shardStats, TransactionIdentifier transactionID) { + super("shard-tx"); //actor name override used for metering. This does not change the "real" actor name + this.shardActor = shardActor; + this.shardStats = shardStats; + this.transactionID = Preconditions.checkNotNull(transactionID); } - } - - private void readData(ReadData message) { - final ActorRef sender = getSender(); - final ActorRef self = getSelf(); - final InstanceIdentifier path = message.getPath(); - final ListenableFuture>> future = transaction.read(path); - - future.addListener(new Runnable() { - @Override - public void run() { - try { - Optional> optional = future.get(); - if(optional.isPresent()){ - sender.tell(new ReadDataReply(optional.get()), self); - } else { - //TODO : Need to decide what to do here - } - } catch (InterruptedException | ExecutionException e) { - log.error(e, "An exception happened when reading data from path : " + path.toString()); - } - - } - }, getContext().dispatcher()); - } + public static Props props(TransactionType type, AbstractShardDataTreeTransaction transaction, ActorRef shardActor, + DatastoreContext datastoreContext, ShardStats shardStats) { + return Props.create(new ShardTransactionCreator(type, transaction, shardActor, datastoreContext, shardStats)); + } - private void writeData(WriteData message){ - modification.addModification(new WriteModification(message.getPath(), message.getData())); - transaction.write(message.getPath(), message.getData()); - getSender().tell(new WriteDataReply(), getSelf()); - } + protected abstract AbstractShardDataTreeTransaction getDOMStoreTransaction(); - private void mergeData(MergeData message){ - modification.addModification(new MergeModification(message.getPath(), message.getData())); - transaction.merge(message.getPath(), message.getData()); - getSender().tell(new MergeDataReply(), getSelf()); - } + protected ActorRef getShardActor() { + return shardActor; + } - private void deleteData(DeleteData message){ - modification.addModification(new DeleteModification(message.getPath())); - transaction.delete(message.getPath()); - getSender().tell(new DeleteDataReply(), getSelf()); - } + protected final TransactionIdentifier getTransactionID() { + return transactionID; + } - private void readyTransaction(ReadyTransaction message){ - DOMStoreThreePhaseCommitCohort cohort = transaction.ready(); - ActorRef cohortActor = getContext().actorOf(ThreePhaseCommitCohort.props(cohort, shardActor, modification)); - getSender().tell(new ReadyTransactionReply(cohortActor.path()), getSelf()); + @Override + public void handleReceive(Object message) { + if (CloseTransaction.isSerializedType(message)) { + closeTransaction(true); + } else if (message instanceof ReceiveTimeout) { + LOG.debug("Got ReceiveTimeout for inactivity - closing transaction {}", transactionID); + closeTransaction(false); + } else { + unknownMessage(message); + } + } - } + protected boolean returnCloseTransactionReply() { + return true; + } - private void closeTransaction(CloseTransaction message){ - transaction.close(); - getSender().tell(new CloseTransactionReply(), getSelf()); - } + private void closeTransaction(boolean sendReply) { + getDOMStoreTransaction().abort(); + if(sendReply && returnCloseTransactionReply()) { + getSender().tell(new CloseTransactionReply(), getSelf()); + } - // These classes are in here for test purposes only + getSelf().tell(PoisonPill.getInstance(), getSelf()); + } - static class GetCompositedModification { + private boolean checkClosed(AbstractShardDataTreeTransaction transaction) { + final boolean ret = transaction.isClosed(); + if (ret) { + shardStats.incrementFailedReadTransactionsCount(); + getSender().tell(new akka.actor.Status.Failure(new ReadFailedException("Transaction is closed")), getSelf()); + } + return ret; + } - } + protected void readData(AbstractShardDataTreeTransaction transaction, ReadData message) { + if (checkClosed(transaction)) { + return; + } - static class GetCompositeModificationReply { - private final CompositeModification modification; + final YangInstanceIdentifier path = message.getPath(); + Optional> optional = transaction.getSnapshot().readNode(path); + ReadDataReply readDataReply = new ReadDataReply(optional.orNull(), message.getVersion()); + sender().tell(readDataReply.toSerializable(), self()); + } + protected void dataExists(AbstractShardDataTreeTransaction transaction, DataExists message) { + if (checkClosed(transaction)) { + return; + } - GetCompositeModificationReply(CompositeModification modification) { - this.modification = modification; + final YangInstanceIdentifier path = message.getPath(); + boolean exists = transaction.getSnapshot().readNode(path).isPresent(); + getSender().tell(new DataExistsReply(exists, message.getVersion()).toSerializable(), getSelf()); } + private static class ShardTransactionCreator implements Creator { - public CompositeModification getModification() { - return modification; + private static final long serialVersionUID = 1L; + + final AbstractShardDataTreeTransaction transaction; + final ActorRef shardActor; + final DatastoreContext datastoreContext; + final ShardStats shardStats; + final TransactionType type; + + ShardTransactionCreator(TransactionType type, AbstractShardDataTreeTransaction transaction, ActorRef shardActor, + DatastoreContext datastoreContext, ShardStats shardStats) { + this.transaction = Preconditions.checkNotNull(transaction); + this.shardActor = shardActor; + this.shardStats = shardStats; + this.datastoreContext = datastoreContext; + this.type = type; + } + + @Override + public ShardTransaction create() throws Exception { + final ShardTransaction tx; + switch (type) { + case READ_ONLY: + tx = new ShardReadTransaction(transaction, shardActor, shardStats); + break; + case READ_WRITE: + tx = new ShardReadWriteTransaction((ReadWriteShardDataTreeTransaction)transaction, shardActor, shardStats); + break; + case WRITE_ONLY: + tx = new ShardWriteTransaction((ReadWriteShardDataTreeTransaction)transaction, shardActor, shardStats); + break; + default: + throw new IllegalArgumentException("Unhandled transaction type " + type); + } + + tx.getContext().setReceiveTimeout(datastoreContext.getShardTransactionIdleTimeout()); + return tx; + } } - } }