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 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 com.google.common.util.concurrent.ListeningExecutorService;
  16 import java.util.concurrent.Callable;
  17 import java.util.concurrent.ExecutorService;
  18 import java.util.concurrent.TimeUnit;
  19 import java.util.concurrent.atomic.AtomicLong;
  20 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
  21 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeListener;
  22 import org.opendaylight.controller.md.sal.common.api.data.OptimisticLockFailedException;
  23 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  24 import org.opendaylight.controller.md.sal.dom.store.impl.SnapshotBackedWriteTransaction.TransactionReadyPrototype;
  25 import org.opendaylight.controller.md.sal.dom.store.impl.tree.ListenerTree;
  26 import org.opendaylight.controller.sal.core.spi.data.DOMStore;
  27 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadTransaction;
  28 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadWriteTransaction;
  29 import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
  30 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionChain;
  31 import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction;
  32 import org.opendaylight.yangtools.concepts.AbstractListenerRegistration;
  33 import org.opendaylight.yangtools.concepts.Identifiable;
  34 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  35 import org.opendaylight.yangtools.util.ExecutorServiceUtil;
  36 import org.opendaylight.yangtools.util.concurrent.QueuedNotificationManager;
  37 import org.opendaylight.yangtools.util.concurrent.QueuedNotificationManager.Invoker;
  38 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  39 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  40 import org.opendaylight.yangtools.yang.data.api.schema.tree.ConflictingModificationAppliedException;
  41 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
  42 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
  43 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
  44 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeSnapshot;
  45 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
  46 import org.opendaylight.yangtools.yang.data.impl.schema.tree.InMemoryDataTreeFactory;
  47 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  48 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
  49 import org.slf4j.Logger;
  50 import org.slf4j.LoggerFactory;
  51
  52 /**
  53  * In-memory DOM Data Store
  54  *
  55  * Implementation of {@link DOMStore} which uses {@link DataTree} and other
  56  * classes such as {@link SnapshotBackedWriteTransaction}.
  57  * {@link SnapshotBackedReadTransaction} and {@link ResolveDataChangeEventsTask}
  58  * to implement {@link DOMStore} contract.
  59  *
  60  */
  61 public class InMemoryDOMDataStore extends TransactionReadyPrototype implements DOMStore, Identifiable<String>, SchemaContextListener, AutoCloseable {
  62     private static final Logger LOG = LoggerFactory.getLogger(InMemoryDOMDataStore.class);
  63     private static final ListenableFuture<Void> SUCCESSFUL_FUTURE = Futures.immediateFuture(null);
  64
  65     private static final Invoker<DataChangeListenerRegistration<?>, DOMImmutableDataChangeEvent> DCL_NOTIFICATION_MGR_INVOKER =
  66             new Invoker<DataChangeListenerRegistration<?>, DOMImmutableDataChangeEvent>() {
  67                 @Override
  68                 public void invokeListener(final DataChangeListenerRegistration<?> listener,
  69                                            final DOMImmutableDataChangeEvent notification ) {
  70                     final AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>> inst = listener.getInstance();
  71                     if (inst != null) {
  72                         inst.onDataChanged(notification);
  73                     }
  74                 }
  75             };
  76
  77     private final DataTree dataTree = InMemoryDataTreeFactory.getInstance().create();
  78     private final ListenerTree listenerTree = ListenerTree.create();
  79     private final AtomicLong txCounter = new AtomicLong(0);
  80
  81     private final QueuedNotificationManager<DataChangeListenerRegistration<?>, DOMImmutableDataChangeEvent> dataChangeListenerNotificationManager;
  82     private final ExecutorService dataChangeListenerExecutor;
  83     private final ListeningExecutorService commitExecutor;
  84     private final boolean debugTransactions;
  85     private final String name;
  86
  87     private volatile AutoCloseable closeable;
  88
  89     public InMemoryDOMDataStore(final String name, final ListeningExecutorService commitExecutor,
  90             final ExecutorService dataChangeListenerExecutor) {
  91         this(name, commitExecutor, dataChangeListenerExecutor,
  92              InMemoryDOMDataStoreConfigProperties.DEFAULT_MAX_DATA_CHANGE_LISTENER_QUEUE_SIZE, false);
  93     }
  94
  95     public InMemoryDOMDataStore(final String name, final ListeningExecutorService commitExecutor,
  96             final ExecutorService dataChangeListenerExecutor, final int maxDataChangeListenerQueueSize,
  97             final boolean debugTransactions) {
  98         this.name = Preconditions.checkNotNull(name);
  99         this.commitExecutor = Preconditions.checkNotNull(commitExecutor);
 100         this.dataChangeListenerExecutor = Preconditions.checkNotNull(dataChangeListenerExecutor);
 101         this.debugTransactions = debugTransactions;
 102
 103         dataChangeListenerNotificationManager =
 104                 new QueuedNotificationManager<>(this.dataChangeListenerExecutor,
 105                         DCL_NOTIFICATION_MGR_INVOKER, maxDataChangeListenerQueueSize,
 106                         "DataChangeListenerQueueMgr");
 107     }
 108
 109     public void setCloseable(final AutoCloseable closeable) {
 110         this.closeable = closeable;
 111     }
 112
 113     public QueuedNotificationManager<?, ?> getDataChangeListenerNotificationManager() {
 114         return dataChangeListenerNotificationManager;
 115     }
 116
 117     public ExecutorService getDomStoreExecutor() {
 118         return commitExecutor;
 119     }
 120
 121     @Override
 122     public final String getIdentifier() {
 123         return name;
 124     }
 125
 126     @Override
 127     public DOMStoreReadTransaction newReadOnlyTransaction() {
 128         return new SnapshotBackedReadTransaction(nextIdentifier(), debugTransactions, dataTree.takeSnapshot());
 129     }
 130
 131     @Override
 132     public DOMStoreReadWriteTransaction newReadWriteTransaction() {
 133         return new SnapshotBackedReadWriteTransaction(nextIdentifier(), debugTransactions, dataTree.takeSnapshot(), this);
 134     }
 135
 136     @Override
 137     public DOMStoreWriteTransaction newWriteOnlyTransaction() {
 138         return new SnapshotBackedWriteTransaction(nextIdentifier(), debugTransactions, dataTree.takeSnapshot(), this);
 139     }
 140
 141     @Override
 142     public DOMStoreTransactionChain createTransactionChain() {
 143         return new DOMStoreTransactionChainImpl(this);
 144     }
 145
 146     @Override
 147     public synchronized void onGlobalContextUpdated(final SchemaContext ctx) {
 148         dataTree.setSchemaContext(ctx);
 149     }
 150
 151     @Override
 152     public void close() {
 153         ExecutorServiceUtil.tryGracefulShutdown(commitExecutor, 30, TimeUnit.SECONDS);
 154         ExecutorServiceUtil.tryGracefulShutdown(dataChangeListenerExecutor, 30, TimeUnit.SECONDS);
 155
 156         if(closeable != null) {
 157             try {
 158                 closeable.close();
 159             } catch(Exception e) {
 160                 LOG.debug("Error closing instance", e);
 161             }
 162         }
 163     }
 164
 165     public final boolean getDebugTransactions() {
 166         return debugTransactions;
 167     }
 168
 169     final DataTreeSnapshot takeSnapshot() {
 170         return dataTree.takeSnapshot();
 171     }
 172
 173     @Override
 174     public <L extends AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>>> ListenerRegistration<L> registerChangeListener(
 175             final YangInstanceIdentifier path, final L listener, final DataChangeScope scope) {
 176
 177         /*
 178          * Make sure commit is not occurring right now. Listener has to be
 179          * registered and its state capture enqueued at a consistent point.
 180          *
 181          * FIXME: improve this to read-write lock, such that multiple listener
 182          * registrations can occur simultaneously
 183          */
 184         final DataChangeListenerRegistration<L> reg;
 185         synchronized (this) {
 186             LOG.debug("{}: Registering data change listener {} for {}", name, listener, path);
 187
 188             reg = listenerTree.registerDataChangeListener(path, listener, scope);
 189
 190             Optional<NormalizedNode<?, ?>> currentState = dataTree.takeSnapshot().readNode(path);
 191             if (currentState.isPresent()) {
 192                 final NormalizedNode<?, ?> data = currentState.get();
 193
 194                 final DOMImmutableDataChangeEvent event = DOMImmutableDataChangeEvent.builder(DataChangeScope.BASE) //
 195                         .setAfter(data) //
 196                         .addCreated(path, data) //
 197                         .build();
 198
 199                 dataChangeListenerNotificationManager.submitNotification(reg, event);
 200             }
 201         }
 202
 203         return new AbstractListenerRegistration<L>(listener) {
 204             @Override
 205             protected void removeRegistration() {
 206                 synchronized (InMemoryDOMDataStore.this) {
 207                     reg.close();
 208                 }
 209             }
 210         };
 211     }
 212
 213     @Override
 214     protected void transactionAborted(final SnapshotBackedWriteTransaction tx) {
 215         LOG.debug("Tx: {} is closed.", tx.getIdentifier());
 216     }
 217
 218     @Override
 219     protected DOMStoreThreePhaseCommitCohort transactionReady(final SnapshotBackedWriteTransaction tx, final DataTreeModification tree) {
 220         LOG.debug("Tx: {} is submitted. Modifications: {}", tx.getIdentifier(), tree);
 221         return new ThreePhaseCommitImpl(tx, tree);
 222     }
 223
 224     Object nextIdentifier() {
 225         return name + "-" + txCounter.getAndIncrement();
 226     }
 227
 228     private final class ThreePhaseCommitImpl implements DOMStoreThreePhaseCommitCohort {
 229         private final SnapshotBackedWriteTransaction transaction;
 230         private final DataTreeModification modification;
 231
 232         private ResolveDataChangeEventsTask listenerResolver;
 233         private DataTreeCandidate candidate;
 234
 235         public ThreePhaseCommitImpl(final SnapshotBackedWriteTransaction writeTransaction, final DataTreeModification modification) {
 236             this.transaction = writeTransaction;
 237             this.modification = modification;
 238         }
 239
 240         @Override
 241         public ListenableFuture<Boolean> canCommit() {
 242             return commitExecutor.submit(new Callable<Boolean>() {
 243                 @Override
 244                 public Boolean call() throws TransactionCommitFailedException {
 245                     try {
 246                         dataTree.validate(modification);
 247                         LOG.debug("Store Transaction: {} can be committed", transaction.getIdentifier());
 248                         return true;
 249                     } catch (ConflictingModificationAppliedException e) {
 250                         LOG.warn("Store Tx: {} Conflicting modification for {}.", transaction.getIdentifier(),
 251                                 e.getPath());
 252                         transaction.warnDebugContext(LOG);
 253                         throw new OptimisticLockFailedException("Optimistic lock failed.",e);
 254                     } catch (DataValidationFailedException e) {
 255                         LOG.warn("Store Tx: {} Data Precondition failed for {}.", transaction.getIdentifier(),
 256                                 e.getPath(), e);
 257                         transaction.warnDebugContext(LOG);
 258                         throw new TransactionCommitFailedException("Data did not pass validation.",e);
 259                     }
 260                 }
 261             });
 262         }
 263
 264         @Override
 265         public ListenableFuture<Void> preCommit() {
 266             return commitExecutor.submit(new Callable<Void>() {
 267                 @Override
 268                 public Void call() {
 269                     candidate = dataTree.prepare(modification);
 270                     listenerResolver = ResolveDataChangeEventsTask.create(candidate, listenerTree);
 271                     return null;
 272                 }
 273             });
 274         }
 275
 276         @Override
 277         public ListenableFuture<Void> abort() {
 278             candidate = null;
 279             return SUCCESSFUL_FUTURE;
 280         }
 281
 282         @Override
 283         public ListenableFuture<Void> commit() {
 284             checkState(candidate != null, "Proposed subtree must be computed");
 285
 286             /*
 287              * The commit has to occur atomically with regard to listener
 288              * registrations.
 289              */
 290             synchronized (InMemoryDOMDataStore.this) {
 291                 dataTree.commit(candidate);
 292                 listenerResolver.resolve(dataChangeListenerNotificationManager);
 293             }
 294
 295             return SUCCESSFUL_FUTURE;
 296         }
 297     }
 298 }