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.checkNotNull;
11 import static com.google.common.base.Preconditions.checkState;
12 import static org.opendaylight.controller.md.sal.dom.store.impl.StoreUtils.increase;
14 import java.util.Collections;
15 import java.util.concurrent.Callable;
16 import java.util.concurrent.atomic.AtomicLong;
17 import java.util.concurrent.atomic.AtomicReference;
19 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
20 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeListener;
21 import org.opendaylight.controller.md.sal.dom.store.impl.tree.ListenerTree;
22 import org.opendaylight.controller.md.sal.dom.store.impl.tree.ModificationType;
23 import org.opendaylight.controller.md.sal.dom.store.impl.tree.NodeModification;
24 import org.opendaylight.controller.md.sal.dom.store.impl.tree.StoreMetadataNode;
25 import org.opendaylight.controller.sal.core.spi.data.DOMStore;
26 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadTransaction;
27 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadWriteTransaction;
28 import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
29 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransaction;
30 import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction;
31 import org.opendaylight.yangtools.concepts.AbstractListenerRegistration;
32 import org.opendaylight.yangtools.concepts.Identifiable;
33 import org.opendaylight.yangtools.concepts.ListenerRegistration;
34 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier;
35 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.PathArgument;
36 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
37 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeUtils;
38 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
39 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
40 import org.slf4j.Logger;
41 import org.slf4j.LoggerFactory;
43 import com.google.common.base.Objects;
44 import com.google.common.base.Objects.ToStringHelper;
45 import com.google.common.base.Optional;
46 import com.google.common.base.Preconditions;
47 import com.google.common.primitives.UnsignedLong;
48 import com.google.common.util.concurrent.Futures;
49 import com.google.common.util.concurrent.ListenableFuture;
50 import com.google.common.util.concurrent.ListeningExecutorService;
52 public class InMemoryDOMDataStore implements DOMStore, Identifiable<String>, SchemaContextListener {
54 private static final Logger LOG = LoggerFactory.getLogger(InMemoryDOMDataStore.class);
55 private static final InstanceIdentifier PUBLIC_ROOT_PATH = InstanceIdentifier.builder().build();
58 private final ListeningExecutorService executor;
59 private final String name;
60 private final AtomicLong txCounter = new AtomicLong(0);
61 private final ListenerTree listenerTree;
62 private final AtomicReference<DataAndMetadataSnapshot> snapshot;
64 private ModificationApplyOperation operationTree;
66 private SchemaContext schemaContext;
68 public InMemoryDOMDataStore(final String name, final ListeningExecutorService executor) {
69 this.name = Preconditions.checkNotNull(name);
70 this.executor = Preconditions.checkNotNull(executor);
71 this.listenerTree = ListenerTree.create();
72 this.snapshot = new AtomicReference<DataAndMetadataSnapshot>(DataAndMetadataSnapshot.createEmpty());
73 this.operationTree = new AlwaysFailOperation();
77 public final String getIdentifier() {
82 public DOMStoreReadTransaction newReadOnlyTransaction() {
83 return new SnapshotBackedReadTransaction(nextIdentifier(), snapshot.get());
87 public DOMStoreReadWriteTransaction newReadWriteTransaction() {
88 return new SnapshotBackedReadWriteTransaction(nextIdentifier(), snapshot.get(), this, operationTree);
92 public DOMStoreWriteTransaction newWriteOnlyTransaction() {
93 return new SnaphostBackedWriteTransaction(nextIdentifier(), snapshot.get(), this, operationTree);
97 public synchronized void onGlobalContextUpdated(final SchemaContext ctx) {
98 operationTree = SchemaAwareApplyOperationRoot.from(ctx);
103 public <L extends AsyncDataChangeListener<InstanceIdentifier, NormalizedNode<?, ?>>> ListenerRegistration<L> registerChangeListener(
104 final InstanceIdentifier path, final L listener, final DataChangeScope scope) {
107 * Make sure commit is not occurring right now. Listener has to be registered and its
108 * state capture enqueued at a consistent point.
110 * FIXME: improve this to read-write lock, such that multiple listener registrations
111 * can occur simultaneously
113 final DataChangeListenerRegistration<L> reg;
114 synchronized (this) {
115 LOG.debug("{}: Registering data change listener {} for {}",name,listener,path);
117 reg = listenerTree.registerDataChangeListener(path, listener, scope);
119 Optional<StoreMetadataNode> currentState = snapshot.get().read(path);
120 if (currentState.isPresent()) {
121 final NormalizedNode<?, ?> data = currentState.get().getData();
123 final DOMImmutableDataChangeEvent event = DOMImmutableDataChangeEvent.builder(DataChangeScope.BASE) //
125 .addCreated(path, data) //
127 executor.submit(new ChangeListenerNotifyTask(Collections.singletonList(reg), event));
131 return new AbstractListenerRegistration<L>(listener) {
133 protected void removeRegistration() {
134 synchronized (InMemoryDOMDataStore.this) {
141 private synchronized DOMStoreThreePhaseCommitCohort submit(
142 final SnaphostBackedWriteTransaction writeTx) {
143 LOG.debug("Tx: {} is submitted. Modifications: {}",writeTx.getIdentifier(),writeTx.getMutatedView());
144 return new ThreePhaseCommitImpl(writeTx);
147 private Object nextIdentifier() {
148 return name + "-" + txCounter.getAndIncrement();
151 private void commit(final DataAndMetadataSnapshot currentSnapshot,
152 final StoreMetadataNode newDataTree, final ResolveDataChangeEventsTask listenerResolver) {
153 LOG.debug("Updating Store snaphot version: {} with version:{}",currentSnapshot.getMetadataTree().getSubtreeVersion(),newDataTree.getSubtreeVersion());
155 if(LOG.isTraceEnabled()) {
156 LOG.trace("Data Tree is {}",StoreUtils.toStringTree(newDataTree));
159 final DataAndMetadataSnapshot newSnapshot = DataAndMetadataSnapshot.builder() //
160 .setMetadataTree(newDataTree) //
161 .setSchemaContext(schemaContext) //
165 * The commit has to occur atomically with regard to listener registrations.
167 synchronized (this) {
168 final boolean success = snapshot.compareAndSet(currentSnapshot, newSnapshot);
169 checkState(success, "Store snapshot and transaction snapshot differ. This should never happen.");
171 for (ChangeListenerNotifyTask task : listenerResolver.call()) {
172 LOG.trace("Scheduling invocation of listeners: {}",task);
173 executor.submit(task);
178 private static abstract class AbstractDOMStoreTransaction implements DOMStoreTransaction {
179 private final Object identifier;
181 protected AbstractDOMStoreTransaction(final Object identifier) {
182 this.identifier = identifier;
186 public final Object getIdentifier() {
191 public final String toString() {
192 return addToStringAttributes(Objects.toStringHelper(this)).toString();
196 * Add class-specific toString attributes.
198 * @param toStringHelper ToStringHelper instance
199 * @return ToStringHelper instance which was passed in
201 protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
202 return toStringHelper.add("id", identifier);
206 private static class SnapshotBackedReadTransaction extends AbstractDOMStoreTransaction implements DOMStoreReadTransaction {
207 private DataAndMetadataSnapshot stableSnapshot;
209 public SnapshotBackedReadTransaction(final Object identifier, final DataAndMetadataSnapshot snapshot) {
211 this.stableSnapshot = Preconditions.checkNotNull(snapshot);
212 LOG.debug("ReadOnly Tx: {} allocated with snapshot {}", identifier, snapshot.getMetadataTree().getSubtreeVersion());
216 public void close() {
217 LOG.debug("Store transaction: {} : Closed", getIdentifier());
218 stableSnapshot = null;
222 public ListenableFuture<Optional<NormalizedNode<?, ?>>> read(final InstanceIdentifier path) {
223 checkNotNull(path, "Path must not be null.");
224 checkState(stableSnapshot != null, "Transaction is closed");
225 return Futures.immediateFuture(NormalizedNodeUtils.findNode(stableSnapshot.getDataTree(), path));
229 private static class SnaphostBackedWriteTransaction extends AbstractDOMStoreTransaction implements DOMStoreWriteTransaction {
230 private MutableDataTree mutableTree;
231 private InMemoryDOMDataStore store;
232 private boolean ready = false;
234 public SnaphostBackedWriteTransaction(final Object identifier, final DataAndMetadataSnapshot snapshot,
235 final InMemoryDOMDataStore store, final ModificationApplyOperation applyOper) {
237 mutableTree = MutableDataTree.from(snapshot, applyOper);
239 LOG.debug("Write Tx: {} allocated with snapshot {}",identifier,snapshot.getMetadataTree().getSubtreeVersion());
243 public void close() {
244 LOG.debug("Store transaction: {} : Closed", getIdentifier());
245 this.mutableTree = null;
250 public void write(final InstanceIdentifier path, final NormalizedNode<?, ?> data) {
253 LOG.trace("Tx: {} Write: {}:{}",getIdentifier(),path,data);
254 mutableTree.write(path, data);
255 // FIXME: Add checked exception
256 } catch (Exception e) {
257 LOG.error("Tx: {}, failed to write {}:{} in {}",getIdentifier(),path,data,mutableTree,e);
262 public void merge(final InstanceIdentifier path, final NormalizedNode<?, ?> data) {
265 LOG.trace("Tx: {} Merge: {}:{}",getIdentifier(),path,data);
266 mutableTree.merge(path, data);
267 // FIXME: Add checked exception
268 } catch (Exception e) {
269 LOG.error("Tx: {}, failed to write {}:{} in {}",getIdentifier(),path,data,mutableTree,e);
274 public void delete(final InstanceIdentifier path) {
277 LOG.trace("Tx: {} Delete: {}",getIdentifier(),path);
278 mutableTree.delete(path);
279 // FIXME: Add checked exception
280 } catch (Exception e) {
281 LOG.error("Tx: {}, failed to delete {} in {}",getIdentifier(),path,mutableTree,e);
285 protected final boolean isReady() {
289 protected final void checkNotReady() {
290 checkState(!ready, "Transaction %s is ready. No further modifications allowed.", getIdentifier());
294 public synchronized DOMStoreThreePhaseCommitCohort ready() {
295 checkState(!ready, "Transaction %s is already ready.", getIdentifier());
298 LOG.debug("Store transaction: {} : Ready", getIdentifier());
300 return store.submit(this);
303 protected MutableDataTree getMutatedView() {
308 protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
309 return toStringHelper.add("ready", isReady());
313 private static class SnapshotBackedReadWriteTransaction extends SnaphostBackedWriteTransaction implements
314 DOMStoreReadWriteTransaction {
316 protected SnapshotBackedReadWriteTransaction(final Object identifier, final DataAndMetadataSnapshot snapshot,
317 final InMemoryDOMDataStore store, final ModificationApplyOperation applyOper) {
318 super(identifier, snapshot, store, applyOper);
322 public ListenableFuture<Optional<NormalizedNode<?, ?>>> read(final InstanceIdentifier path) {
323 LOG.trace("Tx: {} Read: {}",getIdentifier(),path);
325 return Futures.immediateFuture(getMutatedView().read(path));
326 } catch (Exception e) {
327 LOG.error("Tx: {} Failed Read of {}",getIdentifier(),path,e);
333 private class ThreePhaseCommitImpl implements DOMStoreThreePhaseCommitCohort {
335 private final SnaphostBackedWriteTransaction transaction;
336 private final NodeModification modification;
338 private DataAndMetadataSnapshot storeSnapshot;
339 private Optional<StoreMetadataNode> proposedSubtree;
340 private ResolveDataChangeEventsTask listenerResolver;
342 public ThreePhaseCommitImpl(final SnaphostBackedWriteTransaction writeTransaction) {
343 this.transaction = writeTransaction;
344 this.modification = transaction.getMutatedView().getRootModification();
348 public ListenableFuture<Boolean> canCommit() {
349 final DataAndMetadataSnapshot snapshotCapture = snapshot.get();
350 final ModificationApplyOperation snapshotOperation = operationTree;
352 return executor.submit(new Callable<Boolean>() {
355 public Boolean call() throws Exception {
356 boolean applicable = snapshotOperation.isApplicable(modification,
357 Optional.of(snapshotCapture.getMetadataTree()));
358 LOG.debug("Store Transcation: {} : canCommit : {}", transaction.getIdentifier(), applicable);
365 public ListenableFuture<Void> preCommit() {
366 storeSnapshot = snapshot.get();
367 if(modification.getModificationType() == ModificationType.UNMODIFIED) {
368 return Futures.immediateFuture(null);
370 return executor.submit(new Callable<Void>() {
375 public Void call() throws Exception {
376 StoreMetadataNode metadataTree = storeSnapshot.getMetadataTree();
378 proposedSubtree = operationTree.apply(modification, Optional.of(metadataTree),
379 increase(metadataTree.getSubtreeVersion()));
381 listenerResolver = ResolveDataChangeEventsTask.create() //
382 .setRootPath(PUBLIC_ROOT_PATH) //
383 .setBeforeRoot(Optional.of(metadataTree)) //
384 .setAfterRoot(proposedSubtree) //
385 .setModificationRoot(modification) //
386 .setListenerRoot(listenerTree);
394 public ListenableFuture<Void> abort() {
395 storeSnapshot = null;
396 proposedSubtree = null;
397 return Futures.<Void> immediateFuture(null);
401 public ListenableFuture<Void> commit() {
402 if(modification.getModificationType() == ModificationType.UNMODIFIED) {
403 return Futures.immediateFuture(null);
406 checkState(proposedSubtree != null,"Proposed subtree must be computed");
407 checkState(storeSnapshot != null,"Proposed subtree must be computed");
408 // return ImmediateFuture<>;
409 InMemoryDOMDataStore.this.commit(storeSnapshot, proposedSubtree.get(),listenerResolver);
410 return Futures.<Void> immediateFuture(null);
415 private static final class AlwaysFailOperation implements ModificationApplyOperation {
418 public Optional<StoreMetadataNode> apply(final NodeModification modification,
419 final Optional<StoreMetadataNode> storeMeta, final UnsignedLong subtreeVersion) {
420 throw new IllegalStateException("Schema Context is not available.");
424 public boolean isApplicable(final NodeModification modification, final Optional<StoreMetadataNode> storeMetadata) {
425 throw new IllegalStateException("Schema Context is not available.");
429 public Optional<ModificationApplyOperation> getChild(final PathArgument child) {
430 throw new IllegalStateException("Schema Context is not available.");
434 public void verifyStructure(final NodeModification modification) throws IllegalArgumentException {
435 throw new IllegalStateException("Schema Context is not available.");