yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/tree/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.yangtools.yang.data.impl.schema.tree;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static com.google.common.base.Preconditions.checkState;
  12 import static java.util.Objects.requireNonNull;
  13
  14 import java.lang.invoke.MethodHandles;
  15 import java.lang.invoke.VarHandle;
  16 import java.util.Collection;
  17 import java.util.Map.Entry;
  18 import java.util.Optional;
  19 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  20 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  21 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  22 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodes;
  23 import org.opendaylight.yangtools.yang.data.api.schema.tree.CursorAwareDataTreeModification;
  24 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModificationCursor;
  25 import org.opendaylight.yangtools.yang.data.api.schema.tree.StoreTreeNodes;
  26 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.TreeNode;
  27 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.Version;
  28 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  29 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContextProvider;
  30 import org.slf4j.Logger;
  31 import org.slf4j.LoggerFactory;
  32
  33 final class InMemoryDataTreeModification extends AbstractCursorAware implements CursorAwareDataTreeModification,
  34         EffectiveModelContextProvider {
  35     private static final Logger LOG = LoggerFactory.getLogger(InMemoryDataTreeModification.class);
  36
  37     private final RootApplyStrategy strategyTree;
  38     private final InMemoryDataTreeSnapshot snapshot;
  39     private final ModifiedNode rootNode;
  40     private final Version version;
  41
  42     private static final VarHandle SEALED;
  43
  44     static {
  45         try {
  46             SEALED = MethodHandles.lookup().findVarHandle(InMemoryDataTreeModification.class, "sealed", int.class);
  47         } catch (ReflectiveOperationException e) {
  48             throw new ExceptionInInitializerError(e);
  49         }
  50     }
  51
  52     // All access needs to go through this handle
  53     @SuppressWarnings("unused")
  54     private volatile int sealed;
  55
  56     InMemoryDataTreeModification(final InMemoryDataTreeSnapshot snapshot,
  57             final RootApplyStrategy resolver) {
  58         this.snapshot = requireNonNull(snapshot);
  59         this.strategyTree = requireNonNull(resolver).snapshot();
  60         this.rootNode = ModifiedNode.createUnmodified(snapshot.getRootNode(), getStrategy().getChildPolicy());
  61
  62         /*
  63          * We could allocate version beforehand, since Version contract
  64          * states two allocated version must be always different.
  65          *
  66          * Preallocating version simplifies scenarios such as
  67          * chaining of modifications, since version for particular
  68          * node in modification and in data tree (if successfully
  69          * committed) will be same and will not change.
  70          */
  71         this.version = snapshot.getRootNode().getSubtreeVersion().next();
  72     }
  73
  74     ModifiedNode getRootModification() {
  75         return rootNode;
  76     }
  77
  78     ModificationApplyOperation getStrategy() {
  79         final ModificationApplyOperation ret = strategyTree.delegate();
  80         if (ret == null) {
  81             throw new IllegalStateException("Schema Context is not available.");
  82         }
  83         return ret;
  84     }
  85
  86     @Override
  87     public EffectiveModelContext getEffectiveModelContext() {
  88         return snapshot.getEffectiveModelContext();
  89     }
  90
  91     @Override
  92     public void write(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
  93         checkSealed();
  94         checkIdentifierReferencesData(path, data);
  95         resolveModificationFor(path).write(data);
  96     }
  97
  98     @Override
  99     public void merge(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
 100         checkSealed();
 101         checkIdentifierReferencesData(path, data);
 102         resolveModificationFor(path).merge(data, version);
 103     }
 104
 105     @Override
 106     public void delete(final YangInstanceIdentifier path) {
 107         checkSealed();
 108
 109         resolveModificationFor(path).delete();
 110     }
 111
 112     @Override
 113     public Optional<NormalizedNode<?, ?>> readNode(final YangInstanceIdentifier path) {
 114         /*
 115          * Walk the tree from the top, looking for the first node between root and
 116          * the requested path which has been modified. If no such node exists,
 117          * we use the node itself.
 118          */
 119         final Entry<YangInstanceIdentifier, ModifiedNode> entry = StoreTreeNodes.findClosestsOrFirstMatch(rootNode,
 120             path, ModifiedNode.IS_TERMINAL_PREDICATE);
 121         final YangInstanceIdentifier key = entry.getKey();
 122         final ModifiedNode mod = entry.getValue();
 123
 124         final Optional<? extends TreeNode> result = resolveSnapshot(key, mod);
 125         if (result.isPresent()) {
 126             final NormalizedNode<?, ?> data = result.get().getData();
 127             return NormalizedNodes.findNode(key, data, path);
 128         }
 129
 130         return Optional.empty();
 131     }
 132
 133     @SuppressWarnings("checkstyle:illegalCatch")
 134     private Optional<? extends TreeNode> resolveSnapshot(final YangInstanceIdentifier path,
 135             final ModifiedNode modification) {
 136         final Optional<? extends TreeNode> potentialSnapshot = modification.getSnapshot();
 137         if (potentialSnapshot != null) {
 138             return potentialSnapshot;
 139         }
 140
 141         try {
 142             return resolveModificationStrategy(path).apply(modification, modification.getOriginal(), version);
 143         } catch (final Exception e) {
 144             LOG.error("Could not create snapshot for {}:{}", path, modification, e);
 145             throw e;
 146         }
 147     }
 148
 149     void upgradeIfPossible() {
 150         if (rootNode.getOperation() == LogicalOperation.NONE) {
 151             strategyTree.upgradeIfPossible();
 152         }
 153     }
 154
 155     private ModificationApplyOperation resolveModificationStrategy(final YangInstanceIdentifier path) {
 156         LOG.trace("Resolving modification apply strategy for {}", path);
 157
 158         upgradeIfPossible();
 159         return StoreTreeNodes.findNodeChecked(getStrategy(), path);
 160     }
 161
 162     private OperationWithModification resolveModificationFor(final YangInstanceIdentifier path) {
 163         upgradeIfPossible();
 164
 165         /*
 166          * Walk the strategy and modification trees in-sync, creating modification nodes as needed.
 167          *
 168          * If the user has provided wrong input, we may end up with a bunch of TOUCH nodes present
 169          * ending with an empty one, as we will throw the exception below. This fact could end up
 170          * being a problem, as we'd have bunch of phantom operations.
 171          *
 172          * That is fine, as we will prune any empty TOUCH nodes in the last phase of the ready
 173          * process.
 174          */
 175         ModificationApplyOperation operation = getStrategy();
 176         ModifiedNode modification = rootNode;
 177
 178         int depth = 1;
 179         for (final PathArgument pathArg : path.getPathArguments()) {
 180             final Optional<ModificationApplyOperation> potential = operation.getChild(pathArg);
 181             if (!potential.isPresent()) {
 182                 throw new SchemaValidationFailedException(String.format("Child %s is not present in schema tree.",
 183                         path.getAncestor(depth)));
 184             }
 185             operation = potential.get();
 186             ++depth;
 187
 188             modification = modification.modifyChild(pathArg, operation, version);
 189         }
 190
 191         return OperationWithModification.from(operation, modification);
 192     }
 193
 194     private void checkSealed() {
 195         checkState(!isSealed(), "Data Tree is sealed. No further modifications allowed.");
 196     }
 197
 198     @Override
 199     public String toString() {
 200         return "MutableDataTree [modification=" + rootNode + "]";
 201     }
 202
 203     @Override
 204     public InMemoryDataTreeModification newModification() {
 205         checkState(isSealed(), "Attempted to chain on an unsealed modification");
 206
 207         if (rootNode.getOperation() == LogicalOperation.NONE) {
 208             // Simple fast case: just use the underlying modification
 209             return snapshot.newModification();
 210         }
 211
 212         /*
 213          * We will use preallocated version, this means returned snapshot will
 214          * have same version each time this method is called.
 215          */
 216         final TreeNode originalSnapshotRoot = snapshot.getRootNode();
 217         final Optional<? extends TreeNode> tempRoot = getStrategy().apply(rootNode, Optional.of(originalSnapshotRoot),
 218             version);
 219         checkState(tempRoot.isPresent(), "Data tree root is not present, possibly removed by previous modification");
 220
 221         final InMemoryDataTreeSnapshot tempTree = new InMemoryDataTreeSnapshot(snapshot.getEffectiveModelContext(),
 222             tempRoot.get(), strategyTree);
 223         return tempTree.newModification();
 224     }
 225
 226     Version getVersion() {
 227         return version;
 228     }
 229
 230     boolean isSealed() {
 231         // a quick check, synchronizes *only* on the sealed field
 232         return (int) SEALED.getAcquire(this) != 0;
 233     }
 234
 235     private static void applyChildren(final DataTreeModificationCursor cursor, final ModifiedNode node) {
 236         final Collection<ModifiedNode> children = node.getChildren();
 237         if (!children.isEmpty()) {
 238             cursor.enter(node.getIdentifier());
 239             for (final ModifiedNode child : children) {
 240                 applyNode(cursor, child);
 241             }
 242             cursor.exit();
 243         }
 244     }
 245
 246     private static void applyNode(final DataTreeModificationCursor cursor, final ModifiedNode node) {
 247         switch (node.getOperation()) {
 248             case NONE:
 249                 break;
 250             case DELETE:
 251                 cursor.delete(node.getIdentifier());
 252                 break;
 253             case MERGE:
 254                 cursor.merge(node.getIdentifier(), node.getWrittenValue());
 255                 applyChildren(cursor, node);
 256                 break;
 257             case TOUCH:
 258                 // TODO: we could improve efficiency of cursor use if we could understand
 259                 //       nested TOUCH operations. One way of achieving that would be a proxy
 260                 //       cursor, which would keep track of consecutive enter and exit calls
 261                 //       and coalesce them.
 262                 applyChildren(cursor, node);
 263                 break;
 264             case WRITE:
 265                 cursor.write(node.getIdentifier(), node.getWrittenValue());
 266                 applyChildren(cursor, node);
 267                 break;
 268             default:
 269                 throw new IllegalArgumentException("Unhandled node operation " + node.getOperation());
 270         }
 271     }
 272
 273     @Override
 274     public void applyToCursor(final DataTreeModificationCursor cursor) {
 275         for (final ModifiedNode child : rootNode.getChildren()) {
 276             applyNode(cursor, child);
 277         }
 278     }
 279
 280     static void checkIdentifierReferencesData(final PathArgument arg, final NormalizedNode<?, ?> data) {
 281         checkArgument(arg.equals(data.getIdentifier()),
 282             "Instance identifier references %s but data identifier is %s", arg, data.getIdentifier());
 283     }
 284
 285     private void checkIdentifierReferencesData(final YangInstanceIdentifier path,
 286             final NormalizedNode<?, ?> data) {
 287         final PathArgument arg;
 288
 289         if (!path.isEmpty()) {
 290             arg = path.getLastPathArgument();
 291             checkArgument(arg != null, "Instance identifier %s has invalid null path argument", path);
 292         } else {
 293             arg = rootNode.getIdentifier();
 294         }
 295
 296         checkIdentifierReferencesData(arg, data);
 297     }
 298
 299     @Override
 300     public Optional<DataTreeModificationCursor> openCursor(final YangInstanceIdentifier path) {
 301         final OperationWithModification op = resolveModificationFor(path);
 302         return Optional.of(openCursor(new InMemoryDataTreeModificationCursor(this, path, op)));
 303     }
 304
 305     @Override
 306     public void ready() {
 307         // We want a full CAS with setVolatile() memory semantics, as we want to force happen-before
 308         // for everything, including whatever user code works.
 309         final boolean wasRunning = SEALED.compareAndSet(this, 0, 1);
 310         checkState(wasRunning, "Attempted to seal an already-sealed Data Tree.");
 311
 312         AbstractReadyIterator current = AbstractReadyIterator.create(rootNode, getStrategy());
 313         do {
 314             current = current.process(version);
 315         } while (current != null);
 316     }
 317 }