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