yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/tree/ModifiedNode.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.Verify.verifyNotNull;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.base.MoreObjects;
  14 import com.google.common.base.MoreObjects.ToStringHelper;
  15 import java.util.Collection;
  16 import java.util.Map;
  17 import java.util.Optional;
  18 import java.util.function.Predicate;
  19 import javax.annotation.concurrent.NotThreadSafe;
  20 import org.eclipse.jdt.annotation.NonNull;
  21 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.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.api.schema.tree.ModificationType;
  25 import org.opendaylight.yangtools.yang.data.api.schema.tree.StoreTreeNode;
  26 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.TreeNode;
  27 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.TreeNodeFactory;
  28 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.Version;
  29
  30 /**
  31  * Node Modification Node and Tree.
  32  *
  33  * <p>
  34  * Tree which structurally resembles data tree and captures client modifications to the data store tree. This tree is
  35  * lazily created and populated via {@link #modifyChild(PathArgument, ModificationApplyOperation, Version)} and
  36  * {@link TreeNode} which represents original state as tracked by {@link #getOriginal()}.
  37  *
  38  * <p>
  39  * The contract is that the state information exposed here preserves the temporal ordering of whatever modifications
  40  * were executed. A child's effects pertain to data node as modified by its ancestors. This means that in order to
  41  * reconstruct the effective data node presentation, it is sufficient to perform a depth-first pre-order traversal of
  42  * the tree.
  43  */
  44 @NotThreadSafe
  45 final class ModifiedNode extends NodeModification implements StoreTreeNode<ModifiedNode> {
  46     static final Predicate<ModifiedNode> IS_TERMINAL_PREDICATE = input -> {
  47         requireNonNull(input);
  48         switch (input.getOperation()) {
  49             case DELETE:
  50             case MERGE:
  51             case WRITE:
  52                 return true;
  53             case TOUCH:
  54             case NONE:
  55                 return false;
  56             default:
  57                 throw new IllegalArgumentException("Unhandled modification type " + input.getOperation());
  58         }
  59     };
  60
  61     private final Map<PathArgument, ModifiedNode> children;
  62     private final Optional<TreeNode> original;
  63     private final PathArgument identifier;
  64     private LogicalOperation operation = LogicalOperation.NONE;
  65     private Optional<TreeNode> snapshotCache;
  66     private NormalizedNode<?, ?> value;
  67     private ModificationType modType;
  68
  69     // Alternative history introduced in WRITE nodes. Instantiated when we touch any child underneath such a node.
  70     private TreeNode writtenOriginal;
  71
  72     // Internal cache for TreeNodes created as part of validation
  73     private ModificationApplyOperation validatedOp;
  74     private Optional<TreeNode> validatedCurrent;
  75     private Optional<TreeNode> validatedNode;
  76
  77     private ModifiedNode(final PathArgument identifier, final Optional<TreeNode> original,
  78             final ChildTrackingPolicy childPolicy) {
  79         this.identifier = identifier;
  80         this.original = original;
  81         this.children = childPolicy.createMap();
  82     }
  83
  84     @Override
  85     public PathArgument getIdentifier() {
  86         return identifier;
  87     }
  88
  89     @Override
  90     LogicalOperation getOperation() {
  91         return operation;
  92     }
  93
  94     @Override
  95     Optional<TreeNode> getOriginal() {
  96         return original;
  97     }
  98
  99     /**
 100      * Return the value which was written to this node. The returned object is only valid for
 101      * {@link LogicalOperation#MERGE} and {@link LogicalOperation#WRITE}.
 102      * operations. It should only be consulted when this modification is going to end up being
 103      * {@link ModificationType#WRITE}.
 104      *
 105      * @return Currently-written value
 106      */
 107     @NonNull NormalizedNode<?, ?> getWrittenValue() {
 108         return verifyNotNull(value);
 109     }
 110
 111     /**
 112      * Returns child modification if child was modified.
 113      *
 114      * @return Child modification if direct child or it's subtree was modified.
 115      */
 116     @Override
 117     public Optional<ModifiedNode> getChild(final PathArgument child) {
 118         return Optional.ofNullable(children.get(child));
 119     }
 120
 121     private Optional<TreeNode> metadataFromSnapshot(final @NonNull PathArgument child) {
 122         return original.isPresent() ? original.get().getChild(child) : Optional.empty();
 123     }
 124
 125     private Optional<TreeNode> metadataFromData(final @NonNull PathArgument child, final Version modVersion) {
 126         if (writtenOriginal == null) {
 127             // Lazy instantiation, as we do not want do this for all writes. We are using the modification's version
 128             // here, as that version is what the SchemaAwareApplyOperation will see when dealing with the resulting
 129             // modifications.
 130             writtenOriginal = TreeNodeFactory.createTreeNode(value, modVersion);
 131         }
 132
 133         return writtenOriginal.getChild(child);
 134     }
 135
 136     /**
 137      * Determine the base tree node we are going to apply the operation to. This is not entirely trivial because
 138      * both DELETE and WRITE operations unconditionally detach their descendants from the original snapshot, so we need
 139      * to take the current node's operation into account.
 140      *
 141      * @param child Child we are looking to modify
 142      * @param modVersion Version allocated by the calling {@link InMemoryDataTreeModification}
 143      * @return Before-image tree node as observed by that child.
 144      */
 145     private Optional<TreeNode> findOriginalMetadata(final @NonNull PathArgument child, final Version modVersion) {
 146         switch (operation) {
 147             case DELETE:
 148                 // DELETE implies non-presence
 149                 return Optional.empty();
 150             case NONE:
 151             case TOUCH:
 152             case MERGE:
 153                 return metadataFromSnapshot(child);
 154             case WRITE:
 155                 // WRITE implies presence based on written data
 156                 return metadataFromData(child, modVersion);
 157             default:
 158                 throw new IllegalStateException("Unhandled node operation " + operation);
 159         }
 160     }
 161
 162     /**
 163      * Returns child modification if child was modified, creates {@link ModifiedNode}
 164      * for child otherwise. If this node's {@link ModificationType} is {@link ModificationType#UNMODIFIED}
 165      * changes modification type to {@link ModificationType#SUBTREE_MODIFIED}.
 166      *
 167      * @param child child identifier, may not be null
 168      * @param childOper Child operation
 169      * @param modVersion Version allocated by the calling {@link InMemoryDataTreeModification}
 170      * @return {@link ModifiedNode} for specified child, with {@link #getOriginal()}
 171      *         containing child metadata if child was present in original data.
 172      */
 173     ModifiedNode modifyChild(final @NonNull PathArgument child, final @NonNull ModificationApplyOperation childOper,
 174             final @NonNull Version modVersion) {
 175         clearSnapshot();
 176         if (operation == LogicalOperation.NONE) {
 177             updateOperationType(LogicalOperation.TOUCH);
 178         }
 179         final ModifiedNode potential = children.get(child);
 180         if (potential != null) {
 181             return potential;
 182         }
 183
 184         final Optional<TreeNode> currentMetadata = findOriginalMetadata(child, modVersion);
 185
 186
 187         final ModifiedNode newlyCreated = new ModifiedNode(child, currentMetadata, childOper.getChildPolicy());
 188         if (operation == LogicalOperation.MERGE && value != null) {
 189             /*
 190              * We are attempting to modify a previously-unmodified part of a MERGE node. If the
 191              * value contains this component, we need to materialize it as a MERGE modification.
 192              */
 193             @SuppressWarnings({ "rawtypes", "unchecked" })
 194             final Optional<NormalizedNode<?, ?>> childData = ((NormalizedNodeContainer)value).getChild(child);
 195             if (childData.isPresent()) {
 196                 childOper.mergeIntoModifiedNode(newlyCreated, childData.get(), modVersion);
 197             }
 198         }
 199
 200         children.put(child, newlyCreated);
 201         return newlyCreated;
 202     }
 203
 204     /**
 205      * Returns all recorded direct child modifications.
 206      *
 207      * @return all recorded direct child modifications
 208      */
 209     @Override
 210     Collection<ModifiedNode> getChildren() {
 211         return children.values();
 212     }
 213
 214     /**
 215      * Records a delete for associated node.
 216      */
 217     void delete() {
 218         final LogicalOperation newType;
 219
 220         switch (operation) {
 221             case DELETE:
 222             case NONE:
 223                 // We need to record this delete.
 224                 newType = LogicalOperation.DELETE;
 225                 break;
 226             case MERGE:
 227                 // In case of merge - delete needs to be recored and must not to be changed into NONE, because lazy
 228                 // expansion of parent MERGE node would reintroduce it again.
 229                 newType = LogicalOperation.DELETE;
 230                 break;
 231             case TOUCH:
 232             case WRITE:
 233                 /*
 234                  * We are canceling a previous modification. This is a bit tricky, as the original write may have just
 235                  * introduced the data, or it may have modified it.
 236                  *
 237                  * As documented in BUG-2470, a delete of data introduced in this transaction needs to be turned into
 238                  * a no-op.
 239                  */
 240                 newType = original.isPresent() ? LogicalOperation.DELETE : LogicalOperation.NONE;
 241                 break;
 242             default:
 243                 throw new IllegalStateException("Unhandled deletion of node with " + operation);
 244         }
 245
 246         clearSnapshot();
 247         children.clear();
 248         this.value = null;
 249         updateOperationType(newType);
 250     }
 251
 252     /**
 253      * Records a write for associated node.
 254      *
 255      * @param newValue new value
 256      */
 257     void write(final NormalizedNode<?, ?> newValue) {
 258         updateValue(LogicalOperation.WRITE, newValue);
 259         children.clear();
 260     }
 261
 262     /**
 263      * Seal the modification node and prune any children which has not been modified.
 264      *
 265      * @param schema associated apply operation
 266      * @param version target version
 267      */
 268     void seal(final ModificationApplyOperation schema, final Version version) {
 269         clearSnapshot();
 270         writtenOriginal = null;
 271
 272         switch (operation) {
 273             case TOUCH:
 274                 // A TOUCH node without any children is a no-op
 275                 if (children.isEmpty()) {
 276                     updateOperationType(LogicalOperation.NONE);
 277                 }
 278                 break;
 279             case WRITE:
 280                 // A WRITE can collapse all of its children
 281                 if (!children.isEmpty()) {
 282                     value = schema.apply(this, getOriginal(), version).map(TreeNode::getData).orElse(null);
 283                     children.clear();
 284                 }
 285
 286                 if (value == null) {
 287                     // The write has ended up being empty, such as a write of an empty list.
 288                     updateOperationType(LogicalOperation.DELETE);
 289                 } else {
 290                     schema.fullVerifyStructure(value);
 291                 }
 292                 break;
 293             default:
 294                 break;
 295         }
 296     }
 297
 298     private void clearSnapshot() {
 299         snapshotCache = null;
 300     }
 301
 302     Optional<TreeNode> getSnapshot() {
 303         return snapshotCache;
 304     }
 305
 306     Optional<TreeNode> setSnapshot(final Optional<TreeNode> snapshot) {
 307         snapshotCache = requireNonNull(snapshot);
 308         return snapshot;
 309     }
 310
 311     void updateOperationType(final LogicalOperation type) {
 312         operation = type;
 313         modType = null;
 314
 315         // Make sure we do not reuse previously-instantiated data-derived metadata
 316         writtenOriginal = null;
 317         clearSnapshot();
 318     }
 319
 320     @Override
 321     public String toString() {
 322         final ToStringHelper helper = MoreObjects.toStringHelper(this).omitNullValues()
 323                 .add("identifier", identifier).add("operation", operation).add("modificationType", modType);
 324         if (!children.isEmpty()) {
 325             helper.add("childModification", children);
 326         }
 327         return helper.toString();
 328     }
 329
 330     void resolveModificationType(final @NonNull ModificationType type) {
 331         modType = type;
 332     }
 333
 334     /**
 335      * Update this node's value and operation type without disturbing any of its child modifications.
 336      *
 337      * @param type New operation type
 338      * @param newValue New node value
 339      */
 340     void updateValue(final LogicalOperation type, final NormalizedNode<?, ?> newValue) {
 341         this.value = requireNonNull(newValue);
 342         updateOperationType(type);
 343     }
 344
 345     /**
 346      * Return the physical modification done to data. May return null if the
 347      * operation has not been applied to the underlying tree. This is different
 348      * from the logical operation in that it can actually be a no-op if the
 349      * operation has no side-effects (like an empty merge on a container).
 350      *
 351      * @return Modification type.
 352      */
 353     ModificationType getModificationType() {
 354         return modType;
 355     }
 356
 357     public static ModifiedNode createUnmodified(final TreeNode metadataTree, final ChildTrackingPolicy childPolicy) {
 358         return new ModifiedNode(metadataTree.getIdentifier(), Optional.of(metadataTree), childPolicy);
 359     }
 360
 361     void setValidatedNode(final ModificationApplyOperation op, final Optional<TreeNode> current,
 362             final Optional<TreeNode> node) {
 363         this.validatedOp = requireNonNull(op);
 364         this.validatedCurrent = requireNonNull(current);
 365         this.validatedNode = requireNonNull(node);
 366     }
 367
 368     Optional<TreeNode> getValidatedNode(final ModificationApplyOperation op, final Optional<TreeNode> current) {
 369         return op.equals(validatedOp) && current.equals(validatedCurrent) ? validatedNode : null;
 370     }
 371 }