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, E extends EffectiveStatement<?, ?>> Prerequisite<StmtContext<?, ?, E>> requiresCtxPath(
 182             final StmtContext<?, ?, ?> context, final ParserNamespace<K, ? extends StmtContext<?, ?, ?>> namespace,
 183             final Iterable<K> keys, final ModelProcessingPhase phase) {
 184         checkNotRegistered();
 185
 186         final var ret = new PhaseRequirementInNamespacePath<StmtContext<?, ?, E>, K>(EFFECTIVE_MODEL, 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(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>(EFFECTIVE_MODEL, 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 class AbstractPrerequisite<T> implements Prerequisite<T> {
 279         private boolean done = false;
 280         private T value;
 281
 282         @Override
 283         @SuppressWarnings("checkstyle:hiddenField")
 284         public final T resolve(final InferenceContext ctx) {
 285             checkState(done);
 286             checkArgument(ctx == ModifierImpl.this.ctx);
 287             return verifyNotNull(value, "Attempted to access unavailable prerequisite %s", this);
 288         }
 289
 290         final boolean isDone() {
 291             return done;
 292         }
 293
 294         @SuppressWarnings("checkstyle:hiddenField")
 295         final boolean resolvePrereq(final T value) {
 296             this.value = value;
 297             this.done = true;
 298             return isApplied();
 299         }
 300
 301         final <O> @NonNull Prerequisite<O> transform(final Function<? super T, O> transformation) {
 302             return context -> transformation.apply(resolve(context));
 303         }
 304
 305         @Override
 306         public final String toString() {
 307             return addToStringAttributes(MoreObjects.toStringHelper(this).omitNullValues()).toString();
 308         }
 309
 310         ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 311             return toStringHelper.add("value", value);
 312         }
 313     }
 314
 315     private abstract class AbstractPathPrerequisite<C extends StmtContext<?, ?, ?>, K> extends AbstractPrerequisite<C>
 316             implements OnNamespaceItemAdded {
 317         private final ModelProcessingPhase modPhase;
 318         private final Iterable<K> keys;
 319         private final Iterator<K> it;
 320
 321         AbstractPathPrerequisite(final ModelProcessingPhase phase, final Iterable<K> keys) {
 322             this.modPhase = requireNonNull(phase);
 323             this.keys = requireNonNull(keys);
 324             it = keys.iterator();
 325         }
 326
 327         @Override
 328         public final void namespaceItemAdded(final StatementContextBase<?, ?, ?> context,
 329                 final ParserNamespace<?, ?> namespace, final Object key, final Object value) {
 330             LOG.debug("Action for {} got key {}", keys, key);
 331
 332             final StatementContextBase<?, ?, ?> target = contextImpl(value);
 333             if (!target.isSupportedByFeatures()) {
 334                 LOG.debug("Key {} in {} is not supported", key, keys);
 335                 resolvePrereq(null);
 336                 action.prerequisiteUnavailable(this);
 337                 return;
 338             }
 339
 340             nextStep(modPhase, context, target);
 341
 342             if (!it.hasNext()) {
 343                 // Last step: we are done
 344                 if (resolvePrereq((C) value)) {
 345                     tryApply();
 346                 }
 347                 return;
 348             }
 349
 350             // Make sure target's storage notifies us when the next step becomes available.
 351             hookOnto(target, namespace, it.next());
 352         }
 353
 354         abstract void nextStep(ModelProcessingPhase phase, StatementContextBase<?, ?, ?> current,
 355             StatementContextBase<?, ?, ?> next);
 356
 357         @Override
 358         final ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 359             return super.addToStringAttributes(toStringHelper).add("phase", modPhase).add("keys", keys);
 360         }
 361
 362         final void hookOnto(final StmtContext<?, ?, ?> context, final ParserNamespace<?, ?> namespace) {
 363             checkArgument(it.hasNext(), "Namespace %s keys may not be empty", namespace);
 364             hookOnto(contextImpl(context), namespace, it.next());
 365         }
 366
 367         @SuppressWarnings("unchecked")
 368         private void hookOnto(final StatementContextBase<?, ?, ?> context, final ParserNamespace<?, ?> namespace,
 369                 final K key) {
 370             context.onNamespaceItemAddedAction((ParserNamespace) namespace, requireNonNull(key), this);
 371         }
 372     }
 373
 374     private final class PhaseMutation<C> extends AbstractPrerequisite<C> implements ContextMutation {
 375         @SuppressWarnings("unchecked")
 376         PhaseMutation(final StatementContextBase<?, ?, ?> context, final ModelProcessingPhase phase) {
 377             context.addMutation(phase, this);
 378             resolvePrereq((C) context);
 379         }
 380
 381         @Override
 382         public boolean isFinished() {
 383             return isApplied();
 384         }
 385     }
 386
 387     private final class PhaseFinished<C extends StmtContext<?, ?, ?>> extends AbstractPrerequisite<C>
 388             implements OnPhaseFinished {
 389         @SuppressWarnings("unchecked")
 390         @Override
 391         public boolean phaseFinished(final StatementContextBase<?, ?, ?> context,
 392                 final ModelProcessingPhase finishedPhase) {
 393             return resolvePrereq((C) context) || tryApply();
 394         }
 395     }
 396
 397     private final class NamespaceMutation extends AbstractPrerequisite<Mutable<?, ?, ?>> {
 398         NamespaceMutation(final StatementContextBase<?, ?, ?> ctx, final ParserNamespace<?, ?> namespace) {
 399             resolvePrereq(ctx);
 400         }
 401     }
 402
 403     private final class AddedToNamespace<C extends StmtContext<?, ?, ?>> extends AbstractPrerequisite<C>
 404             implements OnNamespaceItemAdded, OnPhaseFinished {
 405         private final ModelProcessingPhase phase;
 406
 407         AddedToNamespace(final ModelProcessingPhase phase) {
 408             this.phase = requireNonNull(phase);
 409         }
 410
 411         @Override
 412         public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context,
 413                 final ParserNamespace<?, ?> namespace, final Object key, final Object value) {
 414             ((StatementContextBase<?, ?, ?>) value).addPhaseCompletedListener(phase, this);
 415         }
 416
 417         @SuppressWarnings("unchecked")
 418         @Override
 419         public boolean phaseFinished(final StatementContextBase<?, ?, ?> context,
 420                 final ModelProcessingPhase finishedPhase) {
 421             return resolvePrereq((C) context) || tryApply();
 422         }
 423
 424         @Override
 425         ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 426             return super.addToStringAttributes(toStringHelper).add("phase", phase);
 427         }
 428     }
 429
 430     private final class PhaseRequirementInNamespacePath<C extends StmtContext<?, ?, ?>, K>
 431             extends AbstractPathPrerequisite<C, K> {
 432         PhaseRequirementInNamespacePath(final ModelProcessingPhase phase, final Iterable<K> keys) {
 433             super(phase, keys);
 434         }
 435
 436         @Override
 437         void nextStep(final ModelProcessingPhase phase, final StatementContextBase<?, ?, ?> current,
 438                 final StatementContextBase<?, ?, ?> next) {
 439             // No-op
 440         }
 441     }
 442
 443     private final class PhaseModificationInNamespace<C extends Mutable<?, ?, ?>> extends AbstractPrerequisite<C>
 444             implements OnNamespaceItemAdded, ContextMutation {
 445         private final ModelProcessingPhase modPhase;
 446
 447         PhaseModificationInNamespace(final ModelProcessingPhase phase) {
 448             checkArgument(phase != null, "Model processing phase must not be null");
 449             this.modPhase = phase;
 450         }
 451
 452         @SuppressWarnings("unchecked")
 453         @Override
 454         public void namespaceItemAdded(final StatementContextBase<?, ?, ?> context,
 455                 final ParserNamespace<?, ?> namespace, final Object key, final Object value) {
 456             StatementContextBase<?, ?, ?> targetCtx = contextImpl(value);
 457             targetCtx.addMutation(modPhase, this);
 458             resolvePrereq((C) targetCtx);
 459         }
 460
 461         @Override
 462         public boolean isFinished() {
 463             return isApplied();
 464         }
 465     }
 466
 467     /**
 468      * This similar to {@link PhaseModificationInNamespace}, but allows recursive descent until it finds the real
 469      * target. The mechanics is driven as a sequence of prerequisites along a path: first we hook onto namespace to
 470      * give us the first step. When it does, we hook onto the first item to provide us the second step and so on.
 471      */
 472     private final class PhaseModificationInNamespacePath<C extends Mutable<?, ?, ?>, K>
 473             extends AbstractPathPrerequisite<C, K> implements ContextMutation {
 474         PhaseModificationInNamespacePath(final ModelProcessingPhase phase, final Iterable<K> keys) {
 475             super(phase, keys);
 476         }
 477
 478         @Override
 479         public boolean isFinished() {
 480             return isApplied();
 481         }
 482
 483         @Override
 484         void nextStep(final ModelProcessingPhase phase, final StatementContextBase<?, ?, ?> current,
 485                 final StatementContextBase<?, ?, ?> next) {
 486             // Hook onto target: we either have a modification of the target itself or one of its children.
 487             next.addMutation(phase, this);
 488             // We have completed the context -> target step, hence we are no longer directly blocking context from
 489             // making forward progress.
 490             current.removeMutation(phase, this);
 491         }
 492     }
 493 }