2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.controller.cluster.datastore;
11 import akka.actor.ActorRef;
12 import akka.actor.ActorSystem;
13 import com.google.common.annotations.VisibleForTesting;
14 import com.google.common.base.Preconditions;
15 import com.google.common.util.concurrent.Uninterruptibles;
16 import java.util.concurrent.CountDownLatch;
17 import java.util.concurrent.TimeUnit;
18 import org.opendaylight.controller.cluster.datastore.config.Configuration;
19 import org.opendaylight.controller.cluster.datastore.identifiers.ShardManagerIdentifier;
20 import org.opendaylight.controller.cluster.datastore.jmx.mbeans.DatastoreConfigurationMXBeanImpl;
21 import org.opendaylight.controller.cluster.datastore.jmx.mbeans.DatastoreInfoMXBeanImpl;
22 import org.opendaylight.controller.cluster.datastore.messages.DatastoreSnapshot;
23 import org.opendaylight.controller.cluster.datastore.utils.ActorContext;
24 import org.opendaylight.controller.cluster.datastore.utils.Dispatchers;
25 import org.opendaylight.controller.cluster.datastore.utils.PrimaryShardInfoFutureCache;
26 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker;
27 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeListener;
28 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeListener;
29 import org.opendaylight.controller.sal.core.spi.data.DOMStore;
30 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadTransaction;
31 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadWriteTransaction;
32 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionChain;
33 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTreeChangePublisher;
34 import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction;
35 import org.opendaylight.yangtools.concepts.ListenerRegistration;
36 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
37 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
38 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
39 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
40 import org.slf4j.Logger;
41 import org.slf4j.LoggerFactory;
46 public class DistributedDataStore implements DOMStore, SchemaContextListener,
47 DatastoreContextConfigAdminOverlay.Listener, DOMStoreTreeChangePublisher, AutoCloseable {
49 private static final Logger LOG = LoggerFactory.getLogger(DistributedDataStore.class);
50 private static final String UNKNOWN_TYPE = "unknown";
52 private static final long READY_WAIT_FACTOR = 3;
54 private final ActorContext actorContext;
55 private final long waitTillReadyTimeInMillis;
57 private AutoCloseable closeable;
59 private DatastoreConfigurationMXBeanImpl datastoreConfigMXBean;
61 private DatastoreInfoMXBeanImpl datastoreInfoMXBean;
63 private final CountDownLatch waitTillReadyCountDownLatch = new CountDownLatch(1);
65 private final String type;
67 private final TransactionContextFactory txContextFactory;
69 public DistributedDataStore(ActorSystem actorSystem, ClusterWrapper cluster,
70 Configuration configuration, DatastoreContextFactory datastoreContextFactory,
71 DatastoreSnapshot restoreFromSnapshot) {
72 Preconditions.checkNotNull(actorSystem, "actorSystem should not be null");
73 Preconditions.checkNotNull(cluster, "cluster should not be null");
74 Preconditions.checkNotNull(configuration, "configuration should not be null");
75 Preconditions.checkNotNull(datastoreContextFactory, "datastoreContextFactory should not be null");
77 this.type = datastoreContextFactory.getBaseDatastoreContext().getDataStoreName();
79 String shardManagerId = ShardManagerIdentifier.builder().type(type).build().toString();
81 LOG.info("Creating ShardManager : {}", shardManagerId);
83 String shardDispatcher =
84 new Dispatchers(actorSystem.dispatchers()).getDispatcherPath(Dispatchers.DispatcherType.Shard);
86 PrimaryShardInfoFutureCache primaryShardInfoCache = new PrimaryShardInfoFutureCache();
88 ShardManager.Builder builder = ShardManager.builder().cluster(cluster).configuration(configuration).
89 datastoreContextFactory(datastoreContextFactory).waitTillReadyCountdownLatch(waitTillReadyCountDownLatch).
90 primaryShardInfoCache(primaryShardInfoCache).restoreFromSnapshot(restoreFromSnapshot);
92 actorContext = new ActorContext(actorSystem, createShardManager(actorSystem, builder, shardDispatcher,
93 shardManagerId), cluster, configuration, datastoreContextFactory.getBaseDatastoreContext(), primaryShardInfoCache);
95 this.waitTillReadyTimeInMillis =
96 actorContext.getDatastoreContext().getShardLeaderElectionTimeout().duration().toMillis() * READY_WAIT_FACTOR;
98 this.txContextFactory = TransactionContextFactory.create(actorContext);
100 datastoreConfigMXBean = new DatastoreConfigurationMXBeanImpl(
101 datastoreContextFactory.getBaseDatastoreContext().getDataStoreMXBeanType());
102 datastoreConfigMXBean.setContext(datastoreContextFactory.getBaseDatastoreContext());
103 datastoreConfigMXBean.registerMBean();
105 datastoreInfoMXBean = new DatastoreInfoMXBeanImpl(datastoreContextFactory.getBaseDatastoreContext().
106 getDataStoreMXBeanType(), actorContext);
107 datastoreInfoMXBean.registerMBean();
111 DistributedDataStore(ActorContext actorContext) {
112 this.actorContext = Preconditions.checkNotNull(actorContext, "actorContext should not be null");
113 this.txContextFactory = TransactionContextFactory.create(actorContext);
114 this.type = UNKNOWN_TYPE;
115 this.waitTillReadyTimeInMillis =
116 actorContext.getDatastoreContext().getShardLeaderElectionTimeout().duration().toMillis() * READY_WAIT_FACTOR;
119 public void setCloseable(AutoCloseable closeable) {
120 this.closeable = closeable;
123 @SuppressWarnings("unchecked")
125 public <L extends AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>>>
126 ListenerRegistration<L> registerChangeListener(
127 final YangInstanceIdentifier path, L listener,
128 AsyncDataBroker.DataChangeScope scope) {
130 Preconditions.checkNotNull(path, "path should not be null");
131 Preconditions.checkNotNull(listener, "listener should not be null");
133 LOG.debug("Registering listener: {} for path: {} scope: {}", listener, path, scope);
135 String shardName = actorContext.getShardStrategyFactory().getStrategy(path).findShard(path);
137 final DataChangeListenerRegistrationProxy listenerRegistrationProxy =
138 new DataChangeListenerRegistrationProxy(shardName, actorContext, listener);
139 listenerRegistrationProxy.init(path, scope);
141 return listenerRegistrationProxy;
145 public <L extends DOMDataTreeChangeListener> ListenerRegistration<L> registerTreeChangeListener(YangInstanceIdentifier treeId, L listener) {
146 Preconditions.checkNotNull(treeId, "treeId should not be null");
147 Preconditions.checkNotNull(listener, "listener should not be null");
149 final String shardName = actorContext.getShardStrategyFactory().getStrategy(treeId).findShard(treeId);
150 LOG.debug("Registering tree listener: {} for tree: {} shard: {}", listener, treeId, shardName);
152 final DataTreeChangeListenerProxy<L> listenerRegistrationProxy =
153 new DataTreeChangeListenerProxy<L>(actorContext, listener);
154 listenerRegistrationProxy.init(shardName, treeId);
156 return listenerRegistrationProxy;
160 public DOMStoreTransactionChain createTransactionChain() {
161 return txContextFactory.createTransactionChain();
165 public DOMStoreReadTransaction newReadOnlyTransaction() {
166 return new TransactionProxy(txContextFactory, TransactionType.READ_ONLY);
170 public DOMStoreWriteTransaction newWriteOnlyTransaction() {
171 actorContext.acquireTxCreationPermit();
172 return new TransactionProxy(txContextFactory, TransactionType.WRITE_ONLY);
176 public DOMStoreReadWriteTransaction newReadWriteTransaction() {
177 actorContext.acquireTxCreationPermit();
178 return new TransactionProxy(txContextFactory, TransactionType.READ_WRITE);
182 public void onGlobalContextUpdated(SchemaContext schemaContext) {
183 actorContext.setSchemaContext(schemaContext);
187 public void onDatastoreContextUpdated(DatastoreContextFactory contextFactory) {
188 LOG.info("DatastoreContext updated for data store {}", actorContext.getDataStoreType());
190 actorContext.setDatastoreContext(contextFactory);
191 datastoreConfigMXBean.setContext(contextFactory.getBaseDatastoreContext());
195 public void close() {
196 if (datastoreConfigMXBean != null) {
197 datastoreConfigMXBean.unregisterMBean();
199 if (datastoreInfoMXBean != null) {
200 datastoreInfoMXBean.unregisterMBean();
203 if (closeable != null) {
206 } catch (Exception e) {
207 LOG.debug("Error closing instance", e);
211 txContextFactory.close();
212 actorContext.shutdown();
215 public ActorContext getActorContext() {
219 public void waitTillReady(){
220 LOG.info("Beginning to wait for data store to become ready : {}", type);
223 if (waitTillReadyCountDownLatch.await(waitTillReadyTimeInMillis, TimeUnit.MILLISECONDS)) {
224 LOG.debug("Data store {} is now ready", type);
226 LOG.error("Shared leaders failed to settle in {} seconds, giving up", TimeUnit.MILLISECONDS.toSeconds(waitTillReadyTimeInMillis));
228 } catch (InterruptedException e) {
229 LOG.error("Interrupted while waiting for shards to settle", e);
233 private ActorRef createShardManager(ActorSystem actorSystem, ShardManager.Builder builder, String shardDispatcher,
234 String shardManagerId){
235 Exception lastException = null;
237 for(int i=0;i<100;i++) {
239 return actorSystem.actorOf(builder.props().withDispatcher(shardDispatcher).withMailbox(
240 ActorContext.MAILBOX), shardManagerId);
241 } catch (Exception e){
243 Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS);
244 LOG.debug(String.format("Could not create actor %s because of %s - waiting for sometime before retrying (retry count = %d)", shardManagerId, e.getMessage(), i));
248 throw new IllegalStateException("Failed to create Shard Manager", lastException);
252 public CountDownLatch getWaitTillReadyCountDownLatch() {
253 return waitTillReadyCountDownLatch;