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 5b4f7ef8989711dffdf4cdd8fbe7d483165f23a7..0717598f0c09d83b5c2d3b17a04462ed1f3a4149 100644 (file)
@@ -14,30 +14,47 @@ 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.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 <br/>
@@ -45,7 +62,9 @@ import java.util.concurrent.Executors;
  * Our Shard uses InMemoryDataStore as it's internal representation and delegates all requests it
  * </p>
  */
-public class Shard extends UntypedProcessor {
+public class Shard extends RaftActor {
+
+    private static final ConfigParams configParams = new ShardConfigParams();
 
     public static final String DEFAULT_NAME = "default";
 
@@ -54,94 +73,243 @@ public class Shard extends UntypedProcessor {
 
     private final InMemoryDOMDataStore store;
 
-    private final Map<Modification, DOMStoreThreePhaseCommitCohort>
+    private final Map<Object, DOMStoreThreePhaseCommitCohort>
         modificationToCohort = new HashMap<>();
 
-    private final LoggingAdapter log =
+    private final LoggingAdapter LOG =
         Logging.getLogger(getContext().system(), this);
 
-    private Shard(String name) {
+    // 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<ActorSelection> dataChangeListeners = new ArrayList<>();
+
+    private Shard(String name, Map<String, String> 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) {
+    public static Props props(final String name,
+        final Map<String, String> peerAddresses) {
         return Props.create(new Creator<Shard>() {
 
             @Override
             public Shard create() throws Exception {
-                return new Shard(name);
+                return new Shard(name, peerAddresses);
             }
 
         });
     }
 
-    @Override
-    public void onReceive(Object message) throws Exception {
-        if (message instanceof CreateTransactionChain) {
-            createTransactionChain();
+
+    @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 instanceof Persistent) {
-            commit((Persistent) 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 commit(Persistent message) {
-        Modification modification = (Modification) message.payload();
+    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(modification);
+            modificationToCohort.remove(serialized);
         if (cohort == null) {
-            log.error(
-                "Could not find cohort for modification : " + modification);
-            return;
+            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<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();
-        final ActorRef sender = getSender();
+        shardMBean.incrementCommittedTransactionCount();
         final ActorRef self = getSelf();
         future.addListener(new Runnable() {
             @Override
             public void run() {
                 try {
                     future.get();
-                    sender.tell(new CommitTransactionReply(), self);
+
+                    if (sender != null) {
+                        sender
+                            .tell(new CommitTransactionReply().toSerializable(),
+                                self);
+                    } else {
+                        LOG.error("sender is null ???");
+                    }
                 } catch (InterruptedException | ExecutionException e) {
-                    log.error(e, "An exception happened when committing");
+                    // FIXME : Handle this properly
+                    LOG.error(e, "An exception happened when committing");
                 }
             }
         }, getContext().dispatcher());
     }
 
     private void handleForwardedCommit(ForwardedCommitTransaction message) {
-        log.info("received forwarded transaction");
+        Object serializedModification =
+            message.getModification().toSerializable();
+
         modificationToCohort
-            .put(message.getModification(), message.getCohort());
-        getSelf().forward(Persistent.create(message.getModification()),
-            getContext());
+            .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) {
 
-        ActorSelection listenerRegistrationActor = getContext()
-            .system().actorSelection(registerChangeListener.getDataChangeListenerPath());
+        LOG.debug("registerDataChangeListener for " + registerChangeListener
+            .getPath());
+
+
+        ActorSelection dataChangeListenerPath = getContext()
+            .system().actorSelection(
+                registerChangeListener.getDataChangeListenerPath());
 
-        AsyncDataChangeListener<InstanceIdentifier, NormalizedNode<?, ?>>
-            listener = new ListenerProxy(listenerRegistrationActor);
 
-        org.opendaylight.yangtools.concepts.ListenerRegistration<AsyncDataChangeListener<InstanceIdentifier, NormalizedNode<?, ?>>>
+        // 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);
+
+        org.opendaylight.yangtools.concepts.ListenerRegistration<AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>>>
             registration =
             store.registerChangeListener(registerChangeListener.getPath(),
                 listener, registerChangeListener.getScope());
         ActorRef listenerRegistration =
-            getContext().actorOf(ListenerRegistration.props(registration));
+            getContext().actorOf(
+                DataChangeListenerRegistration.props(registration));
+
+        LOG.debug(
+            "registerDataChangeListener sending reply, listenerRegistrationPath = "
+                + listenerRegistration.path().toString());
+
         getSender()
             .tell(new RegisterChangeListenerReply(listenerRegistration.path()),
                 getSelf());
@@ -150,9 +318,78 @@ public class Shard extends UntypedProcessor {
     private void createTransactionChain() {
         DOMStoreTransactionChain chain = store.createTransactionChain();
         ActorRef transactionChain =
-            getContext().actorOf(ShardTransactionChain.props(chain));
+            getContext().actorOf(
+                ShardTransactionChain.props(chain, schemaContext));
         getSender()
-            .tell(new CreateTransactionChainReply(transactionChain.path()),
-                getSelf());
+            .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");
+            }
+
+
+        } 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;
+        }
     }
 }