Merge " Expose more information about a Shard via JMX"
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / Shard.java
index a7089a7f75c9cd01a5c336a5f400a71c30a605fd..27744fcb8de8e5cde22c16090908850f231bfec8 100644 (file)
@@ -15,11 +15,8 @@ import akka.event.Logging;
 import akka.event.LoggingAdapter;
 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;
@@ -27,6 +24,7 @@ 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;
@@ -34,20 +32,27 @@ import org.opendaylight.controller.cluster.datastore.messages.RegisterChangeList
 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.md.sal.dom.store.impl.InMemoryDOMDataStoreFactory;
 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.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 <br/>
@@ -57,10 +62,9 @@ import java.util.concurrent.Executors;
  */
 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";
 
     private final InMemoryDOMDataStore store;
 
@@ -80,8 +84,10 @@ public class Shard extends RaftActor {
 
     private final ShardStats shardMBean;
 
+    private final List<ActorSelection> dataChangeListeners = new ArrayList<>();
+
     private Shard(String name, Map<String, String> peerAddresses) {
-        super(name, peerAddresses);
+        super(name, peerAddresses, Optional.of(configParams));
 
         this.name = name;
 
@@ -91,13 +97,14 @@ public class Shard extends RaftActor {
 
         LOG.info("Creating shard : {} persistent : {}", name, persistent);
 
-        store = new InMemoryDOMDataStore(name, storeExecutor);
+        store = InMemoryDOMDataStoreFactory.create(name, null);
 
         shardMBean = ShardMBeanFactory.getShardStatsMBean(name);
 
     }
 
-    public static Props props(final String name, final Map<String, String> peerAddresses) {
+    public static Props props(final String name,
+        final Map<String, String> peerAddresses) {
         return Props.create(new Creator<Shard>() {
 
             @Override
@@ -109,58 +116,111 @@ public class Shard extends RaftActor {
     }
 
 
-    @Override public void onReceiveCommand(Object message){
-        LOG.debug("Received message {} from {}", message.getClass().toString(), getSender());
+    @Override public void onReceiveCommand(Object message) {
+        LOG.debug("Received message {} from {}", message.getClass().toString(),
+            getSender());
 
-        if (message.getClass().equals(CreateTransactionChain.SERIALIZABLE_CLASS)) {
-            if(isLeader()) {
+        if (message.getClass()
+            .equals(CreateTransactionChain.SERIALIZABLE_CLASS)) {
+            if (isLeader()) {
                 createTransactionChain();
-            } else if(getLeader() != null){
+            } else if (getLeader() != null) {
                 getLeader().forward(message, getContext());
             }
-        } else if (message.getClass().equals(RegisterChangeListener.SERIALIZABLE_CLASS)) {
-            registerChangeListener(RegisterChangeListener.fromSerializable(getContext().system(), message));
+        } 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()) {
+        } else if (message.getClass()
+            .equals(CreateTransaction.SERIALIZABLE_CLASS)) {
+            if (isLeader()) {
                 createTransaction(CreateTransaction.fromSerializable(message));
-            } else if(getLeader() != null){
+            } else if (getLeader() != null) {
                 getLeader().forward(message, getContext());
             }
-        } else if (message instanceof PeerAddressResolved){
+        } else if (message instanceof PeerAddressResolved) {
             PeerAddressResolved resolved = (PeerAddressResolved) message;
             setPeerAddress(resolved.getPeerId(), resolved.getPeerAddress());
         } else {
-          super.onReceiveCommand(message);
+            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) {
-        DOMStoreReadWriteTransaction transaction =
-            store.newReadWriteTransaction();
+
         String transactionId = "shard-" + createTransaction.getTransactionId();
-        LOG.info("Creating transaction : {} " , transactionId);
-        ActorRef transactionActor = getContext().actorOf(
-            ShardTransaction.props(transaction, getSelf(), schemaContext), transactionId);
+        LOG.info("Creating transaction : {} ", transactionId);
+        ActorRef transactionActor =
+            createTypedTransactionActor(createTransaction, transactionId);
 
         getSender()
-            .tell(new CreateTransactionReply(Serialization.serializedActorPath(transactionActor), createTransaction.getTransactionId()).toSerializable(),
-                getSelf());
+            .tell(new CreateTransactionReply(
+                    Serialization.serializedActorPath(transactionActor),
+                    createTransaction.getTransactionId()).toSerializable(),
+                getSelf()
+            );
     }
 
     private void commit(final ActorRef sender, Object serialized) {
-        Modification modification = MutableCompositeModification.fromSerializable(serialized, schemaContext);
+        Modification modification =
+            MutableCompositeModification.fromSerializable(
+                serialized, schemaContext);
         DOMStoreThreePhaseCommitCohort cohort =
             modificationToCohort.remove(serialized);
         if (cohort == null) {
             LOG.error(
-                "Could not find cohort for modification : " + modification);
+                "Could not find cohort for modification : {}", modification);
             LOG.info("Writing modification using a new transaction");
-            modification.apply(store.newReadWriteTransaction());
-            return;
+            DOMStoreReadWriteTransaction transaction =
+                store.newReadWriteTransaction();
+            modification.apply(transaction);
+            DOMStoreThreePhaseCommitCohort commitCohort = transaction.ready();
+            ListenableFuture<Void> 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);
+            }
         }
 
         final ListenableFuture<Void> future = cohort.commit();
@@ -172,7 +232,7 @@ public class Shard extends RaftActor {
                 try {
                     future.get();
 
-                    if(sender != null) {
+                    if (sender != null) {
                         sender
                             .tell(new CommitTransactionReply().toSerializable(),
                                 self);
@@ -188,13 +248,15 @@ public class Shard extends RaftActor {
     }
 
     private void handleForwardedCommit(ForwardedCommitTransaction message) {
-        Object serializedModification = message.getModification().toSerializable();
+        Object serializedModification =
+            message.getModification().toSerializable();
 
         modificationToCohort
-            .put(serializedModification , message.getCohort());
+            .put(serializedModification, message.getCohort());
 
-        if(persistent) {
-            this.persistData(getSender(), "identifier", new CompositeModificationPayload(serializedModification));
+        if (persistent) {
+            this.persistData(getSender(), "identifier",
+                new CompositeModificationPayload(serializedModification));
         } else {
             this.commit(getSender(), serializedModification);
         }
@@ -208,15 +270,28 @@ public class Shard extends RaftActor {
     private void registerChangeListener(
         RegisterChangeListener registerChangeListener) {
 
-        LOG.debug("registerDataChangeListener for " + registerChangeListener.getPath());
+        LOG.debug("registerDataChangeListener for " + registerChangeListener
+            .getPath());
 
 
         ActorSelection dataChangeListenerPath = getContext()
             .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());
+
+        // 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<YangInstanceIdentifier, NormalizedNode<?, ?>>
-            listener = new DataChangeListenerProxy(schemaContext,dataChangeListenerPath);
+            listener =
+            new DataChangeListenerProxy(schemaContext, dataChangeListenerPath);
 
         org.opendaylight.yangtools.concepts.ListenerRegistration<AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>>>
             registration =
@@ -226,10 +301,12 @@ public class Shard extends RaftActor {
             getContext().actorOf(
                 DataChangeListenerRegistration.props(registration));
 
-        LOG.debug("registerDataChangeListener sending reply, listenerRegistrationPath = " + listenerRegistration.path().toString());
+        LOG.debug(
+            "registerDataChangeListener sending reply, listenerRegistrationPath = "
+                + listenerRegistration.path().toString());
 
         getSender()
-            .tell(new RegisterChangeListenerReply(listenerRegistration.path()).toSerializable(),
+            .tell(new RegisterChangeListenerReply(listenerRegistration.path()),
                 getSelf());
     }
 
@@ -240,21 +317,39 @@ public class Shard extends RaftActor {
                 ShardTransactionChain.props(chain, schemaContext));
         getSender()
             .tell(new CreateTransactionChainReply(transactionChain.path())
-                .toSerializable(),
-                getSelf());
+                    .toSerializable(),
+                getSelf()
+            );
     }
 
     @Override protected void applyState(ActorRef clientActor, String identifier,
         Object data) {
 
-        if(data instanceof CompositeModificationPayload){
+        if (data instanceof CompositeModificationPayload) {
             Object modification =
                 ((CompositeModificationPayload) data).getModification();
-            commit(clientActor, modification);
+
+            if (modification != null) {
+                commit(clientActor, modification);
+            } else {
+                LOG.error("modification is null - this is very unexpected");
+            }
+
+
         } 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() {
@@ -265,7 +360,31 @@ public class Shard extends RaftActor {
         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;
+        }
+    }
 }