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