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<?, ?, ?>> @NonNull AbstractPrerequisite<C> requiresCtxImpl(
  92             final StmtContext<?, ?, ?> context, final StatementNamespace<K, ?, ?> namespace, final K key,
  93             final ModelProcessingPhase phase)  {
  94         checkNotRegistered();
  95
  96         AddedToNamespace<C> addedToNs = new AddedToNamespace<>(phase);
  97         addReq(addedToNs);
  98         contextImpl(context).onNamespaceItemAddedAction(namespace, key, addedToNs);
  99         return addedToNs;
 100     }
 101
 102     private <K, C extends StmtContext<?, ?, ?>> @NonNull AbstractPrerequisite<C> requiresCtxImpl(
 103             final StmtContext<?, ?, ?> context, final StatementNamespace<K, ?, ?> namespace,
 104             final NamespaceKeyCriterion<K> criterion, final ModelProcessingPhase phase)  {
 105         checkNotRegistered();
 106
 107         AddedToNamespace<C> addedToNs = new AddedToNamespace<>(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         PhaseFinished<C> phaseFin = new PhaseFinished<>();
 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<?, ?, ?>> AbstractPrerequisite<C> mutatesCtxImpl(final StmtContext<?, ?, ?> context,
 125             final ParserNamespace<K, ? extends StmtContext<?, ?, ?>> namespace, final K key,
 126             final ModelProcessingPhase phase) {
 127         checkNotRegistered();
 128
 129         final PhaseModificationInNamespace<C> mod = new PhaseModificationInNamespace<>(EFFECTIVE_MODEL);
 130         addReq(mod);
 131         addMutation(mod);
 132         contextImpl(context).onNamespaceItemAddedAction((ParserNamespace) 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<>(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> Prerequisite<StmtContext<?, ?, ?>> requiresCtx(final StmtContext<?, ?, ?> context,
 170             final StatementNamespace<K, ?, ?> namespace, final K key, final ModelProcessingPhase phase) {
 171         return requiresCtxImpl(context, namespace, key, phase);
 172     }
 173
 174     @Override
 175     public <K> Prerequisite<StmtContext<?, ?, ?>> requiresCtx(final StmtContext<?, ?, ?> context,
 176             final StatementNamespace<K, ?, ?> namespace, final NamespaceKeyCriterion<K> criterion,
 177             final ModelProcessingPhase phase) {
 178         return requiresCtxImpl(context, namespace, criterion, phase);
 179     }
 180
 181     @Override
 182     public <K, E extends EffectiveStatement<?, ?>> Prerequisite<StmtContext<?, ?, E>> requiresCtxPath(
 183             final StmtContext<?, ?, ?> context, final ParserNamespace<K, ? extends StmtContext<?, ?, ?>> namespace,
 184             final Iterable<K> keys, final ModelProcessingPhase phase) {
 185         checkNotRegistered();
 186
 187         final var ret = new PhaseRequirementInNamespacePath<StmtContext<?, ?, E>, K>(EFFECTIVE_MODEL, keys);
 188         addReq(ret);
 189         addBootstrap(() -> ret.hookOnto(context, namespace));
 190         return ret;
 191     }
 192
 193     @Override
 194     public <D extends DeclaredStatement<?>> Prerequisite<D> requiresDeclared(
 195             final StmtContext<?, ? extends D, ?> context) {
 196         return requiresCtxImpl(context, FULL_DECLARATION).transform(StmtContext::declared);
 197     }
 198
 199     @Override
 200     @Deprecated
 201     public <K, D extends DeclaredStatement<?>> Prerequisite<D> requiresDeclared(final StmtContext<?, ?, ?> context,
 202             final StatementNamespace<K, ? extends D, ?> namespace, final K key) {
 203         final AbstractPrerequisite<StmtContext<?, D, ?>> rawContext = requiresCtxImpl(context, namespace, key,
 204             FULL_DECLARATION);
 205         return rawContext.transform(StmtContext::declared);
 206     }
 207
 208     @Override
 209     @Deprecated
 210     public <K, D extends DeclaredStatement<?>> AbstractPrerequisite<StmtContext<?, D, ?>> requiresDeclaredCtx(
 211             final StmtContext<?, ?, ?> context, final StatementNamespace<K, ? extends D, ?> namespace, final K key) {
 212         return requiresCtxImpl(context, namespace, key, FULL_DECLARATION);
 213     }
 214
 215     @Override
 216     @Deprecated
 217     public <E extends EffectiveStatement<?, ?>> Prerequisite<E> requiresEffective(
 218             final StmtContext<?, ?, ? extends E> stmt) {
 219         return requiresCtxImpl(stmt, EFFECTIVE_MODEL).transform(StmtContext::buildEffective);
 220     }
 221
 222     @Override
 223     @Deprecated
 224     public <K, E extends EffectiveStatement<?, ?>> Prerequisite<E> requiresEffective(final StmtContext<?, ?, ?> context,
 225             final StatementNamespace<K, ?, ? extends E> namespace, final K key) {
 226         final AbstractPrerequisite<StmtContext<?, ?, E>> rawContext = requiresCtxImpl(context, namespace, key,
 227             EFFECTIVE_MODEL);
 228         return rawContext.transform(StmtContext::buildEffective);
 229     }
 230
 231     @Override
 232     @Deprecated
 233     public <K, E extends EffectiveStatement<?, ?>> AbstractPrerequisite<StmtContext<?, ?, E>> requiresEffectiveCtx(
 234             final StmtContext<?, ?, ?> context, final StatementNamespace<K, ?, ? extends E> namespace, final K key) {
 235         return requiresCtxImpl(contextImpl(context), namespace, key, EFFECTIVE_MODEL);
 236     }
 237
 238     @Override
 239     @Deprecated
 240     public Prerequisite<Mutable<?, ?, ?>> mutatesNs(final Mutable<?, ?, ?> context,
 241             final ParserNamespace<?, ?> namespace) {
 242         return addMutation(new NamespaceMutation(contextImpl(context), namespace));
 243     }
 244
 245     @Override
 246     public <K, E extends EffectiveStatement<?, ?>> AbstractPrerequisite<Mutable<?, ?, E>> mutatesEffectiveCtx(
 247             final StmtContext<?, ?, ?> context, final ParserNamespace<K, ? extends StmtContext<?, ?, ?>> namespace,
 248             final K key) {
 249         return mutatesCtxImpl(context, namespace, key, EFFECTIVE_MODEL);
 250     }
 251
 252     @Override
 253     public <K, E extends EffectiveStatement<?, ?>> AbstractPrerequisite<Mutable<?, ?, E>> mutatesEffectiveCtxPath(
 254             final StmtContext<?, ?, ?> context, final ParserNamespace<K, ? extends StmtContext<?, ?, ?>> namespace,
 255             final Iterable<K> keys) {
 256         checkNotRegistered();
 257
 258         final var ret = new PhaseModificationInNamespacePath<Mutable<?, ?, E>, K>(EFFECTIVE_MODEL, keys);
 259         addReq(ret);
 260         addMutation(ret);
 261         addBootstrap(() -> ret.hookOnto(context, namespace));
 262         return ret;
 263     }
 264
 265     @Override
 266     @SuppressWarnings("checkstyle:hiddenField")
 267     public void apply(final InferenceAction action) {
 268         checkState(this.action == null, "Action already defined to %s", this.action);
 269         this.action = requireNonNull(action);
 270         if (bootstraps != null) {
 271             bootstraps.forEach(Runnable::run);
 272             bootstraps = null;
 273         }
 274     }
 275
 276     private void addBootstrap(final Runnable bootstrap) {
 277         if (bootstraps == null) {
 278             bootstraps = new ArrayList<>(1);
 279         }
 280         bootstraps.add(bootstrap);
 281     }
 282
 283     private abstract class AbstractPrerequisite<T> implements Prerequisite<T> {
 284         private boolean done = false;
 285         private T value;
 286
 287         @Override
 288         @SuppressWarnings("checkstyle:hiddenField")
 289         public final T resolve(final InferenceContext ctx) {
 290             checkState(done);
 291             checkArgument(ctx == ModifierImpl.this.ctx);
 292             return verifyNotNull(value, "Attempted to access unavailable prerequisite %s", this);
 293         }
 294
 295         final boolean isDone() {
 296             return done;
 297         }
 298
 299         @SuppressWarnings("checkstyle:hiddenField")
 300         final boolean resolvePrereq(final T value) {
 301             this.value = value;
 302             this.done = true;
 303             return isApplied();
 304         }
 305
 306         final <O> @NonNull Prerequisite<O> transform(final Function<? super T, O> transformation) {
 307             return context -> transformation.apply(resolve(context));
 308         }
 309
 310         @Override
 311         public final String toString() {
 312             return addToStringAttributes(MoreObjects.toStringHelper(this).omitNullValues()).toString();
 313         }
 314
 315         ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 316             return toStringHelper.add("value", value);
 317         }
 318     }
 319
 320     private abstract class AbstractPathPrerequisite<C extends StmtContext<?, ?, ?>, K> extends AbstractPrerequisite<C>
 321             implements OnNamespaceItemAdded {
 322         private final ModelProcessingPhase modPhase;
 323         private final Iterable<K> keys;
 324         private final Iterator<K> it;
 325
 326         AbstractPathPrerequisite(final ModelProcessingPhase phase, final Iterable<K> keys) {
 327             this.modPhase = requireNonNull(phase);
 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                 action.prerequisiteUnavailable(this);
 342                 return;
 343             }
 344
 345             nextStep(modPhase, context, target);
 346
 347             if (!it.hasNext()) {
 348                 // Last step: we are done
 349                 if (resolvePrereq((C) value)) {
 350                     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(ModelProcessingPhase phase, StatementContextBase<?, ?, ?> current,
 360             StatementContextBase<?, ?, ?> next);
 361
 362         @Override
 363         final ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 364             return super.addToStringAttributes(toStringHelper).add("phase", modPhase).add("keys", keys);
 365         }
 366
 367         final void hookOnto(final StmtContext<?, ?, ?> context, final ParserNamespace<?, ?> namespace) {
 368             checkArgument(it.hasNext(), "Namespace %s keys may not be empty", namespace);
 369             hookOnto(contextImpl(context), namespace, it.next());
 370         }
 371
 372         @SuppressWarnings("unchecked")
 373         private void hookOnto(final StatementContextBase<?, ?, ?> context, final ParserNamespace<?, ?> namespace,
 374                 final K key) {
 375             context.onNamespaceItemAddedAction((ParserNamespace) namespace, requireNonNull(key), this);
 376         }
 377     }
 378
 379     private final class PhaseMutation<C> extends AbstractPrerequisite<C> implements ContextMutation {
 380         @SuppressWarnings("unchecked")
 381         PhaseMutation(final StatementContextBase<?, ?, ?> context, final ModelProcessingPhase phase) {
 382             context.addMutation(phase, this);
 383             resolvePrereq((C) context);
 384         }
 385
 386         @Override
 387         public boolean isFinished() {
 388             return isApplied();
 389         }
 390     }
 391
 392     private final class PhaseFinished<C extends StmtContext<?, ?, ?>> extends AbstractPrerequisite<C>
 393             implements OnPhaseFinished {
 394         @SuppressWarnings("unchecked")
 395         @Override
 396         public boolean phaseFinished(final StatementContextBase<?, ?, ?> context,
 397                 final ModelProcessingPhase finishedPhase) {
 398             return resolvePrereq((C) context) || tryApply();
 399         }
 400     }
 401
 402     private final class NamespaceMutation extends AbstractPrerequisite<Mutable<?, ?, ?>> {
 403         NamespaceMutation(final StatementContextBase<?, ?, ?> ctx, final ParserNamespace<?, ?> namespace) {
 404             resolvePrereq(ctx);
 405         }
 406     }
 407
 408     private final class AddedToNamespace<C extends StmtContext<?, ?, ?>> extends AbstractPrerequisite<C>
 409             implements OnNamespaceItemAdded, OnPhaseFinished {
 410         private final ModelProcessingPhase phase;
 411
 412         AddedToNamespace(final ModelProcessingPhase phase) {
 413             this.phase = requireNonNull(phase);
 414         }
 415
 416         @Override
 417         public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context,
 418                 final ParserNamespace<?, ?> namespace, final Object key, final Object value) {
 419             ((StatementContextBase<?, ?, ?>) value).addPhaseCompletedListener(phase, this);
 420         }
 421
 422         @SuppressWarnings("unchecked")
 423         @Override
 424         public boolean phaseFinished(final StatementContextBase<?, ?, ?> context,
 425                 final ModelProcessingPhase finishedPhase) {
 426             return resolvePrereq((C) context) || tryApply();
 427         }
 428
 429         @Override
 430         ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 431             return super.addToStringAttributes(toStringHelper).add("phase", phase);
 432         }
 433     }
 434
 435     private final class PhaseRequirementInNamespacePath<C extends StmtContext<?, ?, ?>, K>
 436             extends AbstractPathPrerequisite<C, K> {
 437         PhaseRequirementInNamespacePath(final ModelProcessingPhase phase, final Iterable<K> keys) {
 438             super(phase, keys);
 439         }
 440
 441         @Override
 442         void nextStep(final ModelProcessingPhase phase, final StatementContextBase<?, ?, ?> current,
 443                 final StatementContextBase<?, ?, ?> next) {
 444             // No-op
 445         }
 446     }
 447
 448     private final class PhaseModificationInNamespace<C extends Mutable<?, ?, ?>> extends AbstractPrerequisite<C>
 449             implements OnNamespaceItemAdded, ContextMutation {
 450         private final ModelProcessingPhase modPhase;
 451
 452         PhaseModificationInNamespace(final ModelProcessingPhase phase) {
 453             checkArgument(phase != null, "Model processing phase must not be null");
 454             this.modPhase = phase;
 455         }
 456
 457         @SuppressWarnings("unchecked")
 458         @Override
 459         public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context,
 460                 final ParserNamespace<?, ?> namespace, final Object key, final Object value) {
 461             StatementContextBase<?, ?, ?> targetCtx = contextImpl(value);
 462             targetCtx.addMutation(modPhase, this);
 463             resolvePrereq((C) targetCtx);
 464         }
 465
 466         @Override
 467         public boolean isFinished() {
 468             return isApplied();
 469         }
 470     }
 471
 472     /**
 473      * This similar to {@link PhaseModificationInNamespace}, but allows recursive descent until it finds the real
 474      * target. The mechanics is driven as a sequence of prerequisites along a path: first we hook onto namespace to
 475      * give us the first step. When it does, we hook onto the first item to provide us the second step and so on.
 476      */
 477     private final class PhaseModificationInNamespacePath<C extends Mutable<?, ?, ?>, K>
 478             extends AbstractPathPrerequisite<C, K> implements ContextMutation {
 479         PhaseModificationInNamespacePath(final ModelProcessingPhase phase, final Iterable<K> keys) {
 480             super(phase, keys);
 481         }
 482
 483         @Override
 484         public boolean isFinished() {
 485             return isApplied();
 486         }
 487
 488         @Override
 489         void nextStep(final ModelProcessingPhase phase, final StatementContextBase<?, ?, ?> current,
 490                 final StatementContextBase<?, ?, ?> next) {
 491             // Hook onto target: we either have a modification of the target itself or one of its children.
 492             next.addMutation(phase, this);
 493             // We have completed the context -> target step, hence we are no longer directly blocking context from
 494             // making forward progress.
 495             current.removeMutation(phase, this);
 496         }
 497     }
 498 }