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%2FAbstractDataStore.java;h=95cd0adc8aa48b71de1b9befe6248637cb9e3e2b;hp=03b403a13c9f446d0b915d76e1eb46957a85ccfb;hb=bb10634078d038fcccb4d5542a79f062e3835ad3;hpb=ba10068e9748608488972c0f22b46277fda66acc 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 03b403a13c..95cd0adc8a 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,20 +5,27 @@ * 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 com.google.common.base.Preconditions.checkArgument; +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.ListenableFuture; +import com.google.common.util.concurrent.SettableFuture; import com.google.common.util.concurrent.Uninterruptibles; -import java.util.concurrent.CountDownLatch; +import java.util.Set; +import java.util.concurrent.ExecutionException; 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; import org.opendaylight.controller.cluster.databroker.actors.dds.DistributedDataStoreClientActor; import org.opendaylight.controller.cluster.datastore.config.Configuration; @@ -26,61 +33,52 @@ 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.Dispatchers; import org.opendaylight.controller.cluster.datastore.utils.PrimaryShardInfoFutureCache; -import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker; -import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeListener; -import org.opendaylight.controller.md.sal.dom.api.ClusteredDOMDataTreeChangeListener; -import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeListener; -import org.opendaylight.controller.sal.core.spi.data.DOMStoreTreeChangePublisher; +import org.opendaylight.mdsal.dom.api.ClusteredDOMDataTreeChangeListener; +import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener; import org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohort; import org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohortRegistration; import org.opendaylight.mdsal.dom.api.DOMDataTreeCommitCohortRegistry; import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier; +import org.opendaylight.mdsal.dom.spi.store.DOMStoreTreeChangePublisher; 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 org.opendaylight.yangtools.yang.model.api.SchemaContextListener; +import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext; +import org.opendaylight.yangtools.yang.model.api.EffectiveModelContextListener; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +import scala.concurrent.duration.Duration; /** * Base implementation of a distributed DOMStore. */ -public abstract class AbstractDataStore implements DistributedDataStoreInterface, SchemaContextListener, - DatastoreContextConfigAdminOverlay.Listener, DOMStoreTreeChangePublisher, +public abstract class AbstractDataStore implements DistributedDataStoreInterface, EffectiveModelContextListener, + DatastoreContextPropertiesUpdater.Listener, DOMStoreTreeChangePublisher, DOMDataTreeCommitCohortRegistry, AutoCloseable { 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 SettableFuture readinessFuture = SettableFuture.create(); + 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(); @@ -92,61 +90,59 @@ 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) + .readinessFuture(readinessFuture) .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); } catch (Exception e) { LOG.error("Failed to get actor for {}", clientProps, e); clientActor.tell(PoisonPill.getInstance(), ActorRef.noSender()); - throw Throwables.propagate(e); + Throwables.throwIfUnchecked(e); + throw new RuntimeException(e); } 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() { @@ -161,71 +157,63 @@ public abstract class AbstractDataStore implements DistributedDataStoreInterface this.closeable = closeable; } - @SuppressWarnings("unchecked") - @Override - public >> - ListenerRegistration registerChangeListener( - final YangInstanceIdentifier path, final L listener, - final AsyncDataBroker.DataChangeScope scope) { - - Preconditions.checkNotNull(path, "path should not be null"); - Preconditions.checkNotNull(listener, "listener should not be null"); - - LOG.debug("Registering listener: {} for path: {} scope: {}", listener, path, scope); - - String shardName = actorContext.getShardStrategyFactory().getStrategy(path).findShard(path); - - final DataChangeListenerRegistrationProxy listenerRegistrationProxy = - new DataChangeListenerRegistrationProxy(shardName, actorContext, listener); - listenerRegistrationProxy.init(path, scope); - - return listenerRegistrationProxy; - } - @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"); + + /* + * We need to potentially deal with multi-shard composition for registration targeting the root of the data + * store. If that is the case, we delegate to a more complicated setup invol + */ + if (treeId.isEmpty()) { + // User is targeting root of the datastore. If there is more than one shard, we have to register with them + // all and perform data composition. + final Set shardNames = actorUtils.getConfiguration().getAllShardNames(); + if (shardNames.size() > 1) { + checkArgument(listener instanceof ClusteredDOMDataTreeChangeListener, + "Cannot listen on root without non-clustered listener %s", listener); + return new RootDataTreeChangeListenerProxy<>(actorUtils, listener, shardNames); + } + } - 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; } - @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); + public void onModelContextUpdated(final EffectiveModelContext newModelContext) { + actorUtils.setSchemaContext(newModelContext); } @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()); } @@ -249,7 +237,7 @@ public abstract class AbstractDataStore implements DistributedDataStoreInterface } } - actorContext.shutdown(); + actorUtils.shutdown(); if (client != null) { client.close(); @@ -257,34 +245,73 @@ 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() + @Deprecated 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); - } else { - LOG.error("Shard leaders failed to settle in {} seconds, giving up", - TimeUnit.MILLISECONDS.toSeconds(waitTillReadyTimeInMillis)); + if (!awaitReadiness(toWait)) { + LOG.error("Shard leaders failed to settle in {}, giving up", toWait); + return; } } catch (InterruptedException e) { LOG.error("Interrupted while waiting for shards to settle", e); + return; + } + + LOG.debug("Data store {} is now ready", identifier); + } + + @Beta + @Deprecated + public boolean awaitReadiness() throws InterruptedException { + return awaitReadiness(initialSettleTime()); + } + + @Beta + @Deprecated + public boolean awaitReadiness(final Duration toWait) throws InterruptedException { + try { + if (toWait.isFinite()) { + try { + readinessFuture.get(toWait.toNanos(), TimeUnit.NANOSECONDS); + } catch (TimeoutException e) { + LOG.debug("Timed out waiting for shards to settle", e); + return false; + } + } else { + readinessFuture.get(); + } + } catch (ExecutionException e) { + LOG.warn("Unexpected readiness failure, assuming convergence", e); + } + + return true; + } + + @Beta + @Deprecated + public void awaitReadiness(final long timeout, final TimeUnit unit) throws InterruptedException, TimeoutException { + if (!awaitReadiness(Duration.create(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++) { try { - return actorSystem.actorOf(creator.props().withDispatcher(shardDispatcher).withMailbox( - ActorContext.BOUNDED_MAILBOX), shardManagerId); + return actorSystem.actorOf(creator.props().withDispatcher(shardDispatcher), shardManagerId); } catch (Exception e) { lastException = e; Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS); @@ -296,27 +323,36 @@ public abstract class AbstractDataStore implements DistributedDataStoreInterface throw new IllegalStateException("Failed to create Shard Manager", lastException); } + /** + * Future which completes when all shards settle for the first time. + * + * @return A Listenable future. + */ + public final ListenableFuture initialSettleFuture() { + return readinessFuture; + } + @VisibleForTesting - public CountDownLatch getWaitTillReadyCountDownLatch() { - return waitTillReadyCountDownLatch; + SettableFuture readinessFuture() { + return readinessFuture; } + @Override @SuppressWarnings("unchecked") public ListenerRegistration registerProxyListener( - final YangInstanceIdentifier shardLookup, - final YangInstanceIdentifier insideShard, - final org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener delegate) { + final YangInstanceIdentifier shardLookup, final YangInstanceIdentifier insideShard, + final 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); @@ -325,19 +361,24 @@ public abstract class AbstractDataStore implements DistributedDataStoreInterface return (ListenerRegistration) listenerRegistrationProxy; } + @Override @SuppressWarnings("unchecked") public ListenerRegistration registerShardConfigListener( - final YangInstanceIdentifier internalPath, - final DOMDataTreeChangeListener delegate) { - Preconditions.checkNotNull(delegate, "delegate should not be null"); + final YangInstanceIdentifier internalPath, final DOMDataTreeChangeListener delegate) { + 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); + } }