parser/yang-parser-reactor/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/reactor/ModifierImpl.java

   1 /*
   2  * Copyright (c) 2015, 2016 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.parser.stmt.reactor;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static com.google.common.base.Preconditions.checkState;
  12 import static com.google.common.base.Verify.verifyNotNull;
  13 import static java.util.Objects.requireNonNull;
  14 import static org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.EFFECTIVE_MODEL;
  15 import static org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase.FULL_DECLARATION;
  16
  17 import com.google.common.base.MoreObjects;
  18 import com.google.common.base.MoreObjects.ToStringHelper;
  19 import java.util.ArrayList;
  20 import java.util.HashSet;
  21 import java.util.Iterator;
  22 import java.util.List;
  23 import java.util.Set;
  24 import java.util.function.Function;
  25 import org.eclipse.jdt.annotation.NonNull;
  26 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  27 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  28 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  29 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
  30 import org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceKeyCriterion;
  31 import org.opendaylight.yangtools.yang.parser.spi.meta.ParserNamespace;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  34 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase.ContextMutation;
  35 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase.OnNamespaceItemAdded;
  36 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase.OnPhaseFinished;
  37 import org.slf4j.Logger;
  38 import org.slf4j.LoggerFactory;
  39
  40 final class ModifierImpl implements ModelActionBuilder {
  41     private static final Logger LOG = LoggerFactory.getLogger(ModifierImpl.class);
  42
  43     private final Set<AbstractPrerequisite<?>> unsatisfied = new HashSet<>(1);
  44     private final Set<AbstractPrerequisite<?>> mutations = new HashSet<>(1);
  45     private final InferenceContext ctx = new InferenceContext() { };
  46
  47     private List<Runnable> bootstraps;
  48     private InferenceAction action;
  49     private boolean actionApplied;
  50
  51     private <D> AbstractPrerequisite<D> addReq(final AbstractPrerequisite<D> prereq) {
  52         LOG.trace("Modifier {} adding prerequisite {}", this, prereq);
  53         unsatisfied.add(prereq);
  54         return prereq;
  55     }
  56
  57     private <T> @NonNull AbstractPrerequisite<T> addMutation(final @NonNull AbstractPrerequisite<T> mutation) {
  58         LOG.trace("Modifier {} adding mutation {}", this, mutation);
  59         mutations.add(mutation);
  60         return mutation;
  61     }
  62
  63     private void checkNotRegistered() {
  64         checkState(action == null, "Action was already registered.");
  65     }
  66
  67     private boolean removeSatisfied() {
  68         final Iterator<AbstractPrerequisite<?>> it = unsatisfied.iterator();
  69         while (it.hasNext()) {
  70             final AbstractPrerequisite<?> prereq = it.next();
  71             if (prereq.isDone()) {
  72                 // We are removing current prerequisite from list.
  73                 LOG.trace("Modifier {} prerequisite {} satisfied", this, prereq);
  74                 it.remove();
  75             }
  76         }
  77         return unsatisfied.isEmpty();
  78     }
  79
  80     boolean isApplied() {
  81         return actionApplied;
  82     }
  83
  84     void failModifier() {
  85         removeSatisfied();
  86         action.prerequisiteFailed(unsatisfied);
  87         action = null;
  88     }
  89
  90     private <K, C extends StmtContext<?, ?, ?>> @NonNull AbstractPrerequisite<C> requiresCtxImpl(
  91             final StmtContext<?, ?, ?> context, final ParserNamespace<K, C> namespace, final K key,
  92             final ModelProcessingPhase phase)  {
  93         checkNotRegistered();
  94
  95         final var addedToNs = new AddedToNamespace<C>(this, phase);
  96         addReq(addedToNs);
  97         contextImpl(context).onNamespaceItemAddedAction(namespace, key, addedToNs);
  98         return addedToNs;
  99     }
 100
 101     private <K, C extends StmtContext<?, ?, ?>> @NonNull AbstractPrerequisite<C> requiresCtxImpl(
 102             final StmtContext<?, ?, ?> context, final ParserNamespace<K, C> namespace,
 103             final NamespaceKeyCriterion<K> criterion, final ModelProcessingPhase phase)  {
 104         checkNotRegistered();
 105
 106         final var addedToNs = new AddedToNamespace<C>(this, phase);
 107         addReq(addedToNs);
 108         contextImpl(context).onNamespaceItemAddedAction(namespace, phase, criterion, addedToNs);
 109         return addedToNs;
 110     }
 111
 112     private <C extends StmtContext<?, ?, ?>> @NonNull AbstractPrerequisite<C> requiresCtxImpl(final C context,
 113             final ModelProcessingPhase phase) {
 114         checkNotRegistered();
 115
 116         final var phaseFin = new PhaseFinished<C>(this);
 117         addReq(phaseFin);
 118         addBootstrap(() -> contextImpl(context).addPhaseCompletedListener(phase, phaseFin));
 119         return phaseFin;
 120     }
 121
 122     @SuppressWarnings({ "rawtypes", "unchecked" })
 123     private <K, C extends Mutable<?, ?, ?>> AbstractPrerequisite<C> mutatesCtxImpl(final StmtContext<?, ?, ?> context,
 124             final ParserNamespace<K, ? extends StmtContext<?, ?, ?>> namespace, final K key,
 125             final ModelProcessingPhase phase) {
 126         checkNotRegistered();
 127
 128         final var mod = new PhaseModificationInNamespace<C>(this, EFFECTIVE_MODEL);
 129         addReq(mod);
 130         addMutation(mod);
 131         contextImpl(context).onNamespaceItemAddedAction((ParserNamespace) namespace, key, mod);
 132         return mod;
 133     }
 134
 135     private static StatementContextBase<?, ?, ?> contextImpl(final Object value) {
 136         if (value instanceof StatementContextBase<?, ?, ?> impl) {
 137             return impl;
 138         }
 139         throw new IllegalArgumentException("Supplied context " + value + " is not provided by this reactor.");
 140     }
 141
 142     boolean tryApply() {
 143         checkState(action != null, "Action was not defined yet.");
 144
 145         if (removeSatisfied()) {
 146             if (!actionApplied) {
 147                 action.apply(ctx);
 148                 actionApplied = true;
 149             }
 150             return true;
 151         }
 152         return false;
 153     }
 154
 155     @Override
 156     public <C extends Mutable<?, ?, ?>, T extends C> Prerequisite<C> mutatesCtx(final T context,
 157             final ModelProcessingPhase phase) {
 158         return addMutation(new PhaseMutation<>(this, contextImpl(context), phase));
 159     }
 160
 161     @Override
 162     public <A, D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>>
 163             AbstractPrerequisite<StmtContext<A, D, E>> requiresCtx(final StmtContext<A, D, E> context,
 164                 final ModelProcessingPhase phase) {
 165         return requiresCtxImpl(context, phase);
 166     }
 167
 168     @Override
 169     public <K, C extends StmtContext<?, ?, ?>> Prerequisite<C> requiresCtx(final StmtContext<?, ?, ?> context,
 170             final ParserNamespace<K, C> namespace, final K key, final ModelProcessingPhase phase) {
 171         return requiresCtxImpl(context, namespace, key, phase);
 172     }
 173
 174     @Override
 175     public <K, C extends StmtContext<?, ?, ?>> Prerequisite<C> requiresCtx(final StmtContext<?, ?, ?> context,
 176             final ParserNamespace<K, C> namespace, final NamespaceKeyCriterion<K> criterion,
 177             final ModelProcessingPhase phase) {
 178         return requiresCtxImpl(context, namespace, criterion, phase);
 179     }
 180
 181     @Override
 182     public <K, C extends StmtContext<?, ?, ?>> Prerequisite<C> requiresEffectiveCtxPath(
 183             final StmtContext<?, ?, ?> context, final ParserNamespace<K, C> namespace, final Iterable<K> keys) {
 184         checkNotRegistered();
 185
 186         final var ret = new PhaseRequirementInNamespacePath<C, K>(this, keys);
 187         addReq(ret);
 188         addBootstrap(() -> ret.hookOnto(context, namespace));
 189         return ret;
 190     }
 191
 192     @Override
 193     public <D extends DeclaredStatement<?>> Prerequisite<D> requiresDeclared(
 194             final StmtContext<?, ? extends D, ?> context) {
 195         return requiresCtxImpl(context, FULL_DECLARATION).transform(StmtContext::declared);
 196     }
 197
 198     @Override
 199     @Deprecated
 200     public <K, D extends DeclaredStatement<?>> Prerequisite<D> requiresDeclared(final StmtContext<?, ?, ?> context,
 201             final ParserNamespace<K, StmtContext<?, ? extends D, ?>> namespace, final K key) {
 202         return requiresCtxImpl(context, namespace, key, FULL_DECLARATION).transform(StmtContext::declared);
 203     }
 204
 205     @Override
 206     @Deprecated
 207     public <K, C extends StmtContext<?, ?, ?>> AbstractPrerequisite<C> requiresDeclaredCtx(
 208             final StmtContext<?, ?, ?> context, final ParserNamespace<K, C> namespace, final K key) {
 209         return requiresCtxImpl(context, namespace, key, FULL_DECLARATION);
 210     }
 211
 212     @Override
 213     @Deprecated
 214     public <E extends EffectiveStatement<?, ?>> Prerequisite<E> requiresEffective(
 215             final StmtContext<?, ?, ? extends E> stmt) {
 216         return requiresCtxImpl(stmt, EFFECTIVE_MODEL).transform(StmtContext::buildEffective);
 217     }
 218
 219     @Override
 220     @Deprecated
 221     public <K, E extends EffectiveStatement<?, ?>> Prerequisite<E> requiresEffective(final StmtContext<?, ?, ?> context,
 222             final ParserNamespace<K, StmtContext<?, ?, ? extends E>> namespace, final K key) {
 223         return requiresCtxImpl(context, namespace, key, EFFECTIVE_MODEL).transform(StmtContext::buildEffective);
 224     }
 225
 226     @Override
 227     @Deprecated
 228     public <K, C extends StmtContext<?, ?, ?>> AbstractPrerequisite<C> requiresEffectiveCtx(
 229             final StmtContext<?, ?, ?> context, final ParserNamespace<K, C> namespace, final K key) {
 230         return requiresCtxImpl(contextImpl(context), namespace, key, EFFECTIVE_MODEL);
 231     }
 232
 233     @Override
 234     @Deprecated
 235     public Prerequisite<Mutable<?, ?, ?>> mutatesNs(final Mutable<?, ?, ?> context,
 236             final ParserNamespace<?, ?> namespace) {
 237         return addMutation(new NamespaceMutation(this, contextImpl(context), namespace));
 238     }
 239
 240     @Override
 241     public <K, E extends EffectiveStatement<?, ?>> AbstractPrerequisite<Mutable<?, ?, E>> mutatesEffectiveCtx(
 242             final StmtContext<?, ?, ?> context, final ParserNamespace<K, ? extends StmtContext<?, ?, ?>> namespace,
 243             final K key) {
 244         return mutatesCtxImpl(context, namespace, key, EFFECTIVE_MODEL);
 245     }
 246
 247     @Override
 248     public <K, E extends EffectiveStatement<?, ?>> AbstractPrerequisite<Mutable<?, ?, E>> mutatesEffectiveCtxPath(
 249             final StmtContext<?, ?, ?> context, final ParserNamespace<K, ? extends StmtContext<?, ?, ?>> namespace,
 250             final Iterable<K> keys) {
 251         checkNotRegistered();
 252
 253         final var ret = new PhaseModificationInNamespacePath<Mutable<?, ?, E>, K>(this, keys);
 254         addReq(ret);
 255         addMutation(ret);
 256         addBootstrap(() -> ret.hookOnto(context, namespace));
 257         return ret;
 258     }
 259
 260     @Override
 261     @SuppressWarnings("checkstyle:hiddenField")
 262     public void apply(final InferenceAction action) {
 263         checkState(this.action == null, "Action already defined to %s", this.action);
 264         this.action = requireNonNull(action);
 265         if (bootstraps != null) {
 266             bootstraps.forEach(Runnable::run);
 267             bootstraps = null;
 268         }
 269     }
 270
 271     private void addBootstrap(final Runnable bootstrap) {
 272         if (bootstraps == null) {
 273             bootstraps = new ArrayList<>(1);
 274         }
 275         bootstraps.add(bootstrap);
 276     }
 277
 278     private abstract static class AbstractPrerequisite<T> implements Prerequisite<T> {
 279         final @NonNull ModifierImpl modifier;
 280
 281         private boolean done = false;
 282         private T value;
 283
 284         AbstractPrerequisite(final ModifierImpl modifier) {
 285             this.modifier = requireNonNull(modifier);
 286         }
 287
 288         @Override
 289         @SuppressWarnings("checkstyle:hiddenField")
 290         public final T resolve(final InferenceContext ctx) {
 291             checkState(done);
 292             checkArgument(ctx == modifier.ctx);
 293             return verifyNotNull(value, "Attempted to access unavailable prerequisite %s", this);
 294         }
 295
 296         final boolean isDone() {
 297             return done;
 298         }
 299
 300         @SuppressWarnings("checkstyle:hiddenField")
 301         final boolean resolvePrereq(final T value) {
 302             this.value = value;
 303             this.done = true;
 304             return modifier.isApplied();
 305         }
 306
 307         final <O> @NonNull Prerequisite<O> transform(final Function<? super T, O> transformation) {
 308             return context -> transformation.apply(resolve(context));
 309         }
 310
 311         @Override
 312         public final String toString() {
 313             return addToStringAttributes(MoreObjects.toStringHelper(this).omitNullValues()).toString();
 314         }
 315
 316         ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 317             return toStringHelper.add("value", value);
 318         }
 319     }
 320
 321     private abstract static class AbstractPathPrerequisite<C extends StmtContext<?, ?, ?>, K>
 322             extends AbstractPrerequisite<C> implements OnNamespaceItemAdded {
 323         private final Iterable<K> keys;
 324         private final Iterator<K> it;
 325
 326         AbstractPathPrerequisite(final ModifierImpl modifier, final Iterable<K> keys) {
 327             super(modifier);
 328             this.keys = requireNonNull(keys);
 329             it = keys.iterator();
 330         }
 331
 332         @Override
 333         public final void namespaceItemAdded(final StatementContextBase<?, ?, ?> context,
 334                 final ParserNamespace<?, ?> namespace, final Object key, final Object value) {
 335             LOG.debug("Action for {} got key {}", keys, key);
 336
 337             final StatementContextBase<?, ?, ?> target = contextImpl(value);
 338             if (!target.isSupportedByFeatures()) {
 339                 LOG.debug("Key {} in {} is not supported", key, keys);
 340                 resolvePrereq(null);
 341                 modifier.action.prerequisiteUnavailable(this);
 342                 return;
 343             }
 344
 345             nextStep(context, target);
 346
 347             if (!it.hasNext()) {
 348                 // Last step: we are done
 349                 if (resolvePrereq((C) value)) {
 350                     modifier.tryApply();
 351                 }
 352                 return;
 353             }
 354
 355             // Make sure target's storage notifies us when the next step becomes available.
 356             hookOnto(target, namespace, it.next());
 357         }
 358
 359         abstract void nextStep(StatementContextBase<?, ?, ?> current, StatementContextBase<?, ?, ?> next);
 360
 361         @Override
 362         final ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 363             return super.addToStringAttributes(toStringHelper).add("keys", keys);
 364         }
 365
 366         final void hookOnto(final StmtContext<?, ?, ?> context, final ParserNamespace<?, ?> namespace) {
 367             checkArgument(it.hasNext(), "Namespace %s keys may not be empty", namespace);
 368             hookOnto(contextImpl(context), namespace, it.next());
 369         }
 370
 371         @SuppressWarnings("unchecked")
 372         private void hookOnto(final StatementContextBase<?, ?, ?> context, final ParserNamespace<?, ?> namespace,
 373                 final K key) {
 374             context.onNamespaceItemAddedAction((ParserNamespace) namespace, requireNonNull(key), this);
 375         }
 376     }
 377
 378     private static final class PhaseMutation<C> extends AbstractPrerequisite<C> implements ContextMutation {
 379         @SuppressWarnings("unchecked")
 380         PhaseMutation(final ModifierImpl modifier, final StatementContextBase<?, ?, ?> context,
 381                 final ModelProcessingPhase phase) {
 382             super(modifier);
 383             context.addMutation(phase, this);
 384             resolvePrereq((C) context);
 385         }
 386
 387         @Override
 388         public boolean isFinished() {
 389             return modifier.isApplied();
 390         }
 391     }
 392
 393     private static final class PhaseFinished<C extends StmtContext<?, ?, ?>> extends AbstractPrerequisite<C>
 394             implements OnPhaseFinished {
 395         PhaseFinished(final ModifierImpl modifier) {
 396             super(modifier);
 397         }
 398
 399         @SuppressWarnings("unchecked")
 400         @Override
 401         public boolean phaseFinished(final StatementContextBase<?, ?, ?> context,
 402                 final ModelProcessingPhase finishedPhase) {
 403             return resolvePrereq((C) context) || modifier.tryApply();
 404         }
 405     }
 406
 407     private static final class NamespaceMutation extends AbstractPrerequisite<Mutable<?, ?, ?>> {
 408         NamespaceMutation(final ModifierImpl modifier, final StatementContextBase<?, ?, ?> ctx,
 409                 final ParserNamespace<?, ?> namespace) {
 410             super(modifier);
 411             resolvePrereq(ctx);
 412         }
 413     }
 414
 415     private static final class AddedToNamespace<C extends StmtContext<?, ?, ?>> extends AbstractPrerequisite<C>
 416             implements OnNamespaceItemAdded, OnPhaseFinished {
 417         private final ModelProcessingPhase phase;
 418
 419         AddedToNamespace(final ModifierImpl modifier, final ModelProcessingPhase phase) {
 420             super(modifier);
 421             this.phase = requireNonNull(phase);
 422         }
 423
 424         @Override
 425         public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context,
 426                 final ParserNamespace<?, ?> namespace, final Object key, final Object value) {
 427             contextImpl(value).addPhaseCompletedListener(phase, this);
 428         }
 429
 430         @SuppressWarnings("unchecked")
 431         @Override
 432         public boolean phaseFinished(final StatementContextBase<?, ?, ?> context,
 433                 final ModelProcessingPhase finishedPhase) {
 434             return resolvePrereq((C) context) || modifier.tryApply();
 435         }
 436
 437         @Override
 438         ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 439             return super.addToStringAttributes(toStringHelper).add("phase", phase);
 440         }
 441     }
 442
 443     private static final class PhaseRequirementInNamespacePath<C extends StmtContext<?, ?, ?>, K>
 444             extends AbstractPathPrerequisite<C, K> {
 445         PhaseRequirementInNamespacePath(final ModifierImpl modifier, final Iterable<K> keys) {
 446             super(modifier, keys);
 447         }
 448
 449         @Override
 450         void nextStep(final StatementContextBase<?, ?, ?> current, final StatementContextBase<?, ?, ?> next) {
 451             // No-op
 452         }
 453     }
 454
 455     private static final class PhaseModificationInNamespace<C extends Mutable<?, ?, ?>> extends AbstractPrerequisite<C>
 456             implements OnNamespaceItemAdded, ContextMutation {
 457         private final ModelProcessingPhase modPhase;
 458
 459         PhaseModificationInNamespace(final ModifierImpl modifier, final ModelProcessingPhase phase) {
 460             super(modifier);
 461             checkArgument(phase != null, "Model processing phase must not be null");
 462             this.modPhase = phase;
 463         }
 464
 465         @SuppressWarnings("unchecked")
 466         @Override
 467         public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context,
 468                 final ParserNamespace<?, ?> namespace, final Object key, final Object value) {
 469             StatementContextBase<?, ?, ?> targetCtx = contextImpl(value);
 470             targetCtx.addMutation(modPhase, this);
 471             resolvePrereq((C) targetCtx);
 472         }
 473
 474         @Override
 475         public boolean isFinished() {
 476             return modifier.isApplied();
 477         }
 478     }
 479
 480     /**
 481      * This similar to {@link PhaseModificationInNamespace}, but allows recursive descent until it finds the real
 482      * target. The mechanics is driven as a sequence of prerequisites along a path: first we hook onto namespace to
 483      * give us the first step. When it does, we hook onto the first item to provide us the second step and so on.
 484      */
 485     private static final class PhaseModificationInNamespacePath<C extends Mutable<?, ?, ?>, K>
 486             extends AbstractPathPrerequisite<C, K> implements ContextMutation {
 487         PhaseModificationInNamespacePath(final ModifierImpl modifier, final Iterable<K> keys) {
 488             super(modifier, keys);
 489         }
 490
 491         @Override
 492         public boolean isFinished() {
 493             return modifier.isApplied();
 494         }
 495
 496         @Override
 497         void nextStep(final StatementContextBase<?, ?, ?> current, final StatementContextBase<?, ?, ?> next) {
 498             // Hook onto target: we either have a modification of the target itself or one of its children.
 499             next.addMutation(EFFECTIVE_MODEL, this);
 500             // We have completed the context -> target step, hence we are no longer directly blocking context from
 501             // making forward progress.
 502             current.removeMutation(EFFECTIVE_MODEL, this);
 503         }
 504     }
 505 }