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