yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/uses/UsesStatementSupport.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies, s.r.o. 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.rfc7950.stmt.uses;
   9
  10 import static com.google.common.base.Verify.verify;
  11 import static com.google.common.base.Verify.verifyNotNull;
  12
  13 import com.google.common.collect.ImmutableList;
  14 import com.google.common.collect.ImmutableMap;
  15 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  16 import java.util.ArrayList;
  17 import java.util.Collection;
  18 import java.util.LinkedHashMap;
  19 import java.util.Map;
  20 import java.util.Optional;
  21 import org.eclipse.jdt.annotation.NonNull;
  22 import org.opendaylight.yangtools.yang.common.Empty;
  23 import org.opendaylight.yangtools.yang.common.QName;
  24 import org.opendaylight.yangtools.yang.common.QNameModule;
  25 import org.opendaylight.yangtools.yang.common.YangVersion;
  26 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  27 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  28 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  29 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  30 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  31 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  32 import org.opendaylight.yangtools.yang.model.api.stmt.RefineEffectiveStatement;
  33 import org.opendaylight.yangtools.yang.model.api.stmt.RefineStatement;
  34 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
  35 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Descendant;
  36 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeEffectiveStatement;
  37 import org.opendaylight.yangtools.yang.model.api.stmt.UsesEffectiveStatement;
  38 import org.opendaylight.yangtools.yang.model.api.stmt.UsesStatement;
  39 import org.opendaylight.yangtools.yang.model.parser.api.YangParserConfiguration;
  40 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
  41 import org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins;
  42 import org.opendaylight.yangtools.yang.parser.rfc7950.reactor.YangValidationBundles;
  43 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.refine.RefineEffectiveStatementImpl;
  44 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.refine.RefineTargetNamespace;
  45 import org.opendaylight.yangtools.yang.parser.spi.GroupingNamespace;
  46 import org.opendaylight.yangtools.yang.parser.spi.SchemaTreeNamespace;
  47 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractQNameStatementSupport;
  48 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
  49 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  50 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  51 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  52 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
  53 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
  54 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
  55 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
  56 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  57 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  58 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  59 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
  60 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleCtxToModuleQName;
  61 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  62 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace;
  63 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace.ValidationBundleType;
  64 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
  65 import org.slf4j.Logger;
  66 import org.slf4j.LoggerFactory;
  67
  68 public final class UsesStatementSupport
  69         extends AbstractQNameStatementSupport<UsesStatement, UsesEffectiveStatement> {
  70     private static final Logger LOG = LoggerFactory.getLogger(UsesStatementSupport.class);
  71     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(YangStmtMapping
  72         .USES)
  73         .addAny(YangStmtMapping.AUGMENT)
  74         .addOptional(YangStmtMapping.DESCRIPTION)
  75         .addAny(YangStmtMapping.IF_FEATURE)
  76         .addAny(YangStmtMapping.REFINE)
  77         .addOptional(YangStmtMapping.REFERENCE)
  78         .addOptional(YangStmtMapping.STATUS)
  79         .addOptional(YangStmtMapping.WHEN)
  80         .build();
  81
  82     public UsesStatementSupport(final YangParserConfiguration config) {
  83         super(YangStmtMapping.USES, StatementPolicy.exactReplica(), config);
  84     }
  85
  86     @Override
  87     public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  88         return StmtContextUtils.parseNodeIdentifier(ctx, value);
  89     }
  90
  91     @Override
  92     public void onFullDefinitionDeclared(final Mutable<QName, UsesStatement, UsesEffectiveStatement> usesNode) {
  93         if (!usesNode.isSupportedByFeatures()) {
  94             return;
  95         }
  96         super.onFullDefinitionDeclared(usesNode);
  97
  98         final ModelActionBuilder usesAction = usesNode.newInferenceAction(ModelProcessingPhase.EFFECTIVE_MODEL);
  99         final QName groupingName = usesNode.argument();
 100
 101         final Prerequisite<StmtContext<?, ?, ?>> sourceGroupingPre = usesAction.requiresCtx(usesNode,
 102                 GroupingNamespace.class, groupingName, ModelProcessingPhase.EFFECTIVE_MODEL);
 103         final Prerequisite<? extends StmtContext.Mutable<?, ?, ?>> targetNodePre = usesAction.mutatesEffectiveCtx(
 104                 usesNode.getParentContext());
 105
 106         usesAction.apply(new InferenceAction() {
 107
 108             @Override
 109             public void apply(final InferenceContext ctx) {
 110                 final StatementContextBase<?, ?, ?> targetNodeStmtCtx =
 111                         (StatementContextBase<?, ?, ?>) targetNodePre.resolve(ctx);
 112                 final StatementContextBase<?, ?, ?> sourceGrpStmtCtx =
 113                         (StatementContextBase<?, ?, ?>) sourceGroupingPre.resolve(ctx);
 114
 115                 copyFromSourceToTarget(sourceGrpStmtCtx, targetNodeStmtCtx, usesNode);
 116                 resolveUsesNode(usesNode, targetNodeStmtCtx);
 117                 StmtContextUtils.validateIfFeatureAndWhenOnListKeys(usesNode);
 118                 usesNode.addToNs(SourceGroupingNamespace.class, Empty.getInstance(), sourceGrpStmtCtx);
 119             }
 120
 121             @Override
 122             public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
 123                 InferenceException.throwIf(failed.contains(sourceGroupingPre), usesNode,
 124                     "Grouping '%s' was not resolved.", groupingName);
 125                 throw new InferenceException("Unknown error occurred.", usesNode);
 126             }
 127         });
 128     }
 129
 130     @Override
 131     protected SubstatementValidator getSubstatementValidator() {
 132         return SUBSTATEMENT_VALIDATOR;
 133     }
 134
 135     @Override
 136     protected UsesStatement createDeclared(final StmtContext<QName, UsesStatement, ?> ctx,
 137             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
 138         return DeclaredStatements.createUses(ctx.getRawArgument(), ctx.getArgument(), substatements);
 139     }
 140
 141     @Override
 142     protected UsesEffectiveStatement createEffective(final Current<QName, UsesStatement> stmt,
 143             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 144         final EffectiveStatement<?, ?> source =
 145             verifyNotNull(stmt.getFromNamespace(SourceGroupingNamespace.class, Empty.getInstance())).buildEffective();
 146         verify(source instanceof GroupingDefinition, "Unexpected source %s", source);
 147         final GroupingDefinition sourceGrouping = (GroupingDefinition) source;
 148
 149         final int flags = EffectiveStatementMixins.historyAndStatusFlags(stmt.history(), substatements);
 150         final QName argument = stmt.getArgument();
 151         final UsesStatement declared = stmt.declared();
 152
 153         if (substatements.isEmpty()) {
 154             return argument.equals(declared.argument())
 155                 ? new EmptyLocalUsesEffectiveStatement(declared, sourceGrouping, flags)
 156                         : new SimpleCopiedUsesEffectiveStatement(declared, argument, sourceGrouping, flags);
 157         }
 158
 159         if (declared.argument().equals(argument)) {
 160             return new RegularLocalUsesEffectiveStatement(declared, sourceGrouping, flags, substatements);
 161         }
 162         if (findFirstStatement(substatements, RefineEffectiveStatement.class) == null) {
 163             return new SimpleCopiedUsesEffectiveStatement(declared, argument, sourceGrouping, flags, substatements);
 164         }
 165         return new FullCopiedUsesEffectiveStatement(declared, argument, sourceGrouping, flags, substatements);
 166     }
 167
 168     static @NonNull ImmutableMap<Descendant, SchemaNode> indexRefines(
 169             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 170         final Map<Descendant, SchemaNode> refines = new LinkedHashMap<>();
 171
 172         for (EffectiveStatement<?, ?> effectiveStatement : substatements) {
 173             if (effectiveStatement instanceof RefineEffectiveStatementImpl) {
 174                 final RefineEffectiveStatementImpl refineStmt = (RefineEffectiveStatementImpl) effectiveStatement;
 175                 refines.put(refineStmt.argument(), refineStmt.getRefineTargetNode());
 176             }
 177         }
 178
 179         return ImmutableMap.copyOf(refines);
 180     }
 181
 182     /**
 183      * Copy statements from a grouping to a target node.
 184      *
 185      * @param sourceGrpStmtCtx
 186      *            source grouping statement context
 187      * @param targetCtx
 188      *            target context
 189      * @param usesNode
 190      *            uses node
 191      * @throws SourceException
 192      *             instance of SourceException
 193      */
 194     @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
 195             justification = "https://github.com/spotbugs/spotbugs/issues/811")
 196     private static void copyFromSourceToTarget(final Mutable<?, ?, ?> sourceGrpStmtCtx,
 197             final StatementContextBase<?, ?, ?> targetCtx,
 198             final Mutable<QName, UsesStatement, UsesEffectiveStatement> usesNode) {
 199         final Collection<? extends Mutable<?, ?, ?>> declared = sourceGrpStmtCtx.mutableDeclaredSubstatements();
 200         final Collection<? extends Mutable<?, ?, ?>> effective = sourceGrpStmtCtx.mutableEffectiveSubstatements();
 201         final Collection<Mutable<?, ?, ?>> buffer = new ArrayList<>(declared.size() + effective.size());
 202         final QNameModule newQNameModule = getNewQNameModule(targetCtx, sourceGrpStmtCtx);
 203
 204         for (final Mutable<?, ?, ?> original : declared) {
 205             if (original.isSupportedByFeatures() && shouldCopy(original)) {
 206                 original.copyAsChildOf(targetCtx, CopyType.ADDED_BY_USES, newQNameModule).ifPresent(buffer::add);
 207             }
 208         }
 209
 210         for (final Mutable<?, ?, ?> original : effective) {
 211             if (shouldCopy(original)) {
 212                 original.copyAsChildOf(targetCtx, CopyType.ADDED_BY_USES, newQNameModule).ifPresent(buffer::add);
 213             }
 214         }
 215
 216         targetCtx.addEffectiveSubstatements(buffer);
 217         usesNode.addAsEffectOfStatement(buffer);
 218     }
 219
 220     private static boolean shouldCopy(final StmtContext<?, ?, ?> stmt) {
 221         // https://tools.ietf.org/html/rfc7950#section-7.13:
 222         //
 223         //        The effect of a "uses" reference to a grouping is that the nodes
 224         //        defined by the grouping are copied into the current schema tree and
 225         //        are then updated according to the "refine" and "augment" statements.
 226         //
 227         // This means that the statement that is about to be copied (and can be subjected to buildEffective() I think)
 228         // is actually a SchemaTreeEffectiveStatement
 229         if (SchemaTreeEffectiveStatement.class.isAssignableFrom(
 230                 stmt.publicDefinition().getEffectiveRepresentationClass())) {
 231             return true;
 232         }
 233
 234         // As per https://tools.ietf.org/html/rfc7950#section-7.13.2:
 235         //
 236         //        o  Any node can get refined extensions, if the extension allows
 237         //           refinement.  See Section 7.19 for details.
 238         //
 239         // and https://tools.ietf.org/html/rfc7950#section-7.19:
 240         //
 241         //        An extension can allow refinement (see Section 7.13.2) and deviations
 242         //        (Section 7.20.3.2), but the mechanism for how this is defined is
 243         //        outside the scope of this specification.
 244         //
 245         // This is actively used out there (tailf-common.yang's tailf:action), which is incorrect, though. They do
 246         // publish a bunch of metadata (through tailf-meta-extension.yang), but fail to publish a key aspect of the
 247         // statement: it attaches to schema tree namespace (just as RFC7950 action does). Such an extension would
 248         // automatically result in the extension being picked up by the above check and everybody would live happily
 249         // ever after.
 250         //
 251         // We do not live in that world yet, hence we do the following and keep our fingers crossed.
 252         // FIXME: YANGTOOLS-403: this should not be necessary once we implement the above (although tests will complain)
 253         return StmtContextUtils.isUnknownStatement(stmt);
 254     }
 255
 256     private static QNameModule getNewQNameModule(final StmtContext<?, ?, ?> targetCtx,
 257             final StmtContext<?, ?, ?> stmtContext) {
 258         if (targetCtx.getParentContext() == null) {
 259             return targetCtx.getFromNamespace(ModuleCtxToModuleQName.class, targetCtx);
 260         }
 261         if (targetCtx.publicDefinition() == YangStmtMapping.AUGMENT) {
 262             return StmtContextUtils.getRootModuleQName(targetCtx);
 263         }
 264
 265         final Object targetStmtArgument = targetCtx.argument();
 266         final Object sourceStmtArgument = stmtContext.argument();
 267         if (targetStmtArgument instanceof QName && sourceStmtArgument instanceof QName) {
 268             return ((QName) targetStmtArgument).getModule();
 269         }
 270
 271         return null;
 272     }
 273
 274     @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
 275             justification = "https://github.com/spotbugs/spotbugs/issues/811")
 276     private static void resolveUsesNode(final Mutable<QName, UsesStatement, UsesEffectiveStatement> usesNode,
 277             final StmtContext<?, ?, ?> targetNodeStmtCtx) {
 278         for (final Mutable<?, ?, ?> subStmtCtx : usesNode.mutableDeclaredSubstatements()) {
 279             if (subStmtCtx.producesDeclared(RefineStatement.class) && areFeaturesSupported(subStmtCtx)) {
 280                 performRefine(subStmtCtx, targetNodeStmtCtx);
 281             }
 282         }
 283     }
 284
 285     private static boolean areFeaturesSupported(final StmtContext<?, ?, ?> subStmtCtx) {
 286         /*
 287          * In case of Yang 1.1, checks whether features are supported.
 288          */
 289         return !YangVersion.VERSION_1_1.equals(subStmtCtx.yangVersion()) || subStmtCtx.isSupportedByFeatures();
 290     }
 291
 292     private static void performRefine(final Mutable<?, ?, ?> subStmtCtx, final StmtContext<?, ?, ?> usesParentCtx) {
 293         final Object refineArgument = subStmtCtx.argument();
 294         InferenceException.throwIf(!(refineArgument instanceof SchemaNodeIdentifier), subStmtCtx,
 295             "Invalid refine argument %s. It must be instance of SchemaNodeIdentifier.", refineArgument);
 296
 297         final Optional<StmtContext<?, ?, ?>> optRefineTargetCtx = SchemaTreeNamespace.findNode(
 298             usesParentCtx, (SchemaNodeIdentifier) refineArgument);
 299         InferenceException.throwIf(!optRefineTargetCtx.isPresent(), subStmtCtx, "Refine target node %s not found.",
 300             refineArgument);
 301
 302         // FIXME: This communicates the looked-up target node to RefineStatementSupport.buildEffective(). We should do
 303         //        this trick through a shared namespace or similar reactor-agnostic meeting place. It really feels like
 304         //        an inference action RefineStatementSupport should be doing.
 305         final StmtContext<?, ?, ?> refineTargetNodeCtx = optRefineTargetCtx.get();
 306         if (StmtContextUtils.isUnknownStatement(refineTargetNodeCtx)) {
 307             LOG.trace("Refine node '{}' in uses '{}' has target node unknown statement '{}'. "
 308                 + "Refine has been skipped. At line: {}", subStmtCtx.argument(),
 309                 subStmtCtx.coerceParentContext().argument(), refineTargetNodeCtx.argument(),
 310                 subStmtCtx.sourceReference());
 311         } else {
 312             verify(refineTargetNodeCtx instanceof StatementContextBase);
 313             addOrReplaceNodes(subStmtCtx, (StatementContextBase<?, ?, ?>) refineTargetNodeCtx);
 314         }
 315
 316         // Target is a prerequisite for the 'refine', hence if the target is not supported, the refine is not supported
 317         // as well. Otherwise add a pointer to the target into refine's local namespace.
 318         if (refineTargetNodeCtx.isSupportedToBuildEffective()) {
 319             subStmtCtx.addToNs(RefineTargetNamespace.class, Empty.getInstance(), refineTargetNodeCtx);
 320         } else {
 321             subStmtCtx.setIsSupportedToBuildEffective(false);
 322         }
 323     }
 324
 325     private static void addOrReplaceNodes(final Mutable<?, ?, ?> subStmtCtx,
 326             final StatementContextBase<?, ?, ?> refineTargetNodeCtx) {
 327         for (final Mutable<?, ?, ?> refineSubstatementCtx : subStmtCtx.mutableDeclaredSubstatements()) {
 328             if (isSupportedRefineSubstatement(refineSubstatementCtx)) {
 329                 addOrReplaceNode(refineSubstatementCtx, refineTargetNodeCtx);
 330             }
 331         }
 332     }
 333
 334     private static void addOrReplaceNode(final Mutable<?, ?, ?> refineSubstatementCtx,
 335             final StatementContextBase<?, ?, ?> refineTargetNodeCtx) {
 336
 337         final StatementDefinition refineSubstatementDef = refineSubstatementCtx.publicDefinition();
 338
 339         SourceException.throwIf(!isSupportedRefineTarget(refineSubstatementCtx, refineTargetNodeCtx),
 340                 refineSubstatementCtx,
 341                 "Error in module '%s' in the refine of uses '%s': can not perform refine of '%s' for the target '%s'.",
 342                 refineSubstatementCtx.getRoot().rawArgument(), refineSubstatementCtx.coerceParentContext().argument(),
 343                 refineSubstatementCtx.publicDefinition(), refineTargetNodeCtx.publicDefinition());
 344
 345         if (!isAllowedToAddByRefine(refineSubstatementDef)) {
 346             refineTargetNodeCtx.removeStatementFromEffectiveSubstatements(refineSubstatementDef);
 347         }
 348         refineTargetNodeCtx.addEffectiveSubstatement(refineSubstatementCtx.replicaAsChildOf(refineTargetNodeCtx));
 349     }
 350
 351     // FIXME: clarify this and inline into single caller
 352     private static boolean isAllowedToAddByRefine(final StatementDefinition publicDefinition) {
 353         return YangStmtMapping.MUST.equals(publicDefinition);
 354     }
 355
 356     private static boolean isSupportedRefineSubstatement(final StmtContext<?, ?, ?> refineSubstatementCtx) {
 357         final Collection<?> supportedRefineSubstatements = refineSubstatementCtx.getFromNamespace(
 358                 ValidationBundlesNamespace.class, ValidationBundleType.SUPPORTED_REFINE_SUBSTATEMENTS);
 359
 360         return supportedRefineSubstatements == null || supportedRefineSubstatements.isEmpty()
 361                 || supportedRefineSubstatements.contains(refineSubstatementCtx.publicDefinition())
 362                 || StmtContextUtils.isUnknownStatement(refineSubstatementCtx);
 363     }
 364
 365     private static boolean isSupportedRefineTarget(final StmtContext<?, ?, ?> refineSubstatementCtx,
 366             final StmtContext<?, ?, ?> refineTargetNodeCtx) {
 367         final Collection<?> supportedRefineTargets = YangValidationBundles.SUPPORTED_REFINE_TARGETS.get(
 368             refineSubstatementCtx.publicDefinition());
 369
 370         return supportedRefineTargets == null || supportedRefineTargets.isEmpty()
 371                 || supportedRefineTargets.contains(refineTargetNodeCtx.publicDefinition());
 372     }
 373 }