X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-distributed-datastore%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fdatastore%2FShardTransaction.java;h=af25df13d2865ba867d6a529d3ad947101b1510a;hp=360a10722c06df2c3e357631b43d89eac801a3d3;hb=8fe43e73969a8f189b76dd021c9e84146473a596;hpb=54916d10764a5234881040e9a68ae35d63b3dac9 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 360a10722c..af25df13d2 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,37 +9,25 @@ package org.opendaylight.controller.cluster.datastore; import akka.actor.ActorRef; +import akka.actor.PoisonPill; import akka.actor.Props; -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.CheckedFuture; +import org.opendaylight.controller.cluster.common.actor.AbstractUntypedActorWithMetering; 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; -import org.opendaylight.controller.cluster.datastore.messages.MergeDataReply; 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.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.controller.sal.core.spi.data.DOMStoreTransactionChain; +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; @@ -51,12 +39,6 @@ import org.opendaylight.yangtools.yang.model.api.SchemaContext; * 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} @@ -67,222 +49,152 @@ import org.opendaylight.yangtools.yang.model.api.SchemaContext; *
  • {@link org.opendaylight.controller.cluster.datastore.messages.CloseTransaction} *

    */ -public abstract class ShardTransaction extends AbstractUntypedActor { - - private final ActorRef shardActor; - protected final SchemaContext schemaContext; - - // FIXME : see below - // If transactionChain is not null then this transaction is part of a - // transactionChain. Not really clear as to what that buys us - private final DOMStoreTransactionChain transactionChain; - - - private final MutableCompositeModification modification = - new MutableCompositeModification(); - - private final LoggingAdapter log = - Logging.getLogger(getContext().system(), this); - - protected ShardTransaction( - ActorRef shardActor, SchemaContext schemaContext) { - this(null, shardActor, schemaContext); - } - - protected ShardTransaction(DOMStoreTransactionChain transactionChain, - ActorRef shardActor, SchemaContext schemaContext) { - this.transactionChain = transactionChain; - this.shardActor = shardActor; - this.schemaContext = schemaContext; - } - - - - public static Props props(final DOMStoreReadTransaction transaction, - final ActorRef shardActor, final SchemaContext schemaContext) { - return Props.create(new Creator() { - - @Override - public ShardTransaction create() throws Exception { - return new ShardReadTransaction(transaction, shardActor, schemaContext); - } - }); - } - - public static Props props(final DOMStoreTransactionChain transactionChain, final DOMStoreReadTransaction transaction, - final ActorRef shardActor, final SchemaContext schemaContext) { - return Props.create(new Creator() { - - @Override - public ShardTransaction create() throws Exception { - return new ShardReadTransaction(transactionChain, transaction, shardActor, schemaContext); - } - }); - } +public abstract class ShardTransaction extends AbstractUntypedActorWithMetering { + + protected static final boolean SERIALIZED_REPLY = true; + + private final ActorRef shardActor; + private final SchemaContext schemaContext; + private final ShardStats shardStats; + private final String transactionID; + private final short clientTxVersion; + + protected ShardTransaction(ActorRef shardActor, SchemaContext schemaContext, + ShardStats shardStats, String transactionID, short clientTxVersion) { + super("shard-tx"); //actor name override used for metering. This does not change the "real" actor name + this.shardActor = shardActor; + this.schemaContext = schemaContext; + this.shardStats = shardStats; + this.transactionID = transactionID; + this.clientTxVersion = clientTxVersion; + } - public static Props props(final DOMStoreReadWriteTransaction transaction, - final ActorRef shardActor, final SchemaContext schemaContext) { - return Props.create(new Creator() { + public static Props props(DOMStoreTransaction transaction, ActorRef shardActor, + SchemaContext schemaContext,DatastoreContext datastoreContext, ShardStats shardStats, + String transactionID, short txnClientVersion) { + return Props.create(new ShardTransactionCreator(transaction, shardActor, schemaContext, + datastoreContext, shardStats, transactionID, txnClientVersion)); + } - @Override - public ShardTransaction create() throws Exception { - return new ShardReadWriteTransaction(transaction, shardActor, schemaContext); - } - }); - } + protected abstract DOMStoreTransaction getDOMStoreTransaction(); - public static Props props(final DOMStoreTransactionChain transactionChain, final DOMStoreReadWriteTransaction transaction, - final ActorRef shardActor, final SchemaContext schemaContext) { - return Props.create(new Creator() { + protected ActorRef getShardActor() { + return shardActor; + } - @Override - public ShardTransaction create() throws Exception { - return new ShardReadWriteTransaction(transactionChain, transaction, shardActor, schemaContext); - } - }); - } + protected String getTransactionID() { + return transactionID; + } + protected SchemaContext getSchemaContext() { + return schemaContext; + } - public static Props props(final DOMStoreWriteTransaction transaction, - final ActorRef shardActor, final SchemaContext schemaContext) { - return Props.create(new Creator() { + protected short getClientTxVersion() { + return clientTxVersion; + } - @Override - public ShardTransaction create() throws Exception { - return new ShardWriteTransaction(transaction, shardActor, schemaContext); - } - }); - } + @Override + public void handleReceive(Object message) throws Exception { + if (message.getClass().equals(CloseTransaction.SERIALIZABLE_CLASS)) { + closeTransaction(true); + } else if (message instanceof ReceiveTimeout) { + if(LOG.isDebugEnabled()) { + LOG.debug("Got ReceiveTimeout for inactivity - closing Tx"); + } + closeTransaction(false); + } else { + throw new UnknownMessageException(message); + } + } - public static Props props(final DOMStoreTransactionChain transactionChain, final DOMStoreWriteTransaction transaction, - final ActorRef shardActor, final SchemaContext schemaContext) { - return Props.create(new Creator() { + protected boolean returnCloseTransactionReply() { + return true; + } - @Override - public ShardTransaction create() throws Exception { - return new ShardWriteTransaction(transactionChain, transaction, shardActor, schemaContext); - } - }); - } + private void closeTransaction(boolean sendReply) { + getDOMStoreTransaction().close(); + if(sendReply && returnCloseTransactionReply()) { + getSender().tell(CloseTransactionReply.INSTANCE.toSerializable(), getSelf()); + } - @Override - public void handleReceive(Object message) throws Exception { - if (message.getClass().equals(CloseTransaction.SERIALIZABLE_CLASS)) { - closeTransaction(new CloseTransaction()); - } else if (message instanceof GetCompositedModification) { - // This is here for testing only - getSender().tell(new GetCompositeModificationReply( - new ImmutableCompositeModification(modification)), getSelf()); - }else{ - throw new UnknownMessageException(message); + getSelf().tell(PoisonPill.getInstance(), getSelf()); } - } - - abstract protected void closeTransaction(CloseTransaction message); - 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); + protected void readData(DOMStoreReadTransaction transaction, ReadData message, + final boolean returnSerialized) { - future.addListener(new Runnable() { - @Override - public void run() { + final YangInstanceIdentifier path = message.getPath(); 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); - } + final CheckedFuture>, ReadFailedException> future = transaction.read(path); + Optional> optional = future.checkedGet(); + ReadDataReply readDataReply = new ReadDataReply(optional.orNull()); + + sender().tell((returnSerialized ? readDataReply.toSerializable(clientTxVersion): readDataReply), self()); + } catch (Exception e) { - sender.tell(new akka.actor.Status.Failure(e),self); + LOG.debug(String.format("Unexpected error reading path %s", path), e); + shardStats.incrementFailedReadTransactionsCount(); + sender().tell(new akka.actor.Status.Failure(e), self()); } + } - } - }, getContext().dispatcher()); - } - - protected void dataExists(DOMStoreReadTransaction transaction, DataExists message) { + protected void dataExists(DOMStoreReadTransaction transaction, DataExists message, + final boolean returnSerialized) { final YangInstanceIdentifier path = message.getPath(); try { Boolean exists = transaction.exists(path).checkedGet(); - getSender().tell(new DataExistsReply(exists).toSerializable(), getSelf()); + DataExistsReply dataExistsReply = new DataExistsReply(exists); + getSender().tell(returnSerialized ? dataExistsReply.toSerializable() : + dataExistsReply, getSelf()); } catch (ReadFailedException e) { getSender().tell(new akka.actor.Status.Failure(e),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()); - - 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()); - } - } - - 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()); - } - } - - 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), "cohort"); - getSender() - .tell(new ReadyTransactionReply(cohortActor.path()).toSerializable(), getSelf()); - - } - - - // These classes are in here for test purposes only - - - static class GetCompositedModification { - - } - - - static class GetCompositeModificationReply { - private final CompositeModification modification; - - - GetCompositeModificationReply(CompositeModification modification) { - this.modification = modification; - } - + private static class ShardTransactionCreator implements Creator { + + private static final long serialVersionUID = 1L; + + final DOMStoreTransaction transaction; + final ActorRef shardActor; + final SchemaContext schemaContext; + final DatastoreContext datastoreContext; + final ShardStats shardStats; + final String transactionID; + final short txnClientVersion; + + ShardTransactionCreator(DOMStoreTransaction transaction, ActorRef shardActor, + SchemaContext schemaContext, DatastoreContext datastoreContext, + ShardStats shardStats, String transactionID, short txnClientVersion) { + this.transaction = transaction; + this.shardActor = shardActor; + this.shardStats = shardStats; + this.schemaContext = schemaContext; + this.datastoreContext = datastoreContext; + this.transactionID = transactionID; + this.txnClientVersion = txnClientVersion; + } - public CompositeModification getModification() { - return modification; + @Override + public ShardTransaction create() throws Exception { + ShardTransaction tx; + if(transaction instanceof DOMStoreReadWriteTransaction) { + tx = new ShardReadWriteTransaction((DOMStoreReadWriteTransaction)transaction, + shardActor, schemaContext, shardStats, transactionID, txnClientVersion); + } else if(transaction instanceof DOMStoreReadTransaction) { + tx = new ShardReadTransaction((DOMStoreReadTransaction)transaction, shardActor, + schemaContext, shardStats, transactionID, txnClientVersion); + } else { + tx = new ShardWriteTransaction((DOMStoreWriteTransaction)transaction, + shardActor, schemaContext, shardStats, transactionID, txnClientVersion); + } + + tx.getContext().setReceiveTimeout(datastoreContext.getShardTransactionIdleTimeout()); + return tx; + } } - } }