opendaylight/md-sal/sal-dom-broker/src/main/java/org/opendaylight/controller/md/sal/dom/store/impl/tree/data/InMemoryDataTreeModification.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.tree.data;
   9
  10 import static com.google.common.base.Preconditions.checkState;
  11
  12 import java.util.Map.Entry;
  13 import java.util.concurrent.atomic.AtomicIntegerFieldUpdater;
  14
  15 import org.opendaylight.controller.md.sal.dom.store.impl.OperationWithModification;
  16 import org.opendaylight.controller.md.sal.dom.store.impl.tree.DataTreeModification;
  17 import org.opendaylight.controller.md.sal.dom.store.impl.tree.ModificationApplyOperation;
  18 import org.opendaylight.controller.md.sal.dom.store.impl.tree.StoreUtils;
  19 import org.opendaylight.controller.md.sal.dom.store.impl.tree.TreeNodeUtils;
  20 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier;
  21 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.PathArgument;
  22 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  23 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
  24 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeUtils;
  25 import org.slf4j.Logger;
  26 import org.slf4j.LoggerFactory;
  27
  28 import com.google.common.base.Optional;
  29 import com.google.common.base.Preconditions;
  30
  31 final class InMemoryDataTreeModification implements DataTreeModification {
  32     private static final Logger LOG = LoggerFactory.getLogger(InMemoryDataTreeModification.class);
  33
  34     /*
  35      * FIXME: the thread safety of concurrent write/delete/read/seal operations
  36      *        needs to be evaluated.
  37      */
  38     private static final AtomicIntegerFieldUpdater<InMemoryDataTreeModification> SEALED_UPDATER =
  39             AtomicIntegerFieldUpdater.newUpdater(InMemoryDataTreeModification.class, "sealed");
  40     private volatile int sealed = 0;
  41
  42     private final ModificationApplyOperation strategyTree;
  43     private final InMemoryDataTreeSnapshot snapshot;
  44     private final NodeModification rootNode;
  45
  46     InMemoryDataTreeModification(final InMemoryDataTreeSnapshot snapshot, final ModificationApplyOperation resolver) {
  47         this.snapshot = Preconditions.checkNotNull(snapshot);
  48         this.strategyTree = Preconditions.checkNotNull(resolver);
  49         this.rootNode = NodeModification.createUnmodified(snapshot.getRootNode());
  50     }
  51
  52     NodeModification getRootModification() {
  53         return rootNode;
  54     }
  55
  56         ModificationApplyOperation getStrategy() {
  57                 return strategyTree;
  58         }
  59
  60     @Override
  61         public void write(final InstanceIdentifier path, final NormalizedNode<?, ?> value) {
  62         checkSealed();
  63         resolveModificationFor(path).write(value);
  64     }
  65
  66     @Override
  67         public void merge(final InstanceIdentifier path, final NormalizedNode<?, ?> data) {
  68         checkSealed();
  69         mergeImpl(resolveModificationFor(path),data);
  70     }
  71
  72     private void mergeImpl(final OperationWithModification op,final NormalizedNode<?,?> data) {
  73
  74         if(data instanceof NormalizedNodeContainer<?,?,?>) {
  75             @SuppressWarnings({ "rawtypes", "unchecked" })
  76             NormalizedNodeContainer<?,?,NormalizedNode<PathArgument, ?>> dataContainer = (NormalizedNodeContainer) data;
  77             for(NormalizedNode<PathArgument, ?> child : dataContainer.getValue()) {
  78                 PathArgument childId = child.getIdentifier();
  79                 mergeImpl(op.forChild(childId), child);
  80             }
  81         }
  82         op.merge(data);
  83     }
  84
  85     @Override
  86         public void delete(final InstanceIdentifier path) {
  87         checkSealed();
  88         resolveModificationFor(path).delete();
  89     }
  90
  91     @Override
  92         public Optional<NormalizedNode<?, ?>> readNode(final InstanceIdentifier path) {
  93         Entry<InstanceIdentifier, NodeModification> modification = TreeNodeUtils.findClosestsOrFirstMatch(rootNode, path, NodeModification.IS_TERMINAL_PREDICATE);
  94
  95         Optional<StoreMetadataNode> result = resolveSnapshot(modification);
  96         if (result.isPresent()) {
  97             NormalizedNode<?, ?> data = result.get().getData();
  98             return NormalizedNodeUtils.findNode(modification.getKey(), data, path);
  99         }
 100         return Optional.absent();
 101     }
 102
 103     private Optional<StoreMetadataNode> resolveSnapshot(
 104             final Entry<InstanceIdentifier, NodeModification> keyModification) {
 105         InstanceIdentifier path = keyModification.getKey();
 106         NodeModification modification = keyModification.getValue();
 107         return resolveSnapshot(path, modification);
 108     }
 109
 110     private Optional<StoreMetadataNode> resolveSnapshot(final InstanceIdentifier path,
 111             final NodeModification modification) {
 112         try {
 113             Optional<Optional<StoreMetadataNode>> potentialSnapshot = modification.getSnapshotCache();
 114             if(potentialSnapshot.isPresent()) {
 115                 return potentialSnapshot.get();
 116             }
 117             return resolveModificationStrategy(path).apply(modification, modification.getOriginal(),
 118                     StoreUtils.increase(snapshot.getRootNode().getSubtreeVersion()));
 119         } catch (Exception e) {
 120             LOG.error("Could not create snapshot for {}:{}", path,modification,e);
 121             throw e;
 122         }
 123     }
 124
 125     private ModificationApplyOperation resolveModificationStrategy(final InstanceIdentifier path) {
 126         LOG.trace("Resolving modification apply strategy for {}", path);
 127         return TreeNodeUtils.findNodeChecked(strategyTree, path);
 128     }
 129
 130     private OperationWithModification resolveModificationFor(final InstanceIdentifier path) {
 131         NodeModification modification = rootNode;
 132         // We ensure strategy is present.
 133         ModificationApplyOperation operation = resolveModificationStrategy(path);
 134         for (PathArgument pathArg : path.getPath()) {
 135             modification = modification.modifyChild(pathArg);
 136         }
 137         return OperationWithModification.from(operation, modification);
 138     }
 139
 140     @Override
 141         public void seal() {
 142         final boolean success = SEALED_UPDATER.compareAndSet(this, 0, 1);
 143         Preconditions.checkState(success, "Attempted to seal an already-sealed Data Tree.");
 144         rootNode.seal();
 145     }
 146
 147     private void checkSealed() {
 148         checkState(sealed == 0, "Data Tree is sealed. No further modifications allowed.");
 149     }
 150
 151     @Override
 152     public String toString() {
 153         return "MutableDataTree [modification=" + rootNode + "]";
 154     }
 155
 156         @Override
 157         public DataTreeModification newModification(ModificationApplyOperation applyOper) {
 158         // FIXME: transaction chaining
 159         throw new UnsupportedOperationException("Implement this as part of transaction chaining");
 160         }
 161 }