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=b40ccd08e8fe6fbeae52845604a2bb032dd4cc15;hp=9e40a6990779a137270668dffdf22edb0ea748ec;hb=be4e53698d37883b68b96f45d5a71683ca7fd8e6;hpb=321d959d82bf14a6826e5bf42419c1a1460a1cbc 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 9e40a69907..b40ccd08e8 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,40 +10,69 @@ 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.Persistent; -import akka.persistence.UntypedProcessor; +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.common.util.concurrent.ListeningExecutorService; -import com.google.common.util.concurrent.MoreExecutors; +import com.google.protobuf.ByteString; +import com.google.protobuf.InvalidProtocolBufferException; +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.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.NonPersistent; +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.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.sal.core.spi.data.DOMStoreReadWriteTransaction; +import org.opendaylight.controller.md.sal.dom.store.impl.InMemoryDOMDataStoreFactory; +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.yangtools.yang.data.api.InstanceIdentifier; +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; import java.util.concurrent.ExecutionException; -import java.util.concurrent.Executors; +import java.util.concurrent.TimeUnit; /** * A Shard represents a portion of the logical data tree
@@ -51,159 +80,473 @@ import java.util.concurrent.Executors; * Our Shard uses InMemoryDataStore as it's internal representation and delegates all requests it *

*/ -public class Shard extends UntypedProcessor { +public class Shard extends RaftActor { - public static final String DEFAULT_NAME = "default"; + private static final ConfigParams configParams = new ShardConfigParams(); - private final ListeningExecutorService storeExecutor = - MoreExecutors.listeningDecorator(Executors.newFixedThreadPool(2)); + public static final String DEFAULT_NAME = "default"; + // The state of this Shard private final InMemoryDOMDataStore store; private final Map modificationToCohort = new HashMap<>(); - private final LoggingAdapter log = + private final LoggingAdapter LOG = Logging.getLogger(getContext().system(), this); // By default persistent will be true and can be turned off using the system - // property persistent + // property shard.persistent private final boolean persistent; + /// The name of this shard + private final ShardIdentifier name; + + private final ShardStats shardMBean; + + private final List dataChangeListeners = new ArrayList<>(); + + private final DatastoreContext datastoreContext; + + private SchemaContext schemaContext; - private Shard(String name) { + private ActorRef createSnapshotTransaction; + + private Shard(ShardIdentifier name, Map peerAddresses, + DatastoreContext datastoreContext, SchemaContext schemaContext) { + super(name.toString(), mapPeerAddresses(peerAddresses), Optional.of(configParams)); + + this.name = name; + this.datastoreContext = datastoreContext; + this.schemaContext = schemaContext; String setting = System.getProperty("shard.persistent"); + this.persistent = !"false".equals(setting); - log.info("Creating shard : {} persistent : {}", name , persistent); + LOG.info("Shard created : {} persistent : {}", name, persistent); + + store = InMemoryDOMDataStoreFactory.create(name.toString(), null, + datastoreContext.getDataStoreProperties()); + + if(schemaContext != null) { + store.onGlobalContextUpdated(schemaContext); + } + + shardMBean = ShardMBeanFactory.getShardStatsMBean(name.toString()); + - store = new InMemoryDOMDataStore(name, storeExecutor); } - public static Props props(final String name) { - return Props.create(new Creator() { + private static Map mapPeerAddresses( + Map peerAddresses) { + Map map = new HashMap<>(); - @Override - public Shard create() throws Exception { - return new Shard(name); - } + for (Map.Entry entry : peerAddresses + .entrySet()) { + map.put(entry.getKey().toString(), entry.getValue()); + } - }); + return map; } + public static Props props(final ShardIdentifier name, + final Map peerAddresses, + DatastoreContext datastoreContext, SchemaContext schemaContext) { + Preconditions.checkNotNull(name, "name should not be null"); + Preconditions.checkNotNull(peerAddresses, "peerAddresses 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 onReceive(Object message) throws Exception { - log.debug("Received message {}", message); + @Override public void onReceiveRecover(Object message) { + LOG.debug("onReceiveRecover: Received message {} from {}", message.getClass().toString(), + getSender()); - if(!recoveryFinished()){ - // FIXME : Properly handle recovery - return; + if (message instanceof RecoveryFailure){ + LOG.error(((RecoveryFailure) message).cause(), "Recovery failed because of this cause"); + } else { + super.onReceiveRecover(message); } + } - if (message instanceof CreateTransactionChain) { - createTransactionChain(); - } else if (message.getClass().equals(RegisterChangeListener.SERIALIZABLE_CLASS)) { - registerChangeListener(RegisterChangeListener.fromSerializable(getContext().system(), message)); + @Override public void onReceiveCommand(Object message) { + 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()); + } + } else 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()); + + // Send a PoisonPill instead of sending close transaction because we do not really need + // a response + getSender().tell(PoisonPill.getInstance(), self()); + + } else if (message instanceof RegisterChangeListener) { + registerChangeListener((RegisterChangeListener) message); } else if (message instanceof UpdateSchemaContext) { updateSchemaContext((UpdateSchemaContext) message); } else if (message instanceof ForwardedCommitTransaction) { handleForwardedCommit((ForwardedCommitTransaction) message); - } else if (message instanceof Persistent) { - commit(((Persistent)message).payload()); - } else if (message instanceof CreateTransaction) { - createTransaction((CreateTransaction) message); - } else if(message instanceof NonPersistent){ - commit(((NonPersistent)message).payload()); + } else if (message.getClass() + .equals(CreateTransaction.SERIALIZABLE_CLASS)) { + if (isLeader()) { + createTransaction(CreateTransaction.fromSerializable(message)); + } else if (getLeader() != null) { + getLeader().forward(message, getContext()); + } + } else if (message instanceof PeerAddressResolved) { + PeerAddressResolved resolved = (PeerAddressResolved) message; + setPeerAddress(resolved.getPeerId().toString(), + resolved.getPeerAddress()); + } else { + super.onReceiveCommand(message); + } + } + + private ActorRef createTypedTransactionActor( + int transactionType, + ShardTransactionIdentifier transactionId) { + + 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,datastoreContext, name.toString()), transactionId.toString()); + + } else if (transactionType + == TransactionProxy.TransactionType.READ_WRITE.ordinal()) { + + shardMBean.incrementReadWriteTransactionCount(); + + return getContext().actorOf( + ShardTransaction.props(store.newReadWriteTransaction(), getSelf(), + schemaContext, datastoreContext,name.toString()), transactionId.toString()); + + + } else if (transactionType + == TransactionProxy.TransactionType.WRITE_ONLY.ordinal()) { + + shardMBean.incrementWriteOnlyTransactionCount(); + + return getContext().actorOf( + ShardTransaction.props(store.newWriteOnlyTransaction(), getSelf(), + schemaContext, datastoreContext, name.toString()), transactionId.toString()); } else { - throw new Exception("Not recognized message in Shard::OnReceive"+message); + throw new IllegalArgumentException( + "Shard="+name + ":CreateTransaction message has unidentified transaction type=" + + transactionType); } } private void createTransaction(CreateTransaction createTransaction) { - DOMStoreReadWriteTransaction transaction = - store.newReadWriteTransaction(); - ActorRef transactionActor = getContext().actorOf( - ShardTransaction.props(transaction, getSelf(), schemaContext), "shard-" + createTransaction.getTransactionId()); + createTransaction(createTransaction.getTransactionType(), + createTransaction.getTransactionId()); + } + + private ActorRef createTransaction(int transactionType, String remoteTransactionId) { + + ShardTransactionIdentifier transactionId = + ShardTransactionIdentifier.builder() + .remoteTransactionId(remoteTransactionId) + .build(); + LOG.debug("Creating transaction : {} ", transactionId); + ActorRef transactionActor = + createTypedTransactionActor(transactionType, transactionId); + getSender() - .tell(new CreateTransactionReply(transactionActor.path().toString(), createTransaction.getTransactionId()).toSerializable(), + .tell(new CreateTransactionReply( + Serialization.serializedActorPath(transactionActor), + 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(Object serialized) { - Modification modification = MutableCompositeModification.fromSerializable(serialized, schemaContext); + + private void commit(final ActorRef sender, Object serialized) { + Modification modification = MutableCompositeModification + .fromSerializable(serialized, schemaContext); DOMStoreThreePhaseCommitCohort cohort = modificationToCohort.remove(serialized); if (cohort == null) { - log.error( - "Could not find cohort for modification : " + modification); + LOG.debug( + "Could not find cohort for modification : {}. Writing modification using a new transaction", + modification); + DOMStoreWriteTransaction transaction = + store.newWriteOnlyTransaction(); + modification.apply(transaction); + try { + syncCommitTransaction(transaction); + } catch (InterruptedException | ExecutionException e) { + shardMBean.incrementFailedTransactionsCount(); + LOG.error("Failed to commit", e); + return; + } + //we want to just apply the recovery commit and return + shardMBean.incrementCommittedTransactionCount(); return; } + final ListenableFuture future = cohort.commit(); - final ActorRef sender = getSender(); final ActorRef self = getSelf(); - future.addListener(new Runnable() { + + Futures.addCallback(future, new FutureCallback() { @Override - public void run() { - try { - future.get(); - sender.tell(new CommitTransactionReply(), self); - } catch (InterruptedException | ExecutionException e) { - // FIXME : Handle this properly - log.error(e, "An exception happened when committing"); - } + public void onSuccess(Void v) { + sender.tell(new CommitTransactionReply().toSerializable(), self); + shardMBean.incrementCommittedTransactionCount(); + shardMBean.setLastCommittedTransactionTime(new Date()); } - }, getContext().dispatcher()); + + @Override + public void onFailure(Throwable t) { + LOG.error(t, "An exception happened during commit"); + shardMBean.incrementFailedTransactionsCount(); + sender.tell(new akka.actor.Status.Failure(t), self); + } + }); + } private void handleForwardedCommit(ForwardedCommitTransaction message) { - Object serializedModification = message.getModification().toSerializable(); + Object serializedModification = + message.getModification().toSerializable(); modificationToCohort - .put(serializedModification , message.getCohort()); - if(persistent) { - getSelf().forward(Persistent.create(serializedModification), - getContext()); + .put(serializedModification, message.getCohort()); + + if (persistent) { + this.persistData(getSender(), "identifier", + new CompositeModificationPayload(serializedModification)); } else { - getSelf().forward(NonPersistent.create(serializedModification), - getContext()); + this.commit(getSender(), serializedModification); } } 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) { + LOG.debug("registerDataChangeListener for {}", registerChangeListener + .getPath()); + + ActorSelection dataChangeListenerPath = getContext() - .system().actorSelection(registerChangeListener.getDataChangeListenerPath()); + .system().actorSelection( + registerChangeListener.getDataChangeListenerPath()); + + + // Notify the listener if notifications should be enabled or not + // If this shard is the leader then it will enable notifications else + // it will not + dataChangeListenerPath + .tell(new EnableNotification(isLeader()), getSelf()); - AsyncDataChangeListener> - listener = new DataChangeListenerProxy(dataChangeListenerPath); + // Now store a reference to the data change listener so it can be notified + // at a later point if notifications should be enabled or disabled + dataChangeListeners.add(dataChangeListenerPath); - org.opendaylight.yangtools.concepts.ListenerRegistration>> - registration = - store.registerChangeListener(registerChangeListener.getPath(), + AsyncDataChangeListener> + listener = new DataChangeListenerProxy(schemaContext, dataChangeListenerPath); + + ListenerRegistration>> + registration = store.registerChangeListener(registerChangeListener.getPath(), listener, registerChangeListener.getScope()); ActorRef listenerRegistration = getContext().actorOf( DataChangeListenerRegistration.props(registration)); + + LOG.debug( + "registerDataChangeListener sending reply, listenerRegistrationPath = {} " + , listenerRegistration.path().toString()); + getSender() - .tell(new RegisterChangeListenerReply(listenerRegistration.path()).toSerializable(), + .tell(new RegisterChangeListenerReply(listenerRegistration.path()), getSelf()); } private void createTransactionChain() { DOMStoreTransactionChain chain = store.createTransactionChain(); - ActorRef transactionChain = - getContext().actorOf(ShardTransactionChain.props(chain, schemaContext)); - getSender() - .tell(new CreateTransactionChainReply(transactionChain.path()), - getSelf()); + ActorRef transactionChain = getContext().actorOf( + ShardTransactionChain.props(chain, schemaContext, datastoreContext,name.toString() )); + getSender().tell(new CreateTransactionChainReply(transactionChain.path()).toSerializable(), + getSelf()); + } + + @Override protected void applyState(ActorRef clientActor, String identifier, + Object data) { + + if (data instanceof CompositeModificationPayload) { + Object modification = + ((CompositeModificationPayload) data).getModification(); + + if (modification != null) { + commit(clientActor, modification); + } else { + LOG.error( + "modification is null - this is very unexpected, clientActor = {}, identifier = {}", + identifier, clientActor.path().toString()); + } + + } else { + LOG.error("Unknown state received {}", data); + } + + // Update stats + ReplicatedLogEntry lastLogEntry = getLastLogEntry(); + + if (lastLogEntry != null) { + shardMBean.setLastLogIndex(lastLogEntry.getIndex()); + shardMBean.setLastLogTerm(lastLogEntry.getTerm()); + } + + shardMBean.setCommitIndex(getCommitIndex()); + shardMBean.setLastApplied(getLastApplied()); + + } + + @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()); + + } } + + @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 + 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"); + } + } + + @Override protected void onStateChanged() { + for (ActorSelection dataChangeListener : dataChangeListeners) { + dataChangeListener + .tell(new EnableNotification(isLeader()), getSelf()); + } + + if (getLeaderId() != null) { + shardMBean.setLeader(getLeaderId()); + } + + shardMBean.setRaftState(getRaftState().name()); + shardMBean.setCurrentTerm(getCurrentTerm()); + } + + @Override public String persistenceId() { + return this.name.toString(); + } + + + private static class ShardConfigParams extends DefaultConfigParamsImpl { + public static final FiniteDuration HEART_BEAT_INTERVAL = + new FiniteDuration(500, TimeUnit.MILLISECONDS); + + @Override public FiniteDuration getHeartBeatInterval() { + return HEART_BEAT_INTERVAL; + } + } + + private static class ShardCreator implements Creator { + + private static final long serialVersionUID = 1L; + + final ShardIdentifier name; + final Map peerAddresses; + final DatastoreContext datastoreContext; + final SchemaContext schemaContext; + + ShardCreator(ShardIdentifier name, Map peerAddresses, + DatastoreContext datastoreContext, SchemaContext schemaContext) { + this.name = name; + this.peerAddresses = peerAddresses; + this.datastoreContext = datastoreContext; + this.schemaContext = schemaContext; + } + + @Override + public Shard create() throws Exception { + 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); + } + }