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;
11 import com.google.common.base.Optional;
12 import com.google.common.base.Preconditions;
13 import com.google.common.util.concurrent.Futures;
14 import com.google.common.util.concurrent.ListenableFuture;
15 import java.util.concurrent.ExecutorService;
16 import java.util.concurrent.TimeUnit;
17 import java.util.concurrent.atomic.AtomicLong;
18 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
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.controller.md.sal.dom.store.impl.tree.ListenerTree;
24 import org.opendaylight.controller.sal.core.spi.data.DOMStore;
25 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadTransaction;
26 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadWriteTransaction;
27 import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
28 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionChain;
29 import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction;
30 import org.opendaylight.yangtools.concepts.AbstractListenerRegistration;
31 import org.opendaylight.yangtools.concepts.Identifiable;
32 import org.opendaylight.yangtools.concepts.ListenerRegistration;
33 import org.opendaylight.yangtools.util.ExecutorServiceUtil;
34 import org.opendaylight.yangtools.util.concurrent.QueuedNotificationManager;
35 import org.opendaylight.yangtools.util.concurrent.QueuedNotificationManager.Invoker;
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.data.api.schema.tree.ConflictingModificationAppliedException;
39 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
40 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
41 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
42 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeSnapshot;
43 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
44 import org.opendaylight.yangtools.yang.data.impl.schema.tree.InMemoryDataTreeFactory;
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;
51 * In-memory DOM Data Store
53 * Implementation of {@link DOMStore} which uses {@link DataTree} and other
54 * classes such as {@link SnapshotBackedWriteTransaction}.
55 * {@link SnapshotBackedReadTransaction} and {@link ResolveDataChangeEventsTask}
56 * to implement {@link DOMStore} contract.
59 public class InMemoryDOMDataStore extends TransactionReadyPrototype implements DOMStore, Identifiable<String>, SchemaContextListener, AutoCloseable {
60 private static final Logger LOG = LoggerFactory.getLogger(InMemoryDOMDataStore.class);
61 private static final ListenableFuture<Void> SUCCESSFUL_FUTURE = Futures.immediateFuture(null);
62 private static final ListenableFuture<Boolean> CAN_COMMIT_FUTURE = Futures.immediateFuture(Boolean.TRUE);
64 private static final Invoker<DataChangeListenerRegistration<?>, DOMImmutableDataChangeEvent> DCL_NOTIFICATION_MGR_INVOKER =
65 new Invoker<DataChangeListenerRegistration<?>, DOMImmutableDataChangeEvent>() {
67 public void invokeListener(final DataChangeListenerRegistration<?> listener,
68 final DOMImmutableDataChangeEvent notification ) {
69 final AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>> inst = listener.getInstance();
71 inst.onDataChanged(notification);
76 private final DataTree dataTree = InMemoryDataTreeFactory.getInstance().create();
77 private final ListenerTree listenerTree = ListenerTree.create();
78 private final AtomicLong txCounter = new AtomicLong(0);
80 private final QueuedNotificationManager<DataChangeListenerRegistration<?>, DOMImmutableDataChangeEvent> dataChangeListenerNotificationManager;
81 private final ExecutorService dataChangeListenerExecutor;
82 private final boolean debugTransactions;
83 private final String name;
85 private volatile AutoCloseable closeable;
87 public InMemoryDOMDataStore(final String name, final ExecutorService dataChangeListenerExecutor) {
88 this(name, dataChangeListenerExecutor, InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_LISTENER_QUEUE_SIZE, false);
91 public InMemoryDOMDataStore(final String name, final ExecutorService dataChangeListenerExecutor,
92 final int maxDataChangeListenerQueueSize, final boolean debugTransactions) {
93 this.name = Preconditions.checkNotNull(name);
94 this.dataChangeListenerExecutor = Preconditions.checkNotNull(dataChangeListenerExecutor);
95 this.debugTransactions = debugTransactions;
97 dataChangeListenerNotificationManager =
98 new QueuedNotificationManager<>(this.dataChangeListenerExecutor,
99 DCL_NOTIFICATION_MGR_INVOKER, maxDataChangeListenerQueueSize,
100 "DataChangeListenerQueueMgr");
103 public void setCloseable(final AutoCloseable closeable) {
104 this.closeable = closeable;
107 public QueuedNotificationManager<?, ?> getDataChangeListenerNotificationManager() {
108 return dataChangeListenerNotificationManager;
112 public final String getIdentifier() {
117 public DOMStoreReadTransaction newReadOnlyTransaction() {
118 return new SnapshotBackedReadTransaction(nextIdentifier(), debugTransactions, dataTree.takeSnapshot());
122 public DOMStoreReadWriteTransaction newReadWriteTransaction() {
123 return new SnapshotBackedReadWriteTransaction(nextIdentifier(), debugTransactions, dataTree.takeSnapshot(), this);
127 public DOMStoreWriteTransaction newWriteOnlyTransaction() {
128 return new SnapshotBackedWriteTransaction(nextIdentifier(), debugTransactions, dataTree.takeSnapshot(), this);
132 public DOMStoreTransactionChain createTransactionChain() {
133 return new DOMStoreTransactionChainImpl(this);
137 public synchronized void onGlobalContextUpdated(final SchemaContext ctx) {
138 dataTree.setSchemaContext(ctx);
142 public void close() {
143 ExecutorServiceUtil.tryGracefulShutdown(dataChangeListenerExecutor, 30, TimeUnit.SECONDS);
145 if(closeable != null) {
148 } catch(Exception e) {
149 LOG.debug("Error closing instance", e);
154 public final boolean getDebugTransactions() {
155 return debugTransactions;
158 final DataTreeSnapshot takeSnapshot() {
159 return dataTree.takeSnapshot();
163 public <L extends AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>>> ListenerRegistration<L> registerChangeListener(
164 final YangInstanceIdentifier path, final L listener, final DataChangeScope scope) {
167 * Make sure commit is not occurring right now. Listener has to be
168 * registered and its state capture enqueued at a consistent point.
170 * FIXME: improve this to read-write lock, such that multiple listener
171 * registrations can occur simultaneously
173 final DataChangeListenerRegistration<L> reg;
174 synchronized (this) {
175 LOG.debug("{}: Registering data change listener {} for {}", name, listener, path);
177 reg = listenerTree.registerDataChangeListener(path, listener, scope);
179 Optional<NormalizedNode<?, ?>> currentState = dataTree.takeSnapshot().readNode(path);
180 if (currentState.isPresent()) {
181 final NormalizedNode<?, ?> data = currentState.get();
183 final DOMImmutableDataChangeEvent event = DOMImmutableDataChangeEvent.builder(DataChangeScope.BASE) //
185 .addCreated(path, data) //
188 dataChangeListenerNotificationManager.submitNotification(reg, event);
192 return new AbstractListenerRegistration<L>(listener) {
194 protected void removeRegistration() {
195 synchronized (InMemoryDOMDataStore.this) {
203 protected void transactionAborted(final SnapshotBackedWriteTransaction tx) {
204 LOG.debug("Tx: {} is closed.", tx.getIdentifier());
208 protected DOMStoreThreePhaseCommitCohort transactionReady(final SnapshotBackedWriteTransaction tx, final DataTreeModification tree) {
209 LOG.debug("Tx: {} is submitted. Modifications: {}", tx.getIdentifier(), tree);
210 return new ThreePhaseCommitImpl(tx, tree);
213 Object nextIdentifier() {
214 return name + "-" + txCounter.getAndIncrement();
217 private final class ThreePhaseCommitImpl implements DOMStoreThreePhaseCommitCohort {
218 private final SnapshotBackedWriteTransaction transaction;
219 private final DataTreeModification modification;
221 private ResolveDataChangeEventsTask listenerResolver;
222 private DataTreeCandidate candidate;
224 public ThreePhaseCommitImpl(final SnapshotBackedWriteTransaction writeTransaction, final DataTreeModification modification) {
225 this.transaction = writeTransaction;
226 this.modification = modification;
230 public ListenableFuture<Boolean> canCommit() {
232 dataTree.validate(modification);
233 LOG.debug("Store Transaction: {} can be committed", transaction.getIdentifier());
234 return CAN_COMMIT_FUTURE;
235 } catch (ConflictingModificationAppliedException e) {
236 LOG.warn("Store Tx: {} Conflicting modification for {}.", transaction.getIdentifier(),
238 transaction.warnDebugContext(LOG);
239 return Futures.immediateFailedFuture(new OptimisticLockFailedException("Optimistic lock failed.", e));
240 } catch (DataValidationFailedException e) {
241 LOG.warn("Store Tx: {} Data Precondition failed for {}.", transaction.getIdentifier(),
243 transaction.warnDebugContext(LOG);
245 // For debugging purposes, allow dumping of the modification. Coupled with the above
246 // precondition log, it should allow us to understand what went on.
247 LOG.trace("Store Tx: {} modifications: {} tree: {}", modification, dataTree);
249 return Futures.immediateFailedFuture(new TransactionCommitFailedException("Data did not pass validation.", e));
250 } catch (Exception e) {
251 LOG.warn("Unexpected failure in validation phase", e);
252 return Futures.immediateFailedFuture(e);
257 public ListenableFuture<Void> preCommit() {
259 candidate = dataTree.prepare(modification);
260 listenerResolver = ResolveDataChangeEventsTask.create(candidate, listenerTree);
261 return SUCCESSFUL_FUTURE;
262 } catch (Exception e) {
263 LOG.warn("Unexpected failure in pre-commit phase", e);
264 return Futures.immediateFailedFuture(e);
269 public ListenableFuture<Void> abort() {
271 return SUCCESSFUL_FUTURE;
275 public ListenableFuture<Void> commit() {
276 checkState(candidate != null, "Proposed subtree must be computed");
279 * The commit has to occur atomically with regard to listener
282 synchronized (InMemoryDOMDataStore.this) {
283 dataTree.commit(candidate);
284 listenerResolver.resolve(dataChangeListenerNotificationManager);
287 return SUCCESSFUL_FUTURE;