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=0717598f0c09d83b5c2d3b17a04462ed1f3a4149;hp=8365328669587b5e083c8e53ca819eb63857cd40;hb=3e35e82b3b253de08e3ea07d2af8b2c1696272e9;hpb=2a35e5ab8c3300757a425841d017097c1fa31e68 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 8365328669..0717598f0c 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 @@ -9,63 +9,387 @@ package org.opendaylight.controller.cluster.datastore; import akka.actor.ActorRef; +import akka.actor.ActorSelection; +import akka.actor.Props; import akka.event.Logging; import akka.event.LoggingAdapter; -import akka.persistence.UntypedProcessor; +import akka.japi.Creator; +import akka.serialization.Serialization; +import com.google.common.base.Optional; +import com.google.common.util.concurrent.ListenableFuture; import com.google.common.util.concurrent.ListeningExecutorService; import com.google.common.util.concurrent.MoreExecutors; +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.PeerAddressResolved; 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.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.md.sal.common.api.data.AsyncDataChangeListener; import org.opendaylight.controller.md.sal.dom.store.impl.InMemoryDOMDataStore; +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.yangtools.yang.data.api.InstanceIdentifier; +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.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 - *

+ * A Shard represents a portion of the logical data tree
+ *

* Our Shard uses InMemoryDataStore as it's internal representation and delegates all requests it - * + *

*/ -public class Shard extends UntypedProcessor { +public class Shard extends RaftActor { + + private static final ConfigParams configParams = new ShardConfigParams(); + + public static final String DEFAULT_NAME = "default"; + + private final ListeningExecutorService storeExecutor = + MoreExecutors.listeningDecorator(Executors.newFixedThreadPool(2)); + + private final InMemoryDOMDataStore store; + + private final Map + modificationToCohort = new HashMap<>(); + + 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 + private final boolean persistent; + + private final String name; + + private volatile SchemaContext schemaContext; + + private final ShardStats shardMBean; + + private final List dataChangeListeners = new ArrayList<>(); + + private Shard(String name, Map peerAddresses) { + super(name, peerAddresses, Optional.of(configParams)); + + this.name = name; + + String setting = System.getProperty("shard.persistent"); + + this.persistent = !"false".equals(setting); + + LOG.info("Creating shard : {} persistent : {}", name, persistent); + + store = new InMemoryDOMDataStore(name, storeExecutor); + + shardMBean = ShardMBeanFactory.getShardStatsMBean(name); + + } + + public static Props props(final String name, + final Map peerAddresses) { + return Props.create(new Creator() { + + @Override + public Shard create() throws Exception { + return new Shard(name, peerAddresses); + } + + }); + } + + + @Override public void onReceiveCommand(Object message) { + LOG.debug("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 instanceof RegisterChangeListener) { + registerChangeListener((RegisterChangeListener) message); + } else if (message instanceof UpdateSchemaContext) { + updateSchemaContext((UpdateSchemaContext) message); + } else if (message instanceof ForwardedCommitTransaction) { + handleForwardedCommit((ForwardedCommitTransaction) message); + } 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(), resolved.getPeerAddress()); + } else { + super.onReceiveCommand(message); + } + } + + private ActorRef createTypedTransactionActor( + CreateTransaction createTransaction, String transactionId) { + if (createTransaction.getTransactionType() + == TransactionProxy.TransactionType.READ_ONLY.ordinal()) { + shardMBean.incrementReadOnlyTransactionCount(); + return getContext().actorOf( + ShardTransaction + .props(store.newReadOnlyTransaction(), getSelf(), + schemaContext), transactionId); + + } else if (createTransaction.getTransactionType() + == TransactionProxy.TransactionType.READ_WRITE.ordinal()) { + shardMBean.incrementReadWriteTransactionCount(); + return getContext().actorOf( + ShardTransaction + .props(store.newReadWriteTransaction(), getSelf(), + schemaContext), transactionId); + + + } else if (createTransaction.getTransactionType() + == TransactionProxy.TransactionType.WRITE_ONLY.ordinal()) { + shardMBean.incrementWriteOnlyTransactionCount(); + return getContext().actorOf( + ShardTransaction + .props(store.newWriteOnlyTransaction(), getSelf(), + schemaContext), transactionId); + } else { + throw new IllegalArgumentException( + "CreateTransaction message has unidentified transaction type=" + + createTransaction.getTransactionType()); + } + } + + private void createTransaction(CreateTransaction createTransaction) { + + String transactionId = "shard-" + createTransaction.getTransactionId(); + LOG.info("Creating transaction : {} ", transactionId); + ActorRef transactionActor = + createTypedTransactionActor(createTransaction, transactionId); + + getSender() + .tell(new CreateTransactionReply( + Serialization.serializedActorPath(transactionActor), + createTransaction.getTransactionId()).toSerializable(), + getSelf() + ); + } + + 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.info("Writing modification using a new transaction"); + DOMStoreReadWriteTransaction transaction = + store.newReadWriteTransaction(); + modification.apply(transaction); + DOMStoreThreePhaseCommitCohort commitCohort = transaction.ready(); + ListenableFuture future = + commitCohort.preCommit(); + try { + future.get(); + future = commitCohort.commit(); + future.get(); + } catch (InterruptedException e) { + LOG.error("Failed to commit", e); + } catch (ExecutionException e) { + LOG.error("Failed to commit", e); + } + } - ListeningExecutorService storeExecutor = MoreExecutors.listeningDecorator(Executors.newFixedThreadPool(2)); + final ListenableFuture future = cohort.commit(); + shardMBean.incrementCommittedTransactionCount(); + final ActorRef self = getSelf(); + future.addListener(new Runnable() { + @Override + public void run() { + try { + future.get(); + + if (sender != null) { + sender + .tell(new CommitTransactionReply().toSerializable(), + self); + } else { + LOG.error("sender is null ???"); + } + } catch (InterruptedException | ExecutionException e) { + // FIXME : Handle this properly + LOG.error(e, "An exception happened when committing"); + } + } + }, getContext().dispatcher()); + } + + private void handleForwardedCommit(ForwardedCommitTransaction message) { + Object serializedModification = + message.getModification().toSerializable(); + + modificationToCohort + .put(serializedModification, message.getCohort()); + + if (persistent) { + this.persistData(getSender(), "identifier", + new CompositeModificationPayload(serializedModification)); + } else { + this.commit(getSender(), serializedModification); + } + } + + private void updateSchemaContext(UpdateSchemaContext message) { + this.schemaContext = message.getSchemaContext(); + store.onGlobalContextUpdated(message.getSchemaContext()); + } + + private void registerChangeListener( + RegisterChangeListener registerChangeListener) { + + LOG.debug("registerDataChangeListener for " + registerChangeListener + .getPath()); - private final InMemoryDOMDataStore store = new InMemoryDOMDataStore("OPER", storeExecutor); - LoggingAdapter log = Logging.getLogger(getContext().system(), this); + ActorSelection dataChangeListenerPath = getContext() + .system().actorSelection( + registerChangeListener.getDataChangeListenerPath()); - @Override - public void onReceive(Object message) throws Exception { - if (message instanceof CreateTransactionChain) { - createTransactionChain(); - } else if(message instanceof RegisterChangeListener){ - registerChangeListener((RegisterChangeListener) message); - } else if(message instanceof UpdateSchemaContext){ - updateSchemaContext((UpdateSchemaContext) message); + + // 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()); + + // 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); + + AsyncDataChangeListener> + listener = + new DataChangeListenerProxy(schemaContext, dataChangeListenerPath); + + org.opendaylight.yangtools.concepts.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()), + getSelf()); + } + + private void createTransactionChain() { + DOMStoreTransactionChain chain = store.createTransactionChain(); + ActorRef transactionChain = + getContext().actorOf( + ShardTransactionChain.props(chain, schemaContext)); + getSender() + .tell(new CreateTransactionChainReply(transactionChain.path()) + .toSerializable(), + getSelf() + ); } - } - private void updateSchemaContext(UpdateSchemaContext message) { - store.onGlobalContextUpdated(message.getSchemaContext()); - } + @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"); + } - private void registerChangeListener(RegisterChangeListener registerChangeListener) { - org.opendaylight.yangtools.concepts.ListenerRegistration>> registration = - store.registerChangeListener(registerChangeListener.getPath(), registerChangeListener.getListener(), registerChangeListener.getScope()); - ActorRef listenerRegistration = getContext().actorOf(ListenerRegistration.props(registration)); - getSender().tell(new RegisterChangeListenerReply(listenerRegistration.path()), getSelf()); - } - private void createTransactionChain() { - DOMStoreTransactionChain chain = store.createTransactionChain(); - ActorRef transactionChain = getContext().actorOf(ShardTransactionChain.props(chain)); - getSender().tell(new CreateTransactionChainReply(transactionChain.path()), getSelf()); - } + } else { + LOG.error("Unknown state received {}", data); + } + + ReplicatedLogEntry lastLogEntry = getLastLogEntry(); + + if(lastLogEntry != null){ + shardMBean.setLastLogIndex(lastLogEntry.getIndex()); + shardMBean.setLastLogTerm(lastLogEntry.getTerm()); + } + + shardMBean.setCommitIndex(getCommitIndex()); + shardMBean.setLastApplied(getLastApplied()); + + } + + @Override protected Object createSnapshot() { + throw new UnsupportedOperationException("createSnapshot"); + } + + @Override protected void applySnapshot(Object snapshot) { + throw new UnsupportedOperationException("applySnapshot"); + } + + @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; + } + + + 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; + } + } }