dom/mdsal-dom-inmemory-datastore/src/main/java/org/opendaylight/mdsal/dom/store/inmemory/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.mdsal.dom.store.inmemory;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import java.util.concurrent.ExecutorService;
  13 import java.util.concurrent.TimeUnit;
  14 import java.util.concurrent.atomic.AtomicLong;
  15 import org.eclipse.jdt.annotation.NonNull;
  16 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  17 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener;
  18 import org.opendaylight.mdsal.dom.spi.store.DOMStore;
  19 import org.opendaylight.mdsal.dom.spi.store.DOMStoreReadTransaction;
  20 import org.opendaylight.mdsal.dom.spi.store.DOMStoreReadWriteTransaction;
  21 import org.opendaylight.mdsal.dom.spi.store.DOMStoreThreePhaseCommitCohort;
  22 import org.opendaylight.mdsal.dom.spi.store.DOMStoreTransactionChain;
  23 import org.opendaylight.mdsal.dom.spi.store.DOMStoreTreeChangePublisher;
  24 import org.opendaylight.mdsal.dom.spi.store.DOMStoreWriteTransaction;
  25 import org.opendaylight.mdsal.dom.spi.store.SnapshotBackedTransactions;
  26 import org.opendaylight.mdsal.dom.spi.store.SnapshotBackedWriteTransaction;
  27 import org.opendaylight.mdsal.dom.spi.store.SnapshotBackedWriteTransaction.TransactionReadyPrototype;
  28 import org.opendaylight.yangtools.concepts.Identifiable;
  29 import org.opendaylight.yangtools.concepts.Registration;
  30 import org.opendaylight.yangtools.util.ExecutorServiceUtil;
  31 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  32 import org.opendaylight.yangtools.yang.data.tree.api.DataTree;
  33 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidate;
  34 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeConfiguration;
  35 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeModification;
  36 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeSnapshot;
  37 import org.opendaylight.yangtools.yang.data.tree.api.DataValidationFailedException;
  38 import org.opendaylight.yangtools.yang.data.tree.impl.di.InMemoryDataTreeFactory;
  39 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  40 import org.slf4j.Logger;
  41 import org.slf4j.LoggerFactory;
  42
  43 /**
  44  * In-memory DOM Data Store. Implementation of {@link DOMStore} which uses {@link DataTree} and other classes such as
  45  * {@link SnapshotBackedWriteTransaction}.
  46  * {@link org.opendaylight.mdsal.dom.spi.store.SnapshotBackedReadTransaction} to implement {@link DOMStore} contract.
  47  */
  48 public class InMemoryDOMDataStore extends TransactionReadyPrototype<String> implements DOMStore,
  49         Identifiable<String>, AutoCloseable, DOMStoreTreeChangePublisher {
  50     private static final Logger LOG = LoggerFactory.getLogger(InMemoryDOMDataStore.class);
  51
  52     private final AtomicLong txCounter = new AtomicLong(0);
  53     private final DataTree dataTree;
  54
  55     private final InMemoryDOMStoreTreeChangePublisher changePublisher;
  56     private final ExecutorService dataChangeListenerExecutor;
  57     private final boolean debugTransactions;
  58     private final @NonNull String name;
  59
  60     private volatile AutoCloseable closeable;
  61
  62     public InMemoryDOMDataStore(final String name, final ExecutorService dataChangeListenerExecutor) {
  63         this(name, dataChangeListenerExecutor,
  64             InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_LISTENER_QUEUE_SIZE, false);
  65     }
  66
  67     public InMemoryDOMDataStore(final String name, final ExecutorService dataChangeListenerExecutor,
  68             final int maxDataChangeListenerQueueSize, final boolean debugTransactions) {
  69         this(name, LogicalDatastoreType.OPERATIONAL, dataChangeListenerExecutor, maxDataChangeListenerQueueSize,
  70             debugTransactions);
  71     }
  72
  73     public InMemoryDOMDataStore(final String name, final LogicalDatastoreType type,
  74             final ExecutorService dataChangeListenerExecutor, final int maxDataChangeListenerQueueSize,
  75             final boolean debugTransactions) {
  76         this(name, defaultConfig(type), dataChangeListenerExecutor, maxDataChangeListenerQueueSize, debugTransactions);
  77     }
  78
  79     public InMemoryDOMDataStore(final String name, final DataTreeConfiguration config,
  80             final ExecutorService dataChangeListenerExecutor, final int maxDataChangeListenerQueueSize,
  81             final boolean debugTransactions) {
  82         this.name = requireNonNull(name);
  83         this.dataChangeListenerExecutor = requireNonNull(dataChangeListenerExecutor);
  84         this.debugTransactions = debugTransactions;
  85         dataTree = new InMemoryDataTreeFactory().create(config);
  86         changePublisher = new InMemoryDOMStoreTreeChangePublisher("name", this.dataChangeListenerExecutor,
  87                 maxDataChangeListenerQueueSize);
  88     }
  89
  90     public void setCloseable(final AutoCloseable closeable) {
  91         this.closeable = closeable;
  92     }
  93
  94     @Override
  95     public final String getIdentifier() {
  96         return name;
  97     }
  98
  99     public final synchronized void onModelContextUpdated(final EffectiveModelContext newModelContext) {
 100         dataTree.setEffectiveModelContext(newModelContext);
 101     }
 102
 103     @Override
 104     public DOMStoreReadTransaction newReadOnlyTransaction() {
 105         return SnapshotBackedTransactions.newReadTransaction(nextIdentifier(), debugTransactions,
 106             dataTree.takeSnapshot());
 107     }
 108
 109     @Override
 110     public DOMStoreReadWriteTransaction newReadWriteTransaction() {
 111         return SnapshotBackedTransactions.newReadWriteTransaction(nextIdentifier(), debugTransactions,
 112             dataTree.takeSnapshot(), this);
 113     }
 114
 115     @Override
 116     public DOMStoreWriteTransaction newWriteOnlyTransaction() {
 117         return SnapshotBackedTransactions.newWriteTransaction(nextIdentifier(), debugTransactions,
 118             dataTree.takeSnapshot(), this);
 119     }
 120
 121     @Override
 122     public DOMStoreTransactionChain createTransactionChain() {
 123         return new DOMStoreTransactionChainImpl(this);
 124     }
 125
 126     @SuppressWarnings("checkstyle:IllegalCatch")
 127     @Override
 128     public void close() {
 129         ExecutorServiceUtil.tryGracefulShutdown(dataChangeListenerExecutor, 30, TimeUnit.SECONDS);
 130
 131         if (closeable != null) {
 132             try {
 133                 closeable.close();
 134             } catch (Exception e) {
 135                 LOG.debug("Error closing instance", e);
 136             }
 137         }
 138     }
 139
 140     public final boolean getDebugTransactions() {
 141         return debugTransactions;
 142     }
 143
 144     final DataTreeSnapshot takeSnapshot() {
 145         return dataTree.takeSnapshot();
 146     }
 147
 148     @Override
 149     public synchronized Registration registerTreeChangeListener(final YangInstanceIdentifier treeId,
 150             final DOMDataTreeChangeListener listener) {
 151         // Make sure commit is not occurring right now. Listener has to be registered and its state capture enqueued at
 152         // a consistent point.
 153         return changePublisher.registerTreeChangeListener(treeId, listener, dataTree.takeSnapshot());
 154     }
 155
 156     @Override
 157     @Deprecated(since = "13.0.0", forRemoval = true)
 158     public Registration registerLegacyTreeChangeListener(final YangInstanceIdentifier treeId,
 159             final DOMDataTreeChangeListener listener) {
 160         return registerTreeChangeListener(treeId, listener);
 161     }
 162
 163     @Override
 164     protected void transactionAborted(final SnapshotBackedWriteTransaction<String> tx) {
 165         LOG.debug("Tx: {} is closed.", tx.getIdentifier());
 166     }
 167
 168     @Override
 169     protected DOMStoreThreePhaseCommitCohort transactionReady(final SnapshotBackedWriteTransaction<String> tx,
 170             final DataTreeModification modification, final Exception readyError) {
 171         LOG.debug("Tx: {} is submitted. Modifications: {}", tx.getIdentifier(), modification);
 172         return new InMemoryDOMStoreThreePhaseCommitCohort(this, tx, modification, readyError);
 173     }
 174
 175     String nextIdentifier() {
 176         return name + "-" + txCounter.getAndIncrement();
 177     }
 178
 179     void validate(final DataTreeModification modification) throws DataValidationFailedException {
 180         dataTree.validate(modification);
 181     }
 182
 183     DataTreeCandidate prepare(final DataTreeModification modification) throws DataValidationFailedException {
 184         return dataTree.prepare(modification);
 185     }
 186
 187     synchronized void commit(final DataTreeCandidate candidate) {
 188         dataTree.commit(candidate);
 189         changePublisher.publishChange(candidate);
 190     }
 191
 192     private static DataTreeConfiguration defaultConfig(final LogicalDatastoreType type) {
 193         return switch (type) {
 194             case CONFIGURATION -> DataTreeConfiguration.DEFAULT_CONFIGURATION;
 195             case OPERATIONAL -> DataTreeConfiguration.DEFAULT_OPERATIONAL;
 196         };
 197     }
 198 }