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 static com.google.common.base.Preconditions.checkState;
12 import com.google.common.base.Optional;
13 import com.google.common.base.Preconditions;
14 import com.google.common.util.concurrent.FutureCallback;
15 import com.google.common.util.concurrent.Futures;
16 import com.google.common.util.concurrent.ListenableFuture;
17 import com.google.common.util.concurrent.ListeningExecutorService;
19 import java.util.concurrent.Callable;
20 import java.util.concurrent.ExecutorService;
21 import java.util.concurrent.TimeUnit;
22 import java.util.concurrent.atomic.AtomicLong;
24 import javax.annotation.concurrent.GuardedBy;
26 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
27 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeListener;
28 import org.opendaylight.controller.md.sal.common.api.data.OptimisticLockFailedException;
29 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
30 import org.opendaylight.controller.md.sal.dom.store.impl.SnapshotBackedWriteTransaction.TransactionReadyPrototype;
31 import org.opendaylight.controller.md.sal.dom.store.impl.tree.ListenerTree;
32 import org.opendaylight.controller.sal.core.spi.data.DOMStore;
33 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadTransaction;
34 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadWriteTransaction;
35 import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
36 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionChain;
37 import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction;
38 import org.opendaylight.yangtools.concepts.AbstractListenerRegistration;
39 import org.opendaylight.yangtools.concepts.Identifiable;
40 import org.opendaylight.yangtools.concepts.ListenerRegistration;
41 import org.opendaylight.yangtools.util.ExecutorServiceUtil;
42 import org.opendaylight.yangtools.util.concurrent.NotificationManager;
43 import org.opendaylight.yangtools.util.concurrent.QueuedNotificationManager;
44 import org.opendaylight.yangtools.util.concurrent.QueuedNotificationManager.Invoker;
45 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
46 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
47 import org.opendaylight.yangtools.yang.data.api.schema.tree.ConflictingModificationAppliedException;
48 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
49 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
50 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
51 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeSnapshot;
52 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
53 import org.opendaylight.yangtools.yang.data.impl.schema.tree.InMemoryDataTreeFactory;
54 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
55 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
56 import org.slf4j.Logger;
57 import org.slf4j.LoggerFactory;
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 private static final Invoker<DataChangeListenerRegistration<?>, DOMImmutableDataChangeEvent> DCL_NOTIFICATION_MGR_INVOKER =
73 new Invoker<DataChangeListenerRegistration<?>, DOMImmutableDataChangeEvent>() {
75 public void invokeListener(final DataChangeListenerRegistration<?> listener,
76 final DOMImmutableDataChangeEvent notification ) {
77 final AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>> inst = listener.getInstance();
79 inst.onDataChanged(notification);
84 private final DataTree dataTree = InMemoryDataTreeFactory.getInstance().create();
85 private final ListenerTree listenerTree = ListenerTree.create();
86 private final AtomicLong txCounter = new AtomicLong(0);
87 private final ListeningExecutorService listeningExecutor;
89 private final NotificationManager<DataChangeListenerRegistration<?>, DOMImmutableDataChangeEvent> dataChangeListenerNotificationManager;
90 private final ExecutorService dataChangeListenerExecutor;
92 private final String name;
94 public InMemoryDOMDataStore(final String name, final ListeningExecutorService listeningExecutor,
95 final ExecutorService dataChangeListenerExecutor) {
96 this(name, listeningExecutor, dataChangeListenerExecutor,
97 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_LISTENER_QUEUE_SIZE);
100 public InMemoryDOMDataStore(final String name, final ListeningExecutorService listeningExecutor,
101 final ExecutorService dataChangeListenerExecutor, final int maxDataChangeListenerQueueSize) {
102 this.name = Preconditions.checkNotNull(name);
103 this.listeningExecutor = Preconditions.checkNotNull(listeningExecutor);
104 this.dataChangeListenerExecutor = Preconditions.checkNotNull(dataChangeListenerExecutor);
106 dataChangeListenerNotificationManager =
107 new QueuedNotificationManager<>(this.dataChangeListenerExecutor,
108 DCL_NOTIFICATION_MGR_INVOKER, maxDataChangeListenerQueueSize,
109 "DataChangeListenerQueueMgr");
113 public final String getIdentifier() {
118 public DOMStoreReadTransaction newReadOnlyTransaction() {
119 return new SnapshotBackedReadTransaction(nextIdentifier(), dataTree.takeSnapshot());
123 public DOMStoreReadWriteTransaction newReadWriteTransaction() {
124 return new SnapshotBackedReadWriteTransaction(nextIdentifier(), dataTree.takeSnapshot(), this);
128 public DOMStoreWriteTransaction newWriteOnlyTransaction() {
129 return new SnapshotBackedWriteTransaction(nextIdentifier(), dataTree.takeSnapshot(), this);
133 public DOMStoreTransactionChain createTransactionChain() {
134 return new DOMStoreTransactionChainImpl();
138 public synchronized void onGlobalContextUpdated(final SchemaContext ctx) {
139 dataTree.setSchemaContext(ctx);
143 public void close() {
144 ExecutorServiceUtil.tryGracefulShutdown(listeningExecutor, 30, TimeUnit.SECONDS);
145 ExecutorServiceUtil.tryGracefulShutdown(dataChangeListenerExecutor, 30, TimeUnit.SECONDS);
148 public <L extends AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>>> ListenerRegistration<L> registerChangeListener(
149 final YangInstanceIdentifier path, final L listener, final DataChangeScope scope) {
152 * Make sure commit is not occurring right now. Listener has to be
153 * registered and its state capture enqueued at a consistent point.
155 * FIXME: improve this to read-write lock, such that multiple listener
156 * registrations can occur simultaneously
158 final DataChangeListenerRegistration<L> reg;
159 synchronized (this) {
160 LOG.debug("{}: Registering data change listener {} for {}", name, listener, path);
162 reg = listenerTree.registerDataChangeListener(path, listener, scope);
164 Optional<NormalizedNode<?, ?>> currentState = dataTree.takeSnapshot().readNode(path);
165 if (currentState.isPresent()) {
166 final NormalizedNode<?, ?> data = currentState.get();
168 final DOMImmutableDataChangeEvent event = DOMImmutableDataChangeEvent.builder(DataChangeScope.BASE) //
170 .addCreated(path, data) //
173 dataChangeListenerNotificationManager.submitNotification(reg, event);
177 return new AbstractListenerRegistration<L>(listener) {
179 protected void removeRegistration() {
180 synchronized (InMemoryDOMDataStore.this) {
188 public DOMStoreThreePhaseCommitCohort ready(final SnapshotBackedWriteTransaction writeTx) {
189 LOG.debug("Tx: {} is submitted. Modifications: {}", writeTx.getIdentifier(), writeTx.getMutatedView());
190 return new ThreePhaseCommitImpl(writeTx);
193 private Object nextIdentifier() {
194 return name + "-" + txCounter.getAndIncrement();
197 private class DOMStoreTransactionChainImpl implements DOMStoreTransactionChain, TransactionReadyPrototype {
200 private SnapshotBackedWriteTransaction latestOutstandingTx;
202 private boolean chainFailed = false;
204 private void checkFailed() {
205 Preconditions.checkState(!chainFailed, "Transaction chain is failed.");
209 public synchronized DOMStoreReadTransaction newReadOnlyTransaction() {
210 final DataTreeSnapshot snapshot;
212 if (latestOutstandingTx != null) {
213 checkState(latestOutstandingTx.isReady(), "Previous transaction in chain must be ready.");
214 snapshot = latestOutstandingTx.getMutatedView();
216 snapshot = dataTree.takeSnapshot();
218 return new SnapshotBackedReadTransaction(nextIdentifier(), snapshot);
222 public synchronized DOMStoreReadWriteTransaction newReadWriteTransaction() {
223 final DataTreeSnapshot snapshot;
225 if (latestOutstandingTx != null) {
226 checkState(latestOutstandingTx.isReady(), "Previous transaction in chain must be ready.");
227 snapshot = latestOutstandingTx.getMutatedView();
229 snapshot = dataTree.takeSnapshot();
231 final SnapshotBackedReadWriteTransaction ret = new SnapshotBackedReadWriteTransaction(nextIdentifier(),
233 latestOutstandingTx = ret;
238 public synchronized DOMStoreWriteTransaction newWriteOnlyTransaction() {
239 final DataTreeSnapshot snapshot;
241 if (latestOutstandingTx != null) {
242 checkState(latestOutstandingTx.isReady(), "Previous transaction in chain must be ready.");
243 snapshot = latestOutstandingTx.getMutatedView();
245 snapshot = dataTree.takeSnapshot();
247 final SnapshotBackedWriteTransaction ret = new SnapshotBackedWriteTransaction(nextIdentifier(), snapshot,
249 latestOutstandingTx = ret;
254 public DOMStoreThreePhaseCommitCohort ready(final SnapshotBackedWriteTransaction tx) {
255 DOMStoreThreePhaseCommitCohort storeCohort = InMemoryDOMDataStore.this.ready(tx);
256 return new ChainedTransactionCommitImpl(tx, storeCohort, this);
260 public void close() {
262 // FIXME: this call doesn't look right here - listeningExecutor is shared and owned
263 // by the outer class.
264 //listeningExecutor.shutdownNow();
267 protected synchronized void onTransactionFailed(final SnapshotBackedWriteTransaction transaction,
273 public synchronized void onTransactionCommited(final SnapshotBackedWriteTransaction transaction) {
274 // If committed transaction is latestOutstandingTx we clear
275 // latestOutstandingTx
276 // field in order to base new transactions on Datastore Data Tree
278 if (transaction.equals(latestOutstandingTx)) {
279 latestOutstandingTx = null;
285 private static class ChainedTransactionCommitImpl implements DOMStoreThreePhaseCommitCohort {
287 private final SnapshotBackedWriteTransaction transaction;
288 private final DOMStoreThreePhaseCommitCohort delegate;
290 private final DOMStoreTransactionChainImpl txChain;
292 protected ChainedTransactionCommitImpl(final SnapshotBackedWriteTransaction transaction,
293 final DOMStoreThreePhaseCommitCohort delegate, final DOMStoreTransactionChainImpl txChain) {
295 this.transaction = transaction;
296 this.delegate = delegate;
297 this.txChain = txChain;
301 public ListenableFuture<Boolean> canCommit() {
302 return delegate.canCommit();
306 public ListenableFuture<Void> preCommit() {
307 return delegate.preCommit();
311 public ListenableFuture<Void> abort() {
312 return delegate.abort();
316 public ListenableFuture<Void> commit() {
317 ListenableFuture<Void> commitFuture = delegate.commit();
318 Futures.addCallback(commitFuture, new FutureCallback<Void>() {
320 public void onFailure(final Throwable t) {
321 txChain.onTransactionFailed(transaction, t);
325 public void onSuccess(final Void result) {
326 txChain.onTransactionCommited(transaction);
335 private class ThreePhaseCommitImpl implements DOMStoreThreePhaseCommitCohort {
337 private final SnapshotBackedWriteTransaction transaction;
338 private final DataTreeModification modification;
340 private ResolveDataChangeEventsTask listenerResolver;
341 private DataTreeCandidate candidate;
343 public ThreePhaseCommitImpl(final SnapshotBackedWriteTransaction writeTransaction) {
344 this.transaction = writeTransaction;
345 this.modification = transaction.getMutatedView();
349 public ListenableFuture<Boolean> canCommit() {
350 return listeningExecutor.submit(new Callable<Boolean>() {
352 public Boolean call() throws TransactionCommitFailedException {
354 dataTree.validate(modification);
355 LOG.debug("Store Transaction: {} can be committed", transaction.getIdentifier());
357 } catch (ConflictingModificationAppliedException e) {
358 LOG.warn("Store Tx: {} Conflicting modification for {}.", transaction.getIdentifier(),
360 throw new OptimisticLockFailedException("Optimistic lock failed.",e);
361 } catch (DataValidationFailedException e) {
362 LOG.warn("Store Tx: {} Data Precondition failed for {}.", transaction.getIdentifier(),
364 throw new TransactionCommitFailedException("Data did not pass validation.",e);
371 public ListenableFuture<Void> preCommit() {
372 return listeningExecutor.submit(new Callable<Void>() {
375 candidate = dataTree.prepare(modification);
376 listenerResolver = ResolveDataChangeEventsTask.create(candidate, listenerTree);
383 public ListenableFuture<Void> abort() {
385 return Futures.immediateFuture(null);
389 public ListenableFuture<Void> commit() {
390 checkState(candidate != null, "Proposed subtree must be computed");
393 * The commit has to occur atomically with regard to listener
396 synchronized (this) {
397 dataTree.commit(candidate);
398 listenerResolver.resolve(dataChangeListenerNotificationManager);
401 return Futures.immediateFuture(null);