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
8 package org.opendaylight.controller.md.sal.dom.store.impl;
10 import com.google.common.base.Optional;
11 import com.google.common.base.Preconditions;
12 import com.google.common.util.concurrent.FutureCallback;
13 import com.google.common.util.concurrent.Futures;
14 import com.google.common.util.concurrent.ListenableFuture;
15 import com.google.common.util.concurrent.ListeningExecutorService;
17 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
18 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent;
19 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeListener;
20 import org.opendaylight.controller.md.sal.common.api.data.OptimisticLockFailedException;
21 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
22 import org.opendaylight.controller.md.sal.dom.store.impl.SnapshotBackedWriteTransaction.TransactionReadyPrototype;
23 import org.opendaylight.yangtools.util.ExecutorServiceUtil;
24 import org.opendaylight.yangtools.util.concurrent.NotificationManager;
25 import org.opendaylight.yangtools.util.concurrent.QueuedNotificationManager;
26 import org.opendaylight.yangtools.yang.data.api.schema.tree.ConflictingModificationAppliedException;
27 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
28 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
29 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
30 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeSnapshot;
31 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
32 import org.opendaylight.controller.md.sal.dom.store.impl.tree.ListenerTree;
33 import org.opendaylight.yangtools.yang.data.impl.schema.tree.InMemoryDataTreeFactory;
34 import org.opendaylight.controller.sal.core.spi.data.DOMStore;
35 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadTransaction;
36 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadWriteTransaction;
37 import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
38 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionChain;
39 import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction;
40 import org.opendaylight.yangtools.concepts.AbstractListenerRegistration;
41 import org.opendaylight.yangtools.concepts.Identifiable;
42 import org.opendaylight.yangtools.concepts.ListenerRegistration;
43 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
44 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
45 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
46 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
47 import org.slf4j.Logger;
48 import org.slf4j.LoggerFactory;
50 import javax.annotation.concurrent.GuardedBy;
52 import java.util.concurrent.Callable;
53 import java.util.concurrent.ExecutorService;
54 import java.util.concurrent.TimeUnit;
55 import java.util.concurrent.atomic.AtomicLong;
57 import static com.google.common.base.Preconditions.checkState;
60 * In-memory DOM Data Store
62 * Implementation of {@link DOMStore} which uses {@link DataTree} and other
63 * classes such as {@link SnapshotBackedWriteTransaction}.
64 * {@link SnapshotBackedReadTransaction} and {@link ResolveDataChangeEventsTask}
65 * to implement {@link DOMStore} contract.
68 public class InMemoryDOMDataStore implements DOMStore, Identifiable<String>, SchemaContextListener,
69 TransactionReadyPrototype,AutoCloseable {
70 private static final Logger LOG = LoggerFactory.getLogger(InMemoryDOMDataStore.class);
72 @SuppressWarnings("rawtypes")
73 private static final QueuedNotificationManager.Invoker<AsyncDataChangeListener,
74 AsyncDataChangeEvent> DCL_NOTIFICATION_MGR_INVOKER =
75 new QueuedNotificationManager.Invoker<AsyncDataChangeListener,
76 AsyncDataChangeEvent>() {
78 @SuppressWarnings("unchecked")
80 public void invokeListener( AsyncDataChangeListener listener,
81 AsyncDataChangeEvent notification ) {
82 listener.onDataChanged(notification);
86 private final DataTree dataTree = InMemoryDataTreeFactory.getInstance().create();
87 private final ListenerTree listenerTree = ListenerTree.create();
88 private final AtomicLong txCounter = new AtomicLong(0);
89 private final ListeningExecutorService listeningExecutor;
91 @SuppressWarnings("rawtypes")
92 private final NotificationManager<AsyncDataChangeListener,AsyncDataChangeEvent>
93 dataChangeListenerNotificationManager;
94 private final ExecutorService dataChangeListenerExecutor;
96 private final String name;
98 public InMemoryDOMDataStore(final String name, final ListeningExecutorService listeningExecutor,
99 final ExecutorService dataChangeListenerExecutor) {
100 this(name, listeningExecutor, dataChangeListenerExecutor,
101 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_LISTENER_QUEUE_SIZE);
104 public InMemoryDOMDataStore(final String name, final ListeningExecutorService listeningExecutor,
105 final ExecutorService dataChangeListenerExecutor, int maxDataChangeListenerQueueSize) {
106 this.name = Preconditions.checkNotNull(name);
107 this.listeningExecutor = Preconditions.checkNotNull(listeningExecutor);
109 this.dataChangeListenerExecutor = Preconditions.checkNotNull(dataChangeListenerExecutor);
111 dataChangeListenerNotificationManager =
112 new QueuedNotificationManager<>(this.dataChangeListenerExecutor,
113 DCL_NOTIFICATION_MGR_INVOKER, maxDataChangeListenerQueueSize,
114 "DataChangeListenerQueueMgr");
118 public final String getIdentifier() {
123 public DOMStoreReadTransaction newReadOnlyTransaction() {
124 return new SnapshotBackedReadTransaction(nextIdentifier(), dataTree.takeSnapshot());
128 public DOMStoreReadWriteTransaction newReadWriteTransaction() {
129 return new SnapshotBackedReadWriteTransaction(nextIdentifier(), dataTree.takeSnapshot(), this);
133 public DOMStoreWriteTransaction newWriteOnlyTransaction() {
134 return new SnapshotBackedWriteTransaction(nextIdentifier(), dataTree.takeSnapshot(), this);
138 public DOMStoreTransactionChain createTransactionChain() {
139 return new DOMStoreTransactionChainImpl();
143 public synchronized void onGlobalContextUpdated(final SchemaContext ctx) {
144 dataTree.setSchemaContext(ctx);
148 public void close() {
149 ExecutorServiceUtil.tryGracefulShutdown(listeningExecutor, 30, TimeUnit.SECONDS);
150 ExecutorServiceUtil.tryGracefulShutdown(dataChangeListenerExecutor, 30, TimeUnit.SECONDS);
153 public <L extends AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>>> ListenerRegistration<L> registerChangeListener(
154 final YangInstanceIdentifier path, final L listener, final DataChangeScope scope) {
157 * Make sure commit is not occurring right now. Listener has to be
158 * registered and its state capture enqueued at a consistent point.
160 * FIXME: improve this to read-write lock, such that multiple listener
161 * registrations can occur simultaneously
163 final DataChangeListenerRegistration<L> reg;
164 synchronized (this) {
165 LOG.debug("{}: Registering data change listener {} for {}", name, listener, path);
167 reg = listenerTree.registerDataChangeListener(path, listener, scope);
169 Optional<NormalizedNode<?, ?>> currentState = dataTree.takeSnapshot().readNode(path);
170 if (currentState.isPresent()) {
171 final NormalizedNode<?, ?> data = currentState.get();
173 final DOMImmutableDataChangeEvent event = DOMImmutableDataChangeEvent.builder(DataChangeScope.BASE) //
175 .addCreated(path, data) //
178 new ChangeListenerNotifyTask(reg, event,
179 dataChangeListenerNotificationManager).run();
183 return new AbstractListenerRegistration<L>(listener) {
185 protected void removeRegistration() {
186 synchronized (InMemoryDOMDataStore.this) {
194 public DOMStoreThreePhaseCommitCohort ready(final SnapshotBackedWriteTransaction writeTx) {
195 LOG.debug("Tx: {} is submitted. Modifications: {}", writeTx.getIdentifier(), writeTx.getMutatedView());
196 return new ThreePhaseCommitImpl(writeTx);
199 private Object nextIdentifier() {
200 return name + "-" + txCounter.getAndIncrement();
203 private class DOMStoreTransactionChainImpl implements DOMStoreTransactionChain, TransactionReadyPrototype {
206 private SnapshotBackedWriteTransaction latestOutstandingTx;
208 private boolean chainFailed = false;
210 private void checkFailed() {
211 Preconditions.checkState(!chainFailed, "Transaction chain is failed.");
215 public synchronized DOMStoreReadTransaction newReadOnlyTransaction() {
216 final DataTreeSnapshot snapshot;
218 if (latestOutstandingTx != null) {
219 checkState(latestOutstandingTx.isReady(), "Previous transaction in chain must be ready.");
220 snapshot = latestOutstandingTx.getMutatedView();
222 snapshot = dataTree.takeSnapshot();
224 return new SnapshotBackedReadTransaction(nextIdentifier(), snapshot);
228 public synchronized DOMStoreReadWriteTransaction newReadWriteTransaction() {
229 final DataTreeSnapshot snapshot;
231 if (latestOutstandingTx != null) {
232 checkState(latestOutstandingTx.isReady(), "Previous transaction in chain must be ready.");
233 snapshot = latestOutstandingTx.getMutatedView();
235 snapshot = dataTree.takeSnapshot();
237 final SnapshotBackedReadWriteTransaction ret = new SnapshotBackedReadWriteTransaction(nextIdentifier(),
239 latestOutstandingTx = ret;
244 public synchronized DOMStoreWriteTransaction newWriteOnlyTransaction() {
245 final DataTreeSnapshot snapshot;
247 if (latestOutstandingTx != null) {
248 checkState(latestOutstandingTx.isReady(), "Previous transaction in chain must be ready.");
249 snapshot = latestOutstandingTx.getMutatedView();
251 snapshot = dataTree.takeSnapshot();
253 final SnapshotBackedWriteTransaction ret = new SnapshotBackedWriteTransaction(nextIdentifier(), snapshot,
255 latestOutstandingTx = ret;
260 public DOMStoreThreePhaseCommitCohort ready(final SnapshotBackedWriteTransaction tx) {
261 DOMStoreThreePhaseCommitCohort storeCohort = InMemoryDOMDataStore.this.ready(tx);
262 return new ChainedTransactionCommitImpl(tx, storeCohort, this);
266 public void close() {
268 // FIXME: this call doesn't look right here - listeningExecutor is shared and owned
269 // by the outer class.
270 //listeningExecutor.shutdownNow();
273 protected synchronized void onTransactionFailed(final SnapshotBackedWriteTransaction transaction,
279 public synchronized void onTransactionCommited(final SnapshotBackedWriteTransaction transaction) {
280 // If commited transaction is latestOutstandingTx we clear
281 // latestOutstandingTx
282 // field in order to base new transactions on Datastore Data Tree
284 if (transaction.equals(latestOutstandingTx)) {
285 latestOutstandingTx = null;
291 private static class ChainedTransactionCommitImpl implements DOMStoreThreePhaseCommitCohort {
293 private final SnapshotBackedWriteTransaction transaction;
294 private final DOMStoreThreePhaseCommitCohort delegate;
296 private final DOMStoreTransactionChainImpl txChain;
298 protected ChainedTransactionCommitImpl(final SnapshotBackedWriteTransaction transaction,
299 final DOMStoreThreePhaseCommitCohort delegate, final DOMStoreTransactionChainImpl txChain) {
301 this.transaction = transaction;
302 this.delegate = delegate;
303 this.txChain = txChain;
307 public ListenableFuture<Boolean> canCommit() {
308 return delegate.canCommit();
312 public ListenableFuture<Void> preCommit() {
313 return delegate.preCommit();
317 public ListenableFuture<Void> abort() {
318 return delegate.abort();
322 public ListenableFuture<Void> commit() {
323 ListenableFuture<Void> commitFuture = delegate.commit();
324 Futures.addCallback(commitFuture, new FutureCallback<Void>() {
326 public void onFailure(final Throwable t) {
327 txChain.onTransactionFailed(transaction, t);
331 public void onSuccess(final Void result) {
332 txChain.onTransactionCommited(transaction);
341 private class ThreePhaseCommitImpl implements DOMStoreThreePhaseCommitCohort {
343 private final SnapshotBackedWriteTransaction transaction;
344 private final DataTreeModification modification;
346 private ResolveDataChangeEventsTask listenerResolver;
347 private DataTreeCandidate candidate;
349 public ThreePhaseCommitImpl(final SnapshotBackedWriteTransaction writeTransaction) {
350 this.transaction = writeTransaction;
351 this.modification = transaction.getMutatedView();
355 public ListenableFuture<Boolean> canCommit() {
356 return listeningExecutor.submit(new Callable<Boolean>() {
358 public Boolean call() throws TransactionCommitFailedException {
360 dataTree.validate(modification);
361 LOG.debug("Store Transaction: {} can be committed", transaction.getIdentifier());
363 } catch (ConflictingModificationAppliedException e) {
364 LOG.warn("Store Tx: {} Conflicting modification for {}.", transaction.getIdentifier(),
366 throw new OptimisticLockFailedException("Optimistic lock failed.",e);
367 } catch (DataValidationFailedException e) {
368 LOG.warn("Store Tx: {} Data Precondition failed for {}.", transaction.getIdentifier(),
370 throw new TransactionCommitFailedException("Data did not pass validation.",e);
377 public ListenableFuture<Void> preCommit() {
378 return listeningExecutor.submit(new Callable<Void>() {
381 candidate = dataTree.prepare(modification);
382 listenerResolver = ResolveDataChangeEventsTask.create(candidate, listenerTree,
383 dataChangeListenerNotificationManager);
390 public ListenableFuture<Void> abort() {
392 return Futures.immediateFuture(null);
396 public ListenableFuture<Void> commit() {
397 checkState(candidate != null, "Proposed subtree must be computed");
400 * The commit has to occur atomically with regard to listener
403 synchronized (this) {
404 dataTree.commit(candidate);
406 for (ChangeListenerNotifyTask task : listenerResolver.call()) {
407 LOG.trace("Scheduling invocation of listeners: {}", task);
412 return Futures.immediateFuture(null);