opendaylight/md-sal/sal-inmemory-datastore/src/main/java/org/opendaylight/controller/md/sal/dom/store/impl/InMemoryDOMDataStore.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.controller.md.sal.dom.store.impl;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.base.Preconditions;
  12 import java.util.concurrent.ExecutorService;
  13 import java.util.concurrent.TimeUnit;
  14 import java.util.concurrent.atomic.AtomicLong;
  15 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
  16 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeListener;
  17 import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeListener;
  18 import org.opendaylight.controller.md.sal.dom.store.impl.tree.ListenerTree;
  19 import org.opendaylight.controller.sal.core.spi.data.DOMStore;
  20 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadTransaction;
  21 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadWriteTransaction;
  22 import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
  23 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionChain;
  24 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTreeChangePublisher;
  25 import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction;
  26 import org.opendaylight.controller.sal.core.spi.data.SnapshotBackedTransactions;
  27 import org.opendaylight.controller.sal.core.spi.data.SnapshotBackedWriteTransaction;
  28 import org.opendaylight.controller.sal.core.spi.data.SnapshotBackedWriteTransaction.TransactionReadyPrototype;
  29 import org.opendaylight.yangtools.concepts.AbstractListenerRegistration;
  30 import org.opendaylight.yangtools.concepts.Identifiable;
  31 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  32 import org.opendaylight.yangtools.util.ExecutorServiceUtil;
  33 import org.opendaylight.yangtools.util.concurrent.QueuedNotificationManager;
  34 import org.opendaylight.yangtools.util.concurrent.QueuedNotificationManager.Invoker;
  35 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  36 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  37 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
  38 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
  39 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
  40 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeSnapshot;
  41 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
  42 import org.opendaylight.yangtools.yang.data.impl.schema.tree.InMemoryDataTreeFactory;
  43 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  44 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
  45 import org.slf4j.Logger;
  46 import org.slf4j.LoggerFactory;
  47
  48 /**
  49  * In-memory DOM Data Store
  50  *
  51  * Implementation of {@link DOMStore} which uses {@link DataTree} and other
  52  * classes such as {@link SnapshotBackedWriteTransaction}.
  53  * {@link org.opendaylight.controller.sal.core.spi.data.SnapshotBackedReadTransaction} and {@link ResolveDataChangeEventsTask}
  54  * to implement {@link DOMStore} contract.
  55  *
  56  */
  57 public class InMemoryDOMDataStore extends TransactionReadyPrototype<String> implements DOMStore, Identifiable<String>, SchemaContextListener, AutoCloseable, DOMStoreTreeChangePublisher {
  58     private static final Logger LOG = LoggerFactory.getLogger(InMemoryDOMDataStore.class);
  59
  60     private static final Invoker<DataChangeListenerRegistration<?>, DOMImmutableDataChangeEvent> DCL_NOTIFICATION_MGR_INVOKER =
  61             new Invoker<DataChangeListenerRegistration<?>, DOMImmutableDataChangeEvent>() {
  62                 @Override
  63                 public void invokeListener(final DataChangeListenerRegistration<?> listener,
  64                                            final DOMImmutableDataChangeEvent notification ) {
  65                     final AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>> inst = listener.getInstance();
  66                     if (inst != null) {
  67                         inst.onDataChanged(notification);
  68                     }
  69                 }
  70             };
  71
  72     private final DataTree dataTree = InMemoryDataTreeFactory.getInstance().create();
  73     private final ListenerTree listenerTree = ListenerTree.create();
  74     private final AtomicLong txCounter = new AtomicLong(0);
  75
  76     private final QueuedNotificationManager<DataChangeListenerRegistration<?>, DOMImmutableDataChangeEvent> dataChangeListenerNotificationManager;
  77     private final InMemoryDOMStoreTreeChangePublisher changePublisher;
  78     private final ExecutorService dataChangeListenerExecutor;
  79     private final boolean debugTransactions;
  80     private final String name;
  81
  82     private volatile AutoCloseable closeable;
  83
  84     public InMemoryDOMDataStore(final String name, final ExecutorService dataChangeListenerExecutor) {
  85         this(name, dataChangeListenerExecutor, InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_LISTENER_QUEUE_SIZE, false);
  86     }
  87
  88     public InMemoryDOMDataStore(final String name, final ExecutorService dataChangeListenerExecutor,
  89             final int maxDataChangeListenerQueueSize, final boolean debugTransactions) {
  90         this.name = Preconditions.checkNotNull(name);
  91         this.dataChangeListenerExecutor = Preconditions.checkNotNull(dataChangeListenerExecutor);
  92         this.debugTransactions = debugTransactions;
  93
  94         dataChangeListenerNotificationManager =
  95                 new QueuedNotificationManager<>(this.dataChangeListenerExecutor,
  96                         DCL_NOTIFICATION_MGR_INVOKER, maxDataChangeListenerQueueSize,
  97                         "DataChangeListenerQueueMgr");
  98         changePublisher = new InMemoryDOMStoreTreeChangePublisher(this.dataChangeListenerExecutor, maxDataChangeListenerQueueSize);
  99     }
 100
 101     public void setCloseable(final AutoCloseable closeable) {
 102         this.closeable = closeable;
 103     }
 104
 105     public QueuedNotificationManager<?, ?> getDataChangeListenerNotificationManager() {
 106         return dataChangeListenerNotificationManager;
 107     }
 108
 109     @Override
 110     public final String getIdentifier() {
 111         return name;
 112     }
 113
 114     @Override
 115     public DOMStoreReadTransaction newReadOnlyTransaction() {
 116         return SnapshotBackedTransactions.newReadTransaction(nextIdentifier(), debugTransactions, dataTree.takeSnapshot());
 117     }
 118
 119     @Override
 120     public DOMStoreReadWriteTransaction newReadWriteTransaction() {
 121         return SnapshotBackedTransactions.newReadWriteTransaction(nextIdentifier(), debugTransactions, dataTree.takeSnapshot(), this);
 122     }
 123
 124     @Override
 125     public DOMStoreWriteTransaction newWriteOnlyTransaction() {
 126         return SnapshotBackedTransactions.newWriteTransaction(nextIdentifier(), debugTransactions, dataTree.takeSnapshot(), this);
 127     }
 128
 129     @Override
 130     public DOMStoreTransactionChain createTransactionChain() {
 131         return new DOMStoreTransactionChainImpl(this);
 132     }
 133
 134     @Override
 135     public synchronized void onGlobalContextUpdated(final SchemaContext ctx) {
 136         dataTree.setSchemaContext(ctx);
 137     }
 138
 139     @Override
 140     public void close() {
 141         ExecutorServiceUtil.tryGracefulShutdown(dataChangeListenerExecutor, 30, TimeUnit.SECONDS);
 142
 143         if(closeable != null) {
 144             try {
 145                 closeable.close();
 146             } catch(Exception e) {
 147                 LOG.debug("Error closing instance", e);
 148             }
 149         }
 150     }
 151
 152     public final boolean getDebugTransactions() {
 153         return debugTransactions;
 154     }
 155
 156     final DataTreeSnapshot takeSnapshot() {
 157         return dataTree.takeSnapshot();
 158     }
 159
 160     @Override
 161     public <L extends AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>>> ListenerRegistration<L> registerChangeListener(
 162             final YangInstanceIdentifier path, final L listener, final DataChangeScope scope) {
 163
 164         /*
 165          * Make sure commit is not occurring right now. Listener has to be
 166          * registered and its state capture enqueued at a consistent point.
 167          *
 168          * FIXME: improve this to read-write lock, such that multiple listener
 169          * registrations can occur simultaneously
 170          */
 171         final DataChangeListenerRegistration<L> reg;
 172         synchronized (this) {
 173             LOG.debug("{}: Registering data change listener {} for {}", name, listener, path);
 174
 175             reg = listenerTree.registerDataChangeListener(path, listener, scope);
 176
 177             Optional<NormalizedNode<?, ?>> currentState = dataTree.takeSnapshot().readNode(path);
 178             if (currentState.isPresent()) {
 179                 final NormalizedNode<?, ?> data = currentState.get();
 180
 181                 final DOMImmutableDataChangeEvent event = DOMImmutableDataChangeEvent.builder(DataChangeScope.BASE) //
 182                         .setAfter(data) //
 183                         .addCreated(path, data) //
 184                         .build();
 185
 186                 dataChangeListenerNotificationManager.submitNotification(reg, event);
 187             }
 188         }
 189
 190         return new AbstractListenerRegistration<L>(listener) {
 191             @Override
 192             protected void removeRegistration() {
 193                 synchronized (InMemoryDOMDataStore.this) {
 194                     reg.close();
 195                 }
 196             }
 197         };
 198     }
 199
 200     @Override
 201     public synchronized <L extends DOMDataTreeChangeListener> ListenerRegistration<L> registerTreeChangeListener(final YangInstanceIdentifier treeId, final L listener) {
 202         /*
 203          * Make sure commit is not occurring right now. Listener has to be
 204          * registered and its state capture enqueued at a consistent point.
 205          */
 206         return changePublisher.registerTreeChangeListener(treeId, listener, dataTree.takeSnapshot());
 207     }
 208
 209     @Override
 210     protected void transactionAborted(final SnapshotBackedWriteTransaction<String> tx) {
 211         LOG.debug("Tx: {} is closed.", tx.getIdentifier());
 212     }
 213
 214     @Override
 215     protected DOMStoreThreePhaseCommitCohort transactionReady(final SnapshotBackedWriteTransaction<String> tx, final DataTreeModification modification) {
 216         LOG.debug("Tx: {} is submitted. Modifications: {}", tx.getIdentifier(), modification);
 217         return new InMemoryDOMStoreThreePhaseCommitCohort(this, tx, modification);
 218     }
 219
 220     String nextIdentifier() {
 221         return name + "-" + txCounter.getAndIncrement();
 222     }
 223
 224     void validate(final DataTreeModification modification) throws DataValidationFailedException {
 225         dataTree.validate(modification);
 226     }
 227
 228     DataTreeCandidate prepare(final DataTreeModification modification) {
 229         return dataTree.prepare(modification);
 230     }
 231
 232     synchronized void commit(final DataTreeCandidate candidate) {
 233         dataTree.commit(candidate);
 234         changePublisher.publishChange(candidate);
 235         ResolveDataChangeEventsTask.create(candidate, listenerTree).resolve(dataChangeListenerNotificationManager);
 236     }
 237 }