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 edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  16 import java.util.Collection;
  17 import java.util.Map;
  18 import java.util.Optional;
  19 import java.util.function.Predicate;
  20 import org.eclipse.jdt.annotation.NonNull;
  21 import org.eclipse.jdt.annotation.Nullable;
  22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  23 import org.opendaylight.yangtools.yang.data.api.schema.DistinctNodeContainer;
  24 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  25 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType;
  26 import org.opendaylight.yangtools.yang.data.api.schema.tree.StoreTreeNode;
  27 import org.opendaylight.yangtools.yang.data.spi.tree.TreeNode;
  28 import org.opendaylight.yangtools.yang.data.spi.tree.TreeNodeFactory;
  29 import org.opendaylight.yangtools.yang.data.spi.tree.Version;
  30
  31 /**
  32  * Node Modification Node and Tree.
  33  *
  34  * <p>
  35  * Tree which structurally resembles data tree and captures client modifications to the data store tree. This tree is
  36  * lazily created and populated via {@link #modifyChild(PathArgument, ModificationApplyOperation, Version)} and
  37  * {@link TreeNode} which represents original state as tracked by {@link #getOriginal()}.
  38  *
  39  * <p>
  40  * The contract is that the state information exposed here preserves the temporal ordering of whatever modifications
  41  * were executed. A child's effects pertain to data node as modified by its ancestors. This means that in order to
  42  * reconstruct the effective data node presentation, it is sufficient to perform a depth-first pre-order traversal of
  43  * the tree.
  44  */
  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<? extends 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<? extends TreeNode> validatedCurrent;
  75     private Optional<? extends TreeNode> validatedNode;
  76
  77     private ModifiedNode(final PathArgument identifier, final Optional<? extends 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<? extends 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 ModifiedNode childByArg(final PathArgument arg) {
 118         return children.get(arg);
 119     }
 120
 121     private Optional<? extends TreeNode> metadataFromSnapshot(final @NonNull PathArgument child) {
 122         return original.isPresent() ? original.get().findChildByArg(child) : Optional.empty();
 123     }
 124
 125     private Optional<? extends 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.findChildByArg(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<? extends TreeNode> findOriginalMetadata(final @NonNull PathArgument child,
 146             final Version modVersion) {
 147         switch (operation) {
 148             case DELETE:
 149                 // DELETE implies non-presence
 150                 return Optional.empty();
 151             case NONE:
 152             case TOUCH:
 153             case MERGE:
 154                 return metadataFromSnapshot(child);
 155             case WRITE:
 156                 // WRITE implies presence based on written data
 157                 return metadataFromData(child, modVersion);
 158             default:
 159                 throw new IllegalStateException("Unhandled node operation " + operation);
 160         }
 161     }
 162
 163     /**
 164      * Returns child modification if child was modified, creates {@link ModifiedNode}
 165      * for child otherwise. If this node's {@link ModificationType} is {@link ModificationType#UNMODIFIED}
 166      * changes modification type to {@link ModificationType#SUBTREE_MODIFIED}.
 167      *
 168      * @param child child identifier, may not be null
 169      * @param childOper Child operation
 170      * @param modVersion Version allocated by the calling {@link InMemoryDataTreeModification}
 171      * @return {@link ModifiedNode} for specified child, with {@link #getOriginal()}
 172      *         containing child metadata if child was present in original data.
 173      */
 174     ModifiedNode modifyChild(final @NonNull PathArgument child, final @NonNull ModificationApplyOperation childOper,
 175             final @NonNull Version modVersion) {
 176         clearSnapshot();
 177         if (operation == LogicalOperation.NONE) {
 178             updateOperationType(LogicalOperation.TOUCH);
 179         }
 180         final ModifiedNode potential = children.get(child);
 181         if (potential != null) {
 182             return potential;
 183         }
 184
 185         final Optional<? extends TreeNode> currentMetadata = findOriginalMetadata(child, modVersion);
 186         final ModifiedNode newlyCreated = new ModifiedNode(child, currentMetadata, childOper.getChildPolicy());
 187         if (operation == LogicalOperation.MERGE && value != null) {
 188             /*
 189              * We are attempting to modify a previously-unmodified part of a MERGE node. If the
 190              * value contains this component, we need to materialize it as a MERGE modification.
 191              */
 192             @SuppressWarnings({ "rawtypes", "unchecked" })
 193             final NormalizedNode childData = ((DistinctNodeContainer)value).childByArg(child);
 194             if (childData != null) {
 195                 childOper.mergeIntoModifiedNode(newlyCreated, childData, modVersion);
 196             }
 197         }
 198
 199         children.put(child, newlyCreated);
 200         return newlyCreated;
 201     }
 202
 203     /**
 204      * Returns all recorded direct child modifications.
 205      *
 206      * @return all recorded direct child modifications
 207      */
 208     @Override
 209     Collection<ModifiedNode> getChildren() {
 210         return children.values();
 211     }
 212
 213     /**
 214      * Records a delete for associated node.
 215      */
 216     void delete() {
 217         final LogicalOperation newType;
 218
 219         switch (operation) {
 220             case DELETE:
 221             case NONE:
 222                 // We need to record this delete.
 223                 newType = LogicalOperation.DELETE;
 224                 break;
 225             case MERGE:
 226                 // In case of merge - delete needs to be recored and must not to be changed into NONE, because lazy
 227                 // expansion of parent MERGE node would reintroduce it again.
 228                 newType = LogicalOperation.DELETE;
 229                 break;
 230             case TOUCH:
 231             case WRITE:
 232                 /*
 233                  * We are canceling a previous modification. This is a bit tricky, as the original write may have just
 234                  * introduced the data, or it may have modified it.
 235                  *
 236                  * As documented in BUG-2470, a delete of data introduced in this transaction needs to be turned into
 237                  * a no-op.
 238                  */
 239                 newType = original.isPresent() ? LogicalOperation.DELETE : LogicalOperation.NONE;
 240                 break;
 241             default:
 242                 throw new IllegalStateException("Unhandled deletion of node with " + operation);
 243         }
 244
 245         clearSnapshot();
 246         children.clear();
 247         this.value = null;
 248         updateOperationType(newType);
 249     }
 250
 251     /**
 252      * Records a write for associated node.
 253      *
 254      * @param newValue new value
 255      */
 256     void write(final NormalizedNode newValue) {
 257         updateValue(LogicalOperation.WRITE, newValue);
 258         children.clear();
 259     }
 260
 261     /**
 262      * Seal the modification node and prune any children which has not been modified.
 263      *
 264      * @param schema associated apply operation
 265      * @param version target version
 266      */
 267     void seal(final ModificationApplyOperation schema, final Version version) {
 268         clearSnapshot();
 269         writtenOriginal = null;
 270
 271         switch (operation) {
 272             case TOUCH:
 273                 // A TOUCH node without any children is a no-op
 274                 if (children.isEmpty()) {
 275                     updateOperationType(LogicalOperation.NONE);
 276                 }
 277                 break;
 278             case WRITE:
 279                 // A WRITE can collapse all of its children
 280                 if (!children.isEmpty()) {
 281                     value = schema.apply(this, getOriginal(), version).map(TreeNode::getData).orElse(null);
 282                     children.clear();
 283                 }
 284
 285                 if (value == null) {
 286                     // The write has ended up being empty, such as a write of an empty list.
 287                     updateOperationType(LogicalOperation.DELETE);
 288                 } else {
 289                     schema.fullVerifyStructure(value);
 290                 }
 291                 break;
 292             default:
 293                 break;
 294         }
 295     }
 296
 297     private void clearSnapshot() {
 298         snapshotCache = null;
 299     }
 300
 301     Optional<TreeNode> getSnapshot() {
 302         return snapshotCache;
 303     }
 304
 305     Optional<TreeNode> setSnapshot(final Optional<TreeNode> snapshot) {
 306         snapshotCache = requireNonNull(snapshot);
 307         return snapshot;
 308     }
 309
 310     void updateOperationType(final LogicalOperation type) {
 311         operation = type;
 312         modType = null;
 313
 314         // Make sure we do not reuse previously-instantiated data-derived metadata
 315         writtenOriginal = null;
 316         clearSnapshot();
 317     }
 318
 319     @Override
 320     public String toString() {
 321         final ToStringHelper helper = MoreObjects.toStringHelper(this).omitNullValues()
 322                 .add("identifier", identifier).add("operation", operation).add("modificationType", modType);
 323         if (!children.isEmpty()) {
 324             helper.add("childModification", children);
 325         }
 326         return helper.toString();
 327     }
 328
 329     void resolveModificationType(final @NonNull ModificationType type) {
 330         modType = type;
 331     }
 332
 333     /**
 334      * Update this node's value and operation type without disturbing any of its child modifications.
 335      *
 336      * @param type New operation type
 337      * @param newValue New node value
 338      */
 339     void updateValue(final LogicalOperation type, final NormalizedNode newValue) {
 340         this.value = requireNonNull(newValue);
 341         updateOperationType(type);
 342     }
 343
 344     /**
 345      * Return the physical modification done to data. May return null if the
 346      * operation has not been applied to the underlying tree. This is different
 347      * from the logical operation in that it can actually be a no-op if the
 348      * operation has no side-effects (like an empty merge on a container).
 349      *
 350      * @return Modification type.
 351      */
 352     ModificationType getModificationType() {
 353         return modType;
 354     }
 355
 356     public static ModifiedNode createUnmodified(final TreeNode metadataTree, final ChildTrackingPolicy childPolicy) {
 357         return new ModifiedNode(metadataTree.getIdentifier(), Optional.of(metadataTree), childPolicy);
 358     }
 359
 360     void setValidatedNode(final ModificationApplyOperation op, final Optional<? extends TreeNode> current,
 361             final Optional<? extends TreeNode> node) {
 362         this.validatedOp = requireNonNull(op);
 363         this.validatedCurrent = requireNonNull(current);
 364         this.validatedNode = requireNonNull(node);
 365     }
 366
 367     /**
 368      * Acquire pre-validated node assuming a previous operation and node. This is a counterpart to
 369      * {@link #setValidatedNode(ModificationApplyOperation, Optional, Optional)}.
 370      *
 371      * @param op Currently-executing operation
 372      * @param current Currently-used tree node
 373      * @return {@code null} if there is a mismatch with previously-validated node (if present) or the result of previous
 374      *         validation.
 375      */
 376     @SuppressFBWarnings(value = "NP_OPTIONAL_RETURN_NULL",
 377             justification = "The contract is package-internal and well documented, we do not need a separate wrapper")
 378     @Nullable Optional<? extends TreeNode> getValidatedNode(final ModificationApplyOperation op,
 379             final Optional<? extends TreeNode> current) {
 380         return op.equals(validatedOp) && current.equals(validatedCurrent) ? validatedNode : null;
 381     }
 382 }