X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-distributed-datastore%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fdatastore%2FAbstractDataStore.java;h=bc4a8e739577d6264038594d67980673fc937fe2;hb=178ebab612c3ddd338e759ca7e929c25c623b0b3;hp=7f759d1b4296adb275f6cf7ee3296dde8c252623;hpb=402dbc040ddb5dfc488320356b5a36c66d59c36e;p=controller.git diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/AbstractDataStore.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/AbstractDataStore.java index 7f759d1b42..bc4a8e7395 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/AbstractDataStore.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/AbstractDataStore.java @@ -5,19 +5,21 @@ * terms of the Eclipse Public License v1.0 which accompanies this distribution, * and is available at http://www.eclipse.org/legal/epl-v10.html */ - package org.opendaylight.controller.cluster.datastore; +import static java.util.Objects.requireNonNull; + import akka.actor.ActorRef; import akka.actor.ActorSystem; import akka.actor.PoisonPill; import akka.actor.Props; +import com.google.common.annotations.Beta; import com.google.common.annotations.VisibleForTesting; -import com.google.common.base.Preconditions; import com.google.common.base.Throwables; import com.google.common.util.concurrent.Uninterruptibles; import java.util.concurrent.CountDownLatch; import java.util.concurrent.TimeUnit; +import java.util.concurrent.TimeoutException; import org.opendaylight.controller.cluster.access.concepts.ClientIdentifier; import org.opendaylight.controller.cluster.common.actor.Dispatchers; import org.opendaylight.controller.cluster.databroker.actors.dds.DataStoreClient; @@ -27,8 +29,9 @@ import org.opendaylight.controller.cluster.datastore.identifiers.ShardManagerIde import org.opendaylight.controller.cluster.datastore.jmx.mbeans.DatastoreConfigurationMXBeanImpl; import org.opendaylight.controller.cluster.datastore.jmx.mbeans.DatastoreInfoMXBeanImpl; import org.opendaylight.controller.cluster.datastore.persisted.DatastoreSnapshot; +import org.opendaylight.controller.cluster.datastore.shardmanager.AbstractShardManagerCreator; import org.opendaylight.controller.cluster.datastore.shardmanager.ShardManagerCreator; -import org.opendaylight.controller.cluster.datastore.utils.ActorContext; +import org.opendaylight.controller.cluster.datastore.utils.ActorUtils; import org.opendaylight.controller.cluster.datastore.utils.ClusterUtils; import org.opendaylight.controller.cluster.datastore.utils.PrimaryShardInfoFutureCache; import org.opendaylight.mdsal.dom.api.ClusteredDOMDataTreeChangeListener; @@ -44,6 +47,7 @@ import org.opendaylight.yangtools.yang.model.api.SchemaContext; import org.opendaylight.yangtools.yang.model.api.SchemaContextListener; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +import scala.concurrent.duration.Duration; /** * Base implementation of a distributed DOMStore. @@ -54,30 +58,23 @@ public abstract class AbstractDataStore implements DistributedDataStoreInterface private static final Logger LOG = LoggerFactory.getLogger(AbstractDataStore.class); - private static final long READY_WAIT_FACTOR = 3; - - private final ActorContext actorContext; - private final long waitTillReadyTimeInMillis; + private final CountDownLatch waitTillReadyCountDownLatch = new CountDownLatch(1); + private final ClientIdentifier identifier; + private final DataStoreClient client; + private final ActorUtils actorUtils; private AutoCloseable closeable; - private DatastoreConfigurationMXBeanImpl datastoreConfigMXBean; - private DatastoreInfoMXBeanImpl datastoreInfoMXBean; - private final CountDownLatch waitTillReadyCountDownLatch = new CountDownLatch(1); - - private final ClientIdentifier identifier; - private final DataStoreClient client; - @SuppressWarnings("checkstyle:IllegalCatch") protected AbstractDataStore(final ActorSystem actorSystem, final ClusterWrapper cluster, final Configuration configuration, final DatastoreContextFactory datastoreContextFactory, final DatastoreSnapshot restoreFromSnapshot) { - Preconditions.checkNotNull(actorSystem, "actorSystem should not be null"); - Preconditions.checkNotNull(cluster, "cluster should not be null"); - Preconditions.checkNotNull(configuration, "configuration should not be null"); - Preconditions.checkNotNull(datastoreContextFactory, "datastoreContextFactory should not be null"); + requireNonNull(actorSystem, "actorSystem should not be null"); + requireNonNull(cluster, "cluster should not be null"); + requireNonNull(configuration, "configuration should not be null"); + requireNonNull(datastoreContextFactory, "datastoreContextFactory should not be null"); String shardManagerId = ShardManagerIdentifier.builder() .type(datastoreContextFactory.getBaseDatastoreContext().getDataStoreName()).build().toString(); @@ -89,19 +86,19 @@ public abstract class AbstractDataStore implements DistributedDataStoreInterface PrimaryShardInfoFutureCache primaryShardInfoCache = new PrimaryShardInfoFutureCache(); - ShardManagerCreator creator = new ShardManagerCreator().cluster(cluster).configuration(configuration) + AbstractShardManagerCreator creator = getShardManagerCreator().cluster(cluster).configuration(configuration) .datastoreContextFactory(datastoreContextFactory) .waitTillReadyCountDownLatch(waitTillReadyCountDownLatch) .primaryShardInfoCache(primaryShardInfoCache) .restoreFromSnapshot(restoreFromSnapshot) .distributedDataStore(this); - actorContext = new ActorContext(actorSystem, createShardManager(actorSystem, creator, shardDispatcher, + actorUtils = new ActorUtils(actorSystem, createShardManager(actorSystem, creator, shardDispatcher, shardManagerId), cluster, configuration, datastoreContextFactory.getBaseDatastoreContext(), primaryShardInfoCache); final Props clientProps = DistributedDataStoreClientActor.props(cluster.getCurrentMemberName(), - datastoreContextFactory.getBaseDatastoreContext().getDataStoreName(), actorContext); + datastoreContextFactory.getBaseDatastoreContext().getDataStoreName(), actorUtils); final ActorRef clientActor = actorSystem.actorOf(clientProps); try { client = DistributedDataStoreClientActor.getDistributedDataStoreClient(clientActor, 30, TimeUnit.SECONDS); @@ -115,36 +112,33 @@ public abstract class AbstractDataStore implements DistributedDataStoreInterface identifier = client.getIdentifier(); LOG.debug("Distributed data store client {} started", identifier); - this.waitTillReadyTimeInMillis = actorContext.getDatastoreContext().getShardLeaderElectionTimeout() - .duration().toMillis() * READY_WAIT_FACTOR; - datastoreConfigMXBean = new DatastoreConfigurationMXBeanImpl( datastoreContextFactory.getBaseDatastoreContext().getDataStoreMXBeanType()); datastoreConfigMXBean.setContext(datastoreContextFactory.getBaseDatastoreContext()); datastoreConfigMXBean.registerMBean(); datastoreInfoMXBean = new DatastoreInfoMXBeanImpl(datastoreContextFactory.getBaseDatastoreContext() - .getDataStoreMXBeanType(), actorContext); + .getDataStoreMXBeanType(), actorUtils); datastoreInfoMXBean.registerMBean(); } @VisibleForTesting - protected AbstractDataStore(final ActorContext actorContext, final ClientIdentifier identifier) { - this.actorContext = Preconditions.checkNotNull(actorContext, "actorContext should not be null"); + protected AbstractDataStore(final ActorUtils actorUtils, final ClientIdentifier identifier) { + this.actorUtils = requireNonNull(actorUtils, "actorContext should not be null"); this.client = null; - this.identifier = Preconditions.checkNotNull(identifier); - this.waitTillReadyTimeInMillis = actorContext.getDatastoreContext().getShardLeaderElectionTimeout() - .duration().toMillis() * READY_WAIT_FACTOR; + this.identifier = requireNonNull(identifier); } @VisibleForTesting - protected AbstractDataStore(final ActorContext actorContext, final ClientIdentifier identifier, + protected AbstractDataStore(final ActorUtils actorUtils, final ClientIdentifier identifier, final DataStoreClient clientActor) { - this.actorContext = Preconditions.checkNotNull(actorContext, "actorContext should not be null"); + this.actorUtils = requireNonNull(actorUtils, "actorContext should not be null"); this.client = clientActor; - this.identifier = Preconditions.checkNotNull(identifier); - this.waitTillReadyTimeInMillis = actorContext.getDatastoreContext().getShardLeaderElectionTimeout() - .duration().toMillis() * READY_WAIT_FACTOR; + this.identifier = requireNonNull(identifier); + } + + protected AbstractShardManagerCreator getShardManagerCreator() { + return new ShardManagerCreator(); } protected final DataStoreClient getClient() { @@ -162,14 +156,14 @@ public abstract class AbstractDataStore implements DistributedDataStoreInterface @Override public ListenerRegistration registerTreeChangeListener( final YangInstanceIdentifier treeId, final L listener) { - Preconditions.checkNotNull(treeId, "treeId should not be null"); - Preconditions.checkNotNull(listener, "listener should not be null"); + requireNonNull(treeId, "treeId should not be null"); + requireNonNull(listener, "listener should not be null"); - final String shardName = actorContext.getShardStrategyFactory().getStrategy(treeId).findShard(treeId); + final String shardName = actorUtils.getShardStrategyFactory().getStrategy(treeId).findShard(treeId); LOG.debug("Registering tree listener: {} for tree: {} shard: {}", listener, treeId, shardName); final DataTreeChangeListenerProxy listenerRegistrationProxy = - new DataTreeChangeListenerProxy<>(actorContext, listener, treeId); + new DataTreeChangeListenerProxy<>(actorUtils, listener, treeId); listenerRegistrationProxy.init(shardName); return listenerRegistrationProxy; @@ -179,30 +173,29 @@ public abstract class AbstractDataStore implements DistributedDataStoreInterface @Override public DOMDataTreeCommitCohortRegistration registerCommitCohort( final DOMDataTreeIdentifier subtree, final C cohort) { - YangInstanceIdentifier treeId = - Preconditions.checkNotNull(subtree, "subtree should not be null").getRootIdentifier(); - Preconditions.checkNotNull(cohort, "listener should not be null"); + YangInstanceIdentifier treeId = requireNonNull(subtree, "subtree should not be null").getRootIdentifier(); + requireNonNull(cohort, "listener should not be null"); - final String shardName = actorContext.getShardStrategyFactory().getStrategy(treeId).findShard(treeId); + final String shardName = actorUtils.getShardStrategyFactory().getStrategy(treeId).findShard(treeId); LOG.debug("Registering cohort: {} for tree: {} shard: {}", cohort, treeId, shardName); DataTreeCohortRegistrationProxy cohortProxy = - new DataTreeCohortRegistrationProxy<>(actorContext, subtree, cohort); + new DataTreeCohortRegistrationProxy<>(actorUtils, subtree, cohort); cohortProxy.init(shardName); return cohortProxy; } @Override public void onGlobalContextUpdated(final SchemaContext schemaContext) { - actorContext.setSchemaContext(schemaContext); + actorUtils.setSchemaContext(schemaContext); } @Override public void onDatastoreContextUpdated(final DatastoreContextFactory contextFactory) { - LOG.info("DatastoreContext updated for data store {}", actorContext.getDataStoreName()); + LOG.info("DatastoreContext updated for data store {}", actorUtils.getDataStoreName()); - actorContext.setDatastoreContext(contextFactory); + actorUtils.setDatastoreContext(contextFactory); datastoreConfigMXBean.setContext(contextFactory.getBaseDatastoreContext()); } @@ -226,7 +219,7 @@ public abstract class AbstractDataStore implements DistributedDataStoreInterface } } - actorContext.shutdown(); + actorUtils.shutdown(); if (client != null) { client.close(); @@ -234,28 +227,43 @@ public abstract class AbstractDataStore implements DistributedDataStoreInterface } @Override - public ActorContext getActorContext() { - return actorContext; + public ActorUtils getActorUtils() { + return actorUtils; } + // TODO: consider removing this in favor of awaitReadiness() public void waitTillReady() { LOG.info("Beginning to wait for data store to become ready : {}", identifier); + final Duration toWait = initialSettleTime(); try { - if (waitTillReadyCountDownLatch.await(waitTillReadyTimeInMillis, TimeUnit.MILLISECONDS)) { - LOG.debug("Data store {} is now ready", identifier); + if (toWait.isFinite()) { + if (!waitTillReadyCountDownLatch.await(toWait.toNanos(), TimeUnit.NANOSECONDS)) { + LOG.error("Shard leaders failed to settle in {}, giving up", toWait); + return; + } } else { - LOG.error("Shard leaders failed to settle in {} seconds, giving up", - TimeUnit.MILLISECONDS.toSeconds(waitTillReadyTimeInMillis)); + waitTillReadyCountDownLatch.await(); } } catch (InterruptedException e) { LOG.error("Interrupted while waiting for shards to settle", e); + return; + } + + LOG.debug("Data store {} is now ready", identifier); + } + + @Beta + public void awaitReadiness(final long timeout, final TimeUnit unit) throws InterruptedException, TimeoutException { + if (!waitTillReadyCountDownLatch.await(timeout, unit)) { + throw new TimeoutException("Shard leaders failed to settle"); } } @SuppressWarnings("checkstyle:IllegalCatch") - private static ActorRef createShardManager(final ActorSystem actorSystem, final ShardManagerCreator creator, - final String shardDispatcher, final String shardManagerId) { + private static ActorRef createShardManager(final ActorSystem actorSystem, + final AbstractShardManagerCreator creator, final String shardDispatcher, + final String shardManagerId) { Exception lastException = null; for (int i = 0; i < 100; i++) { @@ -283,16 +291,16 @@ public abstract class AbstractDataStore implements DistributedDataStoreInterface final YangInstanceIdentifier insideShard, final org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener delegate) { - Preconditions.checkNotNull(shardLookup, "shardLookup should not be null"); - Preconditions.checkNotNull(insideShard, "insideShard should not be null"); - Preconditions.checkNotNull(delegate, "delegate should not be null"); + requireNonNull(shardLookup, "shardLookup should not be null"); + requireNonNull(insideShard, "insideShard should not be null"); + requireNonNull(delegate, "delegate should not be null"); - final String shardName = actorContext.getShardStrategyFactory().getStrategy(shardLookup).findShard(shardLookup); + final String shardName = actorUtils.getShardStrategyFactory().getStrategy(shardLookup).findShard(shardLookup); LOG.debug("Registering tree listener: {} for tree: {} shard: {}, path inside shard: {}", delegate,shardLookup, shardName, insideShard); final DataTreeChangeListenerProxy listenerRegistrationProxy = - new DataTreeChangeListenerProxy<>(actorContext, + new DataTreeChangeListenerProxy<>(actorUtils, // wrap this in the ClusteredDOMDataTreeChangeLister interface // since we always want clustered registration (ClusteredDOMDataTreeChangeListener) delegate::onDataTreeChanged, insideShard); @@ -305,15 +313,20 @@ public abstract class AbstractDataStore implements DistributedDataStoreInterface public ListenerRegistration registerShardConfigListener( final YangInstanceIdentifier internalPath, final DOMDataTreeChangeListener delegate) { - Preconditions.checkNotNull(delegate, "delegate should not be null"); + requireNonNull(delegate, "delegate should not be null"); LOG.debug("Registering a listener for the configuration shard: {}", internalPath); final DataTreeChangeListenerProxy proxy = - new DataTreeChangeListenerProxy<>(actorContext, delegate, internalPath); + new DataTreeChangeListenerProxy<>(actorUtils, delegate, internalPath); proxy.init(ClusterUtils.PREFIX_CONFIG_SHARD_ID); return (ListenerRegistration) proxy; } + private Duration initialSettleTime() { + final DatastoreContext context = actorUtils.getDatastoreContext(); + final int multiplier = context.getInitialSettleTimeoutMultiplier(); + return multiplier == 0 ? Duration.Inf() : context.getShardLeaderElectionTimeout().duration().$times(multiplier); + } }