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=b810ed9575a7af8d1f85a7b337639e2f3dfc72ca;hb=35eb97d26856884cbc6a5b2d0c4102c1b2bacb0a;hp=75744cad5b920b942efda865d0fa6ed29c41f3d7;hpb=03ee21b4d6ae3dd6fd3a6991253e877dc96fabf5;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..b810ed9575 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,15 +9,22 @@ 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.util.concurrent.CheckedFuture; +import org.opendaylight.controller.cluster.common.actor.AbstractUntypedActor; + + +import org.opendaylight.controller.cluster.datastore.exceptions.UnknownMessageException; +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.DataExists; +import org.opendaylight.controller.cluster.datastore.messages.DataExistsReply; import org.opendaylight.controller.cluster.datastore.messages.DeleteData; import org.opendaylight.controller.cluster.datastore.messages.DeleteDataReply; import org.opendaylight.controller.cluster.datastore.messages.MergeData; @@ -34,25 +41,28 @@ import org.opendaylight.controller.cluster.datastore.modification.ImmutableCompo 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.md.sal.common.api.data.ReadFailedException; +import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadTransaction; 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.sal.core.spi.data.DOMStoreTransaction; +import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction; +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; - -import java.util.concurrent.ExecutionException; +import org.opendaylight.yangtools.yang.model.api.SchemaContext; /** * 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} @@ -63,125 +73,194 @@ import java.util.concurrent.ExecutionException; *
  • {@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 AbstractUntypedActor { + + private final ActorRef shardActor; + protected final SchemaContext schemaContext; + private final ShardStats shardStats; + + private final MutableCompositeModification modification = new MutableCompositeModification(); + + protected ShardTransaction(ActorRef shardActor, SchemaContext schemaContext, + ShardStats shardStats) { + this.shardActor = shardActor; + this.schemaContext = schemaContext; + this.shardStats = shardStats; } - } - private void readData(ReadData message) { - final ActorRef sender = getSender(); - final ActorRef self = getSelf(); - final InstanceIdentifier path = message.getPath(); - final ListenableFuture>> future = transaction.read(path); + public static Props props(DOMStoreTransaction transaction, ActorRef shardActor, + SchemaContext schemaContext,DatastoreContext datastoreContext, ShardStats shardStats) { + return Props.create(new ShardTransactionCreator(transaction, shardActor, schemaContext, + datastoreContext, shardStats)); + } - 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()); + protected abstract DOMStoreTransaction getDOMStoreTransaction(); + + @Override + public void handleReceive(Object message) throws Exception { + if (message.getClass().equals(CloseTransaction.SERIALIZABLE_CLASS)) { + closeTransaction(true); + } else if (message instanceof GetCompositedModification) { + // This is here for testing only + getSender().tell(new GetCompositeModificationReply( + new ImmutableCompositeModification(modification)), getSelf()); + } else if (message instanceof ReceiveTimeout) { + LOG.debug("Got ReceiveTimeout for inactivity - closing Tx"); + closeTransaction(false); + } else { + throw new UnknownMessageException(message); } + } + + private void closeTransaction(boolean sendReply) { + getDOMStoreTransaction().close(); + + if(sendReply) { + getSender().tell(new CloseTransactionReply().toSerializable(), getSelf()); + } + + getSelf().tell(PoisonPill.getInstance(), getSelf()); + } + + protected void readData(DOMStoreReadTransaction transaction,ReadData message) { + final ActorRef sender = getSender(); + final ActorRef self = getSelf(); + final YangInstanceIdentifier path = message.getPath(); + final CheckedFuture>, ReadFailedException> future = + transaction.read(path); + + future.addListener(new Runnable() { + @Override + public void run() { + try { + Optional> optional = future.checkedGet(); + if (optional.isPresent()) { + sender.tell(new ReadDataReply(schemaContext,optional.get()).toSerializable(), self); + } else { + sender.tell(new ReadDataReply(schemaContext,null).toSerializable(), self); + } + } catch (Exception e) { + shardStats.incrementFailedReadTransactionsCount(); + sender.tell(new akka.actor.Status.Failure(e), self); + } + + } + }, getContext().dispatcher()); + } - } - }, getContext().dispatcher()); - } + protected void dataExists(DOMStoreReadTransaction transaction, DataExists message) { + final YangInstanceIdentifier path = message.getPath(); + + try { + Boolean exists = transaction.exists(path).checkedGet(); + getSender().tell(new DataExistsReply(exists).toSerializable(), getSelf()); + } catch (ReadFailedException e) { + getSender().tell(new akka.actor.Status.Failure(e),getSelf()); + } + } - 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 void writeData(DOMStoreWriteTransaction transaction, WriteData message) { + modification.addModification( + new WriteModification(message.getPath(), message.getData(),schemaContext)); + LOG.debug("writeData at path : " + message.getPath().toString()); - private void mergeData(MergeData message){ - modification.addModification(new MergeModification(message.getPath(), message.getData())); - transaction.merge(message.getPath(), message.getData()); - getSender().tell(new MergeDataReply(), getSelf()); - } + try { + transaction.write(message.getPath(), message.getData()); + getSender().tell(new WriteDataReply().toSerializable(), getSelf()); + }catch(Exception e){ + getSender().tell(new akka.actor.Status.Failure(e), getSelf()); + } + } - private void deleteData(DeleteData message){ - modification.addModification(new DeleteModification(message.getPath())); - transaction.delete(message.getPath()); - getSender().tell(new DeleteDataReply(), getSelf()); - } + protected void mergeData(DOMStoreWriteTransaction transaction, MergeData message) { + modification.addModification( + new MergeModification(message.getPath(), message.getData(), schemaContext)); + LOG.debug("mergeData at path : " + message.getPath().toString()); + try { + transaction.merge(message.getPath(), message.getData()); + getSender().tell(new MergeDataReply().toSerializable(), getSelf()); + }catch(Exception e){ + getSender().tell(new akka.actor.Status.Failure(e), getSelf()); + } + } - 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()); + protected void deleteData(DOMStoreWriteTransaction transaction, DeleteData message) { + LOG.debug("deleteData at path : " + message.getPath().toString()); + modification.addModification(new DeleteModification(message.getPath())); + try { + transaction.delete(message.getPath()); + getSender().tell(new DeleteDataReply().toSerializable(), getSelf()); + }catch(Exception e){ + getSender().tell(new akka.actor.Status.Failure(e), getSelf()); + } + } - } + protected void readyTransaction(DOMStoreWriteTransaction transaction, ReadyTransaction message) { + DOMStoreThreePhaseCommitCohort cohort = transaction.ready(); + ActorRef cohortActor = getContext().actorOf( + ThreePhaseCommitCohort.props(cohort, shardActor, modification, shardStats), "cohort"); + getSender() + .tell(new ReadyTransactionReply(cohortActor.path()).toSerializable(), getSelf()); - private void closeTransaction(CloseTransaction message){ - transaction.close(); - getSender().tell(new CloseTransactionReply(), getSelf()); - } + } + private static class ShardTransactionCreator implements Creator { - // These classes are in here for test purposes only + private static final long serialVersionUID = 1L; - static class GetCompositedModification { + final DOMStoreTransaction transaction; + final ActorRef shardActor; + final SchemaContext schemaContext; + final DatastoreContext datastoreContext; + final ShardStats shardStats; - } + ShardTransactionCreator(DOMStoreTransaction transaction, ActorRef shardActor, + SchemaContext schemaContext, DatastoreContext datastoreContext, + ShardStats shardStats) { + this.transaction = transaction; + this.shardActor = shardActor; + this.shardStats = shardStats; + this.schemaContext = schemaContext; + this.datastoreContext = datastoreContext; + } - static class GetCompositeModificationReply { - private final CompositeModification modification; + @Override + public ShardTransaction create() throws Exception { + ShardTransaction tx; + if(transaction instanceof DOMStoreReadWriteTransaction) { + tx = new ShardReadWriteTransaction((DOMStoreReadWriteTransaction)transaction, + shardActor, schemaContext, shardStats); + } else if(transaction instanceof DOMStoreReadTransaction) { + tx = new ShardReadTransaction((DOMStoreReadTransaction)transaction, shardActor, + schemaContext, shardStats); + } else { + tx = new ShardWriteTransaction((DOMStoreWriteTransaction)transaction, + shardActor, schemaContext, shardStats); + } + + tx.getContext().setReceiveTimeout(datastoreContext.getShardTransactionIdleTimeout()); + return tx; + } + } + // These classes are in here for test purposes only - GetCompositeModificationReply(CompositeModification modification) { - this.modification = modification; + static class GetCompositedModification { } - public CompositeModification getModification() { - return modification; + static class GetCompositeModificationReply { + private final CompositeModification modification; + + + GetCompositeModificationReply(CompositeModification modification) { + this.modification = modification; + } + + + public CompositeModification getModification() { + return modification; + } } - } }