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;
18 import com.google.common.util.concurrent.MoreExecutors;
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;
23 import javax.annotation.concurrent.GuardedBy;
24 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
25 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeListener;
26 import org.opendaylight.controller.md.sal.common.api.data.OptimisticLockFailedException;
27 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
28 import org.opendaylight.controller.md.sal.dom.store.impl.SnapshotBackedWriteTransaction.TransactionReadyPrototype;
29 import org.opendaylight.controller.md.sal.dom.store.impl.tree.ListenerTree;
30 import org.opendaylight.controller.sal.core.spi.data.DOMStore;
31 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadTransaction;
32 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadWriteTransaction;
33 import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
34 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionChain;
35 import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction;
36 import org.opendaylight.yangtools.concepts.AbstractListenerRegistration;
37 import org.opendaylight.yangtools.concepts.Identifiable;
38 import org.opendaylight.yangtools.concepts.ListenerRegistration;
39 import org.opendaylight.yangtools.util.ExecutorServiceUtil;
40 import org.opendaylight.yangtools.util.concurrent.QueuedNotificationManager;
41 import org.opendaylight.yangtools.util.concurrent.QueuedNotificationManager.Invoker;
42 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
43 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
44 import org.opendaylight.yangtools.yang.data.api.schema.tree.ConflictingModificationAppliedException;
45 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
46 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
47 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
48 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeSnapshot;
49 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
50 import org.opendaylight.yangtools.yang.data.impl.schema.tree.InMemoryDataTreeFactory;
51 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
52 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
53 import org.slf4j.Logger;
54 import org.slf4j.LoggerFactory;
57 * In-memory DOM Data Store
59 * Implementation of {@link DOMStore} which uses {@link DataTree} and other
60 * classes such as {@link SnapshotBackedWriteTransaction}.
61 * {@link SnapshotBackedReadTransaction} and {@link ResolveDataChangeEventsTask}
62 * to implement {@link DOMStore} contract.
65 public class InMemoryDOMDataStore implements DOMStore, Identifiable<String>, SchemaContextListener,
66 TransactionReadyPrototype,AutoCloseable {
67 private static final Logger LOG = LoggerFactory.getLogger(InMemoryDOMDataStore.class);
68 private static final ListenableFuture<Void> SUCCESSFUL_FUTURE = Futures.immediateFuture(null);
70 private static final Invoker<DataChangeListenerRegistration<?>, DOMImmutableDataChangeEvent> DCL_NOTIFICATION_MGR_INVOKER =
71 new Invoker<DataChangeListenerRegistration<?>, DOMImmutableDataChangeEvent>() {
73 public void invokeListener(final DataChangeListenerRegistration<?> listener,
74 final DOMImmutableDataChangeEvent notification ) {
75 final AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>> inst = listener.getInstance();
77 inst.onDataChanged(notification);
82 private final DataTree dataTree = InMemoryDataTreeFactory.getInstance().create();
83 private final ListenerTree listenerTree = ListenerTree.create();
84 private final AtomicLong txCounter = new AtomicLong(0);
85 private final ListeningExecutorService listeningExecutor;
87 private final QueuedNotificationManager<DataChangeListenerRegistration<?>, DOMImmutableDataChangeEvent> dataChangeListenerNotificationManager;
88 private final ExecutorService dataChangeListenerExecutor;
90 private final ExecutorService domStoreExecutor;
91 private final boolean debugTransactions;
92 private final String name;
94 private volatile AutoCloseable closeable;
96 public InMemoryDOMDataStore(final String name, final ExecutorService domStoreExecutor,
97 final ExecutorService dataChangeListenerExecutor) {
98 this(name, domStoreExecutor, dataChangeListenerExecutor,
99 InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_LISTENER_QUEUE_SIZE, false);
102 public InMemoryDOMDataStore(final String name, final ExecutorService domStoreExecutor,
103 final ExecutorService dataChangeListenerExecutor, final int maxDataChangeListenerQueueSize,
104 final boolean debugTransactions) {
105 this.name = Preconditions.checkNotNull(name);
106 this.domStoreExecutor = Preconditions.checkNotNull(domStoreExecutor);
107 this.listeningExecutor = MoreExecutors.listeningDecorator(this.domStoreExecutor);
108 this.dataChangeListenerExecutor = Preconditions.checkNotNull(dataChangeListenerExecutor);
109 this.debugTransactions = debugTransactions;
111 dataChangeListenerNotificationManager =
112 new QueuedNotificationManager<>(this.dataChangeListenerExecutor,
113 DCL_NOTIFICATION_MGR_INVOKER, maxDataChangeListenerQueueSize,
114 "DataChangeListenerQueueMgr");
117 public void setCloseable(AutoCloseable closeable) {
118 this.closeable = closeable;
121 public QueuedNotificationManager<?, ?> getDataChangeListenerNotificationManager() {
122 return dataChangeListenerNotificationManager;
125 public ExecutorService getDomStoreExecutor() {
126 return domStoreExecutor;
130 public final String getIdentifier() {
135 public DOMStoreReadTransaction newReadOnlyTransaction() {
136 return new SnapshotBackedReadTransaction(nextIdentifier(), debugTransactions, dataTree.takeSnapshot());
140 public DOMStoreReadWriteTransaction newReadWriteTransaction() {
141 return new SnapshotBackedReadWriteTransaction(nextIdentifier(), debugTransactions, dataTree.takeSnapshot(), this);
145 public DOMStoreWriteTransaction newWriteOnlyTransaction() {
146 return new SnapshotBackedWriteTransaction(nextIdentifier(), debugTransactions, dataTree.takeSnapshot(), this);
150 public DOMStoreTransactionChain createTransactionChain() {
151 return new DOMStoreTransactionChainImpl();
155 public synchronized void onGlobalContextUpdated(final SchemaContext ctx) {
156 dataTree.setSchemaContext(ctx);
160 public void close() {
161 ExecutorServiceUtil.tryGracefulShutdown(listeningExecutor, 30, TimeUnit.SECONDS);
162 ExecutorServiceUtil.tryGracefulShutdown(dataChangeListenerExecutor, 30, TimeUnit.SECONDS);
164 if(closeable != null) {
167 } catch(Exception e) {
168 LOG.debug("Error closing instance", e);
173 boolean getDebugTransactions() {
174 return debugTransactions;
178 public <L extends AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>>> ListenerRegistration<L> registerChangeListener(
179 final YangInstanceIdentifier path, final L listener, final DataChangeScope scope) {
182 * Make sure commit is not occurring right now. Listener has to be
183 * registered and its state capture enqueued at a consistent point.
185 * FIXME: improve this to read-write lock, such that multiple listener
186 * registrations can occur simultaneously
188 final DataChangeListenerRegistration<L> reg;
189 synchronized (this) {
190 LOG.debug("{}: Registering data change listener {} for {}", name, listener, path);
192 reg = listenerTree.registerDataChangeListener(path, listener, scope);
194 Optional<NormalizedNode<?, ?>> currentState = dataTree.takeSnapshot().readNode(path);
195 if (currentState.isPresent()) {
196 final NormalizedNode<?, ?> data = currentState.get();
198 final DOMImmutableDataChangeEvent event = DOMImmutableDataChangeEvent.builder(DataChangeScope.BASE) //
200 .addCreated(path, data) //
203 dataChangeListenerNotificationManager.submitNotification(reg, event);
207 return new AbstractListenerRegistration<L>(listener) {
209 protected void removeRegistration() {
210 synchronized (InMemoryDOMDataStore.this) {
218 public DOMStoreThreePhaseCommitCohort ready(final SnapshotBackedWriteTransaction writeTx) {
219 LOG.debug("Tx: {} is submitted. Modifications: {}", writeTx.getIdentifier(), writeTx.getMutatedView());
220 return new ThreePhaseCommitImpl(writeTx);
223 private Object nextIdentifier() {
224 return name + "-" + txCounter.getAndIncrement();
227 private class DOMStoreTransactionChainImpl implements DOMStoreTransactionChain, TransactionReadyPrototype {
230 private SnapshotBackedWriteTransaction latestOutstandingTx;
232 private boolean chainFailed = false;
234 private void checkFailed() {
235 Preconditions.checkState(!chainFailed, "Transaction chain is failed.");
239 public synchronized DOMStoreReadTransaction newReadOnlyTransaction() {
240 final DataTreeSnapshot snapshot;
242 if (latestOutstandingTx != null) {
243 checkState(latestOutstandingTx.isReady(), "Previous transaction in chain must be ready.");
244 snapshot = latestOutstandingTx.getMutatedView();
246 snapshot = dataTree.takeSnapshot();
248 return new SnapshotBackedReadTransaction(nextIdentifier(), getDebugTransactions(), snapshot);
252 public synchronized DOMStoreReadWriteTransaction newReadWriteTransaction() {
253 final DataTreeSnapshot snapshot;
255 if (latestOutstandingTx != null) {
256 checkState(latestOutstandingTx.isReady(), "Previous transaction in chain must be ready.");
257 snapshot = latestOutstandingTx.getMutatedView();
259 snapshot = dataTree.takeSnapshot();
261 final SnapshotBackedReadWriteTransaction ret = new SnapshotBackedReadWriteTransaction(nextIdentifier(),
262 getDebugTransactions(), snapshot, this);
263 latestOutstandingTx = ret;
268 public synchronized DOMStoreWriteTransaction newWriteOnlyTransaction() {
269 final DataTreeSnapshot snapshot;
271 if (latestOutstandingTx != null) {
272 checkState(latestOutstandingTx.isReady(), "Previous transaction in chain must be ready.");
273 snapshot = latestOutstandingTx.getMutatedView();
275 snapshot = dataTree.takeSnapshot();
277 final SnapshotBackedWriteTransaction ret = new SnapshotBackedWriteTransaction(nextIdentifier(),
278 getDebugTransactions(), snapshot, this);
279 latestOutstandingTx = ret;
284 public DOMStoreThreePhaseCommitCohort ready(final SnapshotBackedWriteTransaction tx) {
285 DOMStoreThreePhaseCommitCohort storeCohort = InMemoryDOMDataStore.this.ready(tx);
286 return new ChainedTransactionCommitImpl(tx, storeCohort, this);
290 public void close() {
292 // FIXME: this call doesn't look right here - listeningExecutor is shared and owned
293 // by the outer class.
294 //listeningExecutor.shutdownNow();
297 protected synchronized void onTransactionFailed(final SnapshotBackedWriteTransaction transaction,
303 public synchronized void onTransactionCommited(final SnapshotBackedWriteTransaction transaction) {
304 // If committed transaction is latestOutstandingTx we clear
305 // latestOutstandingTx
306 // field in order to base new transactions on Datastore Data Tree
308 if (transaction.equals(latestOutstandingTx)) {
309 latestOutstandingTx = null;
315 private static class ChainedTransactionCommitImpl implements DOMStoreThreePhaseCommitCohort {
317 private final SnapshotBackedWriteTransaction transaction;
318 private final DOMStoreThreePhaseCommitCohort delegate;
320 private final DOMStoreTransactionChainImpl txChain;
322 protected ChainedTransactionCommitImpl(final SnapshotBackedWriteTransaction transaction,
323 final DOMStoreThreePhaseCommitCohort delegate, final DOMStoreTransactionChainImpl txChain) {
325 this.transaction = transaction;
326 this.delegate = delegate;
327 this.txChain = txChain;
331 public ListenableFuture<Boolean> canCommit() {
332 return delegate.canCommit();
336 public ListenableFuture<Void> preCommit() {
337 return delegate.preCommit();
341 public ListenableFuture<Void> abort() {
342 return delegate.abort();
346 public ListenableFuture<Void> commit() {
347 ListenableFuture<Void> commitFuture = delegate.commit();
348 Futures.addCallback(commitFuture, new FutureCallback<Void>() {
350 public void onFailure(final Throwable t) {
351 txChain.onTransactionFailed(transaction, t);
355 public void onSuccess(final Void result) {
356 txChain.onTransactionCommited(transaction);
365 private class ThreePhaseCommitImpl implements DOMStoreThreePhaseCommitCohort {
367 private final SnapshotBackedWriteTransaction transaction;
368 private final DataTreeModification modification;
370 private ResolveDataChangeEventsTask listenerResolver;
371 private DataTreeCandidate candidate;
373 public ThreePhaseCommitImpl(final SnapshotBackedWriteTransaction writeTransaction) {
374 this.transaction = writeTransaction;
375 this.modification = transaction.getMutatedView();
379 public ListenableFuture<Boolean> canCommit() {
380 return listeningExecutor.submit(new Callable<Boolean>() {
382 public Boolean call() throws TransactionCommitFailedException {
384 dataTree.validate(modification);
385 LOG.debug("Store Transaction: {} can be committed", transaction.getIdentifier());
387 } catch (ConflictingModificationAppliedException e) {
388 LOG.warn("Store Tx: {} Conflicting modification for {}.", transaction.getIdentifier(),
390 transaction.warnDebugContext(LOG);
391 throw new OptimisticLockFailedException("Optimistic lock failed.",e);
392 } catch (DataValidationFailedException e) {
393 LOG.warn("Store Tx: {} Data Precondition failed for {}.", transaction.getIdentifier(),
395 transaction.warnDebugContext(LOG);
396 throw new TransactionCommitFailedException("Data did not pass validation.",e);
403 public ListenableFuture<Void> preCommit() {
404 return listeningExecutor.submit(new Callable<Void>() {
407 candidate = dataTree.prepare(modification);
408 listenerResolver = ResolveDataChangeEventsTask.create(candidate, listenerTree);
415 public ListenableFuture<Void> abort() {
417 return SUCCESSFUL_FUTURE;
421 public ListenableFuture<Void> commit() {
422 checkState(candidate != null, "Proposed subtree must be computed");
425 * The commit has to occur atomically with regard to listener
428 synchronized (this) {
429 dataTree.commit(candidate);
430 listenerResolver.resolve(dataChangeListenerNotificationManager);
433 return SUCCESSFUL_FUTURE;