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%2FShard.java;h=f3f8b8b193c78a5511c02ec6ede526f632c3f172;hp=abcde747b93b132f8c492f25ac8af43f96c84a26;hb=680f28578ae2d6c650422220a35bb69605bfb7c4;hpb=758e3e3b16e73298221a78872149814baf735c7d diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/Shard.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/Shard.java index abcde747b9..f3f8b8b193 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/Shard.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/Shard.java @@ -10,54 +10,67 @@ package org.opendaylight.controller.cluster.datastore; import akka.actor.ActorRef; import akka.actor.ActorSelection; +import akka.actor.PoisonPill; import akka.actor.Props; import akka.event.Logging; import akka.event.LoggingAdapter; import akka.japi.Creator; +import akka.persistence.RecoveryFailure; import akka.serialization.Serialization; - +import com.google.common.annotations.VisibleForTesting; import com.google.common.base.Optional; import com.google.common.base.Preconditions; +import com.google.common.util.concurrent.CheckedFuture; import com.google.common.util.concurrent.FutureCallback; import com.google.common.util.concurrent.Futures; import com.google.common.util.concurrent.ListenableFuture; - +import com.google.protobuf.ByteString; +import com.google.protobuf.InvalidProtocolBufferException; +import org.opendaylight.controller.cluster.common.actor.CommonConfig; +import org.opendaylight.controller.cluster.common.actor.MeteringBehavior; import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier; import org.opendaylight.controller.cluster.datastore.identifiers.ShardTransactionIdentifier; import org.opendaylight.controller.cluster.datastore.jmx.mbeans.shard.ShardMBeanFactory; import org.opendaylight.controller.cluster.datastore.jmx.mbeans.shard.ShardStats; +import org.opendaylight.controller.cluster.datastore.messages.CloseTransactionChain; import org.opendaylight.controller.cluster.datastore.messages.CommitTransactionReply; import org.opendaylight.controller.cluster.datastore.messages.CreateTransaction; -import org.opendaylight.controller.cluster.datastore.messages.CreateTransactionChain; import org.opendaylight.controller.cluster.datastore.messages.CreateTransactionChainReply; import org.opendaylight.controller.cluster.datastore.messages.CreateTransactionReply; import org.opendaylight.controller.cluster.datastore.messages.EnableNotification; import org.opendaylight.controller.cluster.datastore.messages.ForwardedCommitTransaction; import org.opendaylight.controller.cluster.datastore.messages.PeerAddressResolved; +import org.opendaylight.controller.cluster.datastore.messages.ReadData; +import org.opendaylight.controller.cluster.datastore.messages.ReadDataReply; import org.opendaylight.controller.cluster.datastore.messages.RegisterChangeListener; import org.opendaylight.controller.cluster.datastore.messages.RegisterChangeListenerReply; import org.opendaylight.controller.cluster.datastore.messages.UpdateSchemaContext; import org.opendaylight.controller.cluster.datastore.modification.Modification; import org.opendaylight.controller.cluster.datastore.modification.MutableCompositeModification; +import org.opendaylight.controller.cluster.datastore.node.NormalizedNodeToNodeCodec; import org.opendaylight.controller.cluster.raft.ConfigParams; import org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl; import org.opendaylight.controller.cluster.raft.RaftActor; import org.opendaylight.controller.cluster.raft.ReplicatedLogEntry; +import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshotReply; +import org.opendaylight.controller.cluster.raft.protobuff.client.messages.CompositeModificationPayload; import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeListener; +import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException; import org.opendaylight.controller.md.sal.dom.store.impl.InMemoryDOMDataStore; import org.opendaylight.controller.md.sal.dom.store.impl.InMemoryDOMDataStoreFactory; -import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadWriteTransaction; +import org.opendaylight.controller.protobuff.messages.common.NormalizedNodeMessages; +import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadTransaction; 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.DOMStoreTransactionFactory; +import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction; import org.opendaylight.yangtools.concepts.ListenerRegistration; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; import org.opendaylight.yangtools.yang.model.api.SchemaContext; - import scala.concurrent.duration.FiniteDuration; import java.util.ArrayList; -import java.util.Date; import java.util.HashMap; import java.util.List; import java.util.Map; @@ -96,16 +109,21 @@ public class Shard extends RaftActor { private final List dataChangeListeners = new ArrayList<>(); - private final ShardContext shardContext; + private final DatastoreContext datastoreContext; private SchemaContext schemaContext; + private ActorRef createSnapshotTransaction; + + private final Map transactionChains = new HashMap<>(); + private Shard(ShardIdentifier name, Map peerAddresses, - ShardContext shardContext) { + DatastoreContext datastoreContext, SchemaContext schemaContext) { super(name.toString(), mapPeerAddresses(peerAddresses), Optional.of(configParams)); this.name = name; - this.shardContext = shardContext; + this.datastoreContext = datastoreContext; + this.schemaContext = schemaContext; String setting = System.getProperty("shard.persistent"); @@ -114,10 +132,20 @@ public class Shard extends RaftActor { LOG.info("Shard created : {} persistent : {}", name, persistent); store = InMemoryDOMDataStoreFactory.create(name.toString(), null, - shardContext.getDataStoreProperties()); + datastoreContext.getDataStoreProperties()); - shardMBean = ShardMBeanFactory.getShardStatsMBean(name.toString()); + if(schemaContext != null) { + store.onGlobalContextUpdated(schemaContext); + } + + shardMBean = ShardMBeanFactory.getShardStatsMBean(name.toString(), + datastoreContext.getDataStoreMXBeanType()); + shardMBean.setDataStoreExecutor(store.getDomStoreExecutor()); + shardMBean.setNotificationManager(store.getDataChangeListenerNotificationManager()); + if (isMetricsCaptureEnabled()) { + getContext().become(new MeteringBehavior(this)); + } } private static Map mapPeerAddresses( @@ -134,25 +162,44 @@ public class Shard extends RaftActor { public static Props props(final ShardIdentifier name, final Map peerAddresses, - ShardContext shardContext) { + DatastoreContext datastoreContext, SchemaContext schemaContext) { Preconditions.checkNotNull(name, "name should not be null"); Preconditions.checkNotNull(peerAddresses, "peerAddresses should not be null"); - Preconditions.checkNotNull(shardContext, "shardContext should not be null"); + Preconditions.checkNotNull(datastoreContext, "dataStoreContext should not be null"); + Preconditions.checkNotNull(schemaContext, "schemaContext should not be null"); + + return Props.create(new ShardCreator(name, peerAddresses, datastoreContext, schemaContext)); + } + + @Override public void onReceiveRecover(Object message) { + LOG.debug("onReceiveRecover: Received message {} from {}", message.getClass().toString(), + getSender()); - return Props.create(new ShardCreator(name, peerAddresses, shardContext)); + if (message instanceof RecoveryFailure){ + LOG.error(((RecoveryFailure) message).cause(), "Recovery failed because of this cause"); + } else { + super.onReceiveRecover(message); + } } @Override public void onReceiveCommand(Object message) { - LOG.debug("Received message {} from {}", message.getClass().toString(), + LOG.debug("onReceiveCommand: Received message {} from {}", message.getClass().toString(), getSender()); - if (message.getClass() - .equals(CreateTransactionChain.SERIALIZABLE_CLASS)) { - if (isLeader()) { - createTransactionChain(); - } else if (getLeader() != null) { - getLeader().forward(message, getContext()); - } + if(message.getClass().equals(ReadDataReply.SERIALIZABLE_CLASS)) { + // This must be for install snapshot. Don't want to open this up and trigger + // deSerialization + self() + .tell(new CaptureSnapshotReply(ReadDataReply.getNormalizedNodeByteString(message)), + self()); + + createSnapshotTransaction = null; + // Send a PoisonPill instead of sending close transaction because we do not really need + // a response + getSender().tell(PoisonPill.getInstance(), self()); + + } else if (message.getClass().equals(CloseTransactionChain.SERIALIZABLE_CLASS)){ + closeTransactionChain(CloseTransactionChain.fromSerializable(message)); } else if (message instanceof RegisterChangeListener) { registerChangeListener((RegisterChangeListener) message); } else if (message instanceof UpdateSchemaContext) { @@ -165,6 +212,9 @@ public class Shard extends RaftActor { createTransaction(CreateTransaction.fromSerializable(message)); } else if (getLeader() != null) { getLeader().forward(message, getContext()); + } else { + getSender().tell(new akka.actor.Status.Failure(new IllegalStateException( + "Could not find leader so transaction cannot be created")), getSelf()); } } else if (message instanceof PeerAddressResolved) { PeerAddressResolved resolved = (PeerAddressResolved) message; @@ -175,60 +225,101 @@ public class Shard extends RaftActor { } } + private void closeTransactionChain(CloseTransactionChain closeTransactionChain) { + DOMStoreTransactionChain chain = + transactionChains.remove(closeTransactionChain.getTransactionChainId()); + + if(chain != null) { + chain.close(); + } + } + private ActorRef createTypedTransactionActor( - CreateTransaction createTransaction, - ShardTransactionIdentifier transactionId) { - if (createTransaction.getTransactionType() + int transactionType, + ShardTransactionIdentifier transactionId, + String transactionChainId ) { + + DOMStoreTransactionFactory factory = store; + + if(!transactionChainId.isEmpty()) { + factory = transactionChains.get(transactionChainId); + if(factory == null){ + DOMStoreTransactionChain transactionChain = store.createTransactionChain(); + transactionChains.put(transactionChainId, transactionChain); + factory = transactionChain; + } + } + + if(this.schemaContext == null){ + throw new NullPointerException("schemaContext should not be null"); + } + + if (transactionType == TransactionProxy.TransactionType.READ_ONLY.ordinal()) { shardMBean.incrementReadOnlyTransactionCount(); return getContext().actorOf( - ShardTransaction.props(store.newReadOnlyTransaction(), getSelf(), - schemaContext, shardContext), transactionId.toString()); + ShardTransaction.props(factory.newReadOnlyTransaction(), getSelf(), + schemaContext,datastoreContext, shardMBean), transactionId.toString()); - } else if (createTransaction.getTransactionType() + } else if (transactionType == TransactionProxy.TransactionType.READ_WRITE.ordinal()) { shardMBean.incrementReadWriteTransactionCount(); return getContext().actorOf( - ShardTransaction.props(store.newReadWriteTransaction(), getSelf(), - schemaContext, shardContext), transactionId.toString()); + ShardTransaction.props(factory.newReadWriteTransaction(), getSelf(), + schemaContext, datastoreContext, shardMBean), transactionId.toString()); - } else if (createTransaction.getTransactionType() + } else if (transactionType == TransactionProxy.TransactionType.WRITE_ONLY.ordinal()) { shardMBean.incrementWriteOnlyTransactionCount(); return getContext().actorOf( - ShardTransaction.props(store.newWriteOnlyTransaction(), getSelf(), - schemaContext, shardContext), transactionId.toString()); + ShardTransaction.props(factory.newWriteOnlyTransaction(), getSelf(), + schemaContext, datastoreContext, shardMBean), transactionId.toString()); } else { throw new IllegalArgumentException( "Shard="+name + ":CreateTransaction message has unidentified transaction type=" - + createTransaction.getTransactionType()); + + transactionType); } } private void createTransaction(CreateTransaction createTransaction) { + createTransaction(createTransaction.getTransactionType(), + createTransaction.getTransactionId(), createTransaction.getTransactionChainId()); + } + + private ActorRef createTransaction(int transactionType, String remoteTransactionId, String transactionChainId) { ShardTransactionIdentifier transactionId = ShardTransactionIdentifier.builder() - .remoteTransactionId(createTransaction.getTransactionId()) + .remoteTransactionId(remoteTransactionId) .build(); LOG.debug("Creating transaction : {} ", transactionId); ActorRef transactionActor = - createTypedTransactionActor(createTransaction, transactionId); + createTypedTransactionActor(transactionType, transactionId, transactionChainId); getSender() .tell(new CreateTransactionReply( Serialization.serializedActorPath(transactionActor), - createTransaction.getTransactionId()).toSerializable(), + remoteTransactionId).toSerializable(), getSelf()); + + return transactionActor; + } + + private void syncCommitTransaction(DOMStoreWriteTransaction transaction) + throws ExecutionException, InterruptedException { + DOMStoreThreePhaseCommitCohort commitCohort = transaction.ready(); + commitCohort.preCommit().get(); + commitCohort.commit().get(); } + private void commit(final ActorRef sender, Object serialized) { Modification modification = MutableCompositeModification .fromSerializable(serialized, schemaContext); @@ -238,16 +329,14 @@ public class Shard extends RaftActor { LOG.debug( "Could not find cohort for modification : {}. Writing modification using a new transaction", modification); - DOMStoreReadWriteTransaction transaction = - store.newReadWriteTransaction(); + DOMStoreWriteTransaction transaction = + store.newWriteOnlyTransaction(); + + LOG.debug("Created new transaction {}", transaction.getIdentifier().toString()); + modification.apply(transaction); - DOMStoreThreePhaseCommitCohort commitCohort = transaction.ready(); - ListenableFuture future = - commitCohort.preCommit(); try { - future.get(); - future = commitCohort.commit(); - future.get(); + syncCommitTransaction(transaction); } catch (InterruptedException | ExecutionException e) { shardMBean.incrementFailedTransactionsCount(); LOG.error("Failed to commit", e); @@ -258,15 +347,21 @@ public class Shard extends RaftActor { return; } + + if(sender == null){ + LOG.error("Commit failed. Sender cannot be null"); + return; + } + final ListenableFuture future = cohort.commit(); final ActorRef self = getSelf(); Futures.addCallback(future, new FutureCallback() { @Override public void onSuccess(Void v) { - sender.tell(new CommitTransactionReply().toSerializable(),self); - shardMBean.incrementCommittedTransactionCount(); - shardMBean.setLastCommittedTransactionTime(new Date()); + sender.tell(new CommitTransactionReply().toSerializable(), self); + shardMBean.incrementCommittedTransactionCount(); + shardMBean.setLastCommittedTransactionTime(System.currentTimeMillis()); } @Override @@ -296,9 +391,14 @@ public class Shard extends RaftActor { private void updateSchemaContext(UpdateSchemaContext message) { this.schemaContext = message.getSchemaContext(); + updateSchemaContext(message.getSchemaContext()); store.onGlobalContextUpdated(message.getSchemaContext()); } + @VisibleForTesting void updateSchemaContext(SchemaContext schemaContext) { + store.onGlobalContextUpdated(schemaContext); + } + private void registerChangeListener( RegisterChangeListener registerChangeListener) { @@ -343,11 +443,16 @@ public class Shard extends RaftActor { private void createTransactionChain() { DOMStoreTransactionChain chain = store.createTransactionChain(); ActorRef transactionChain = getContext().actorOf( - ShardTransactionChain.props(chain, schemaContext, shardContext)); + ShardTransactionChain.props(chain, schemaContext, datastoreContext, shardMBean)); getSender().tell(new CreateTransactionChainReply(transactionChain.path()).toSerializable(), getSelf()); } + private boolean isMetricsCaptureEnabled(){ + CommonConfig config = new CommonConfig(getContext().system().settings().config()); + return config.isMetricCaptureEnabled(); + } + @Override protected void applyState(ActorRef clientActor, String identifier, Object data) { @@ -363,9 +468,8 @@ public class Shard extends RaftActor { identifier, clientActor.path().toString()); } - } else { - LOG.error("Unknown state received {}", data); + LOG.error("Unknown state received {} Class loader = {} CompositeNodeMod.ClassLoader = {}", data, data.getClass().getClassLoader(), CompositeModificationPayload.class.getClassLoader()); } // Update stats @@ -381,12 +485,44 @@ public class Shard extends RaftActor { } - @Override protected Object createSnapshot() { - throw new UnsupportedOperationException("createSnapshot"); + @Override protected void createSnapshot() { + if (createSnapshotTransaction == null) { + + // Create a transaction. We are really going to treat the transaction as a worker + // so that this actor does not get block building the snapshot + createSnapshotTransaction = createTransaction( + TransactionProxy.TransactionType.READ_ONLY.ordinal(), + "createSnapshot", ""); + + createSnapshotTransaction.tell( + new ReadData(YangInstanceIdentifier.builder().build()).toSerializable(), self()); + + } } - @Override protected void applySnapshot(Object snapshot) { - throw new UnsupportedOperationException("applySnapshot"); + @VisibleForTesting @Override protected void applySnapshot(ByteString snapshot) { + // Since this will be done only on Recovery or when this actor is a Follower + // we can safely commit everything in here. We not need to worry about event notifications + // as they would have already been disabled on the follower + + LOG.info("Applying snapshot"); + try { + DOMStoreWriteTransaction transaction = store.newWriteOnlyTransaction(); + NormalizedNodeMessages.Node serializedNode = NormalizedNodeMessages.Node.parseFrom(snapshot); + NormalizedNode node = new NormalizedNodeToNodeCodec(schemaContext) + .decode(YangInstanceIdentifier.builder().build(), serializedNode); + + // delete everything first + transaction.delete(YangInstanceIdentifier.builder().build()); + + // Add everything from the remote node back + transaction.write(YangInstanceIdentifier.builder().build(), node); + syncCommitTransaction(transaction); + } catch (InvalidProtocolBufferException | InterruptedException | ExecutionException e) { + LOG.error(e, "An exception occurred when applying snapshot"); + } finally { + LOG.info("Done applying snapshot"); + } } @Override protected void onStateChanged() { @@ -395,12 +531,23 @@ public class Shard extends RaftActor { .tell(new EnableNotification(isLeader()), getSelf()); } - if (getLeaderId() != null) { - shardMBean.setLeader(getLeaderId()); - } shardMBean.setRaftState(getRaftState().name()); shardMBean.setCurrentTerm(getCurrentTerm()); + + // If this actor is no longer the leader close all the transaction chains + if(!isLeader()){ + for(Map.Entry entry : transactionChains.entrySet()){ + LOG.debug("onStateChanged: Closing transaction chain {} because shard {} is no longer the leader", entry.getKey(), getId()); + entry.getValue().close(); + } + + transactionChains.clear(); + } + } + + @Override protected void onLeaderChanged(String oldLeader, String newLeader) { + shardMBean.setLeader(newLeader); } @Override public String persistenceId() { @@ -423,18 +570,43 @@ public class Shard extends RaftActor { final ShardIdentifier name; final Map peerAddresses; - final ShardContext shardContext; + final DatastoreContext datastoreContext; + final SchemaContext schemaContext; ShardCreator(ShardIdentifier name, Map peerAddresses, - ShardContext shardContext) { + DatastoreContext datastoreContext, SchemaContext schemaContext) { this.name = name; this.peerAddresses = peerAddresses; - this.shardContext = shardContext; + this.datastoreContext = datastoreContext; + this.schemaContext = schemaContext; } @Override public Shard create() throws Exception { - return new Shard(name, peerAddresses, shardContext); + return new Shard(name, peerAddresses, datastoreContext, schemaContext); } } + + @VisibleForTesting NormalizedNode readStore() throws ExecutionException, InterruptedException { + DOMStoreReadTransaction transaction = store.newReadOnlyTransaction(); + + CheckedFuture>, ReadFailedException> future = + transaction.read(YangInstanceIdentifier.builder().build()); + + NormalizedNode node = future.get().get(); + + transaction.close(); + + return node; + } + + @VisibleForTesting void writeToStore(YangInstanceIdentifier id, NormalizedNode node) + throws ExecutionException, InterruptedException { + DOMStoreWriteTransaction transaction = store.newWriteOnlyTransaction(); + + transaction.write(id, node); + + syncCommitTransaction(transaction); + } + }